iguielement
Contents
| Name | Description |
|---|---|
| focus( ) | Focuses a gui element. |
| getabsclippingrect( ) | Find the rectangle that an element occupies that is visible to the user |
| getabsrect( ) | Find the rectangle that an element occupies |
| getrelrect( ) | Find the relative rectangle that this element occupies |
| gettext( ) | no short description provided |
| move( position ) | Move an element (by an offset) from it's current position |
| onHover( ) | (Callback)Called when an @{iguielement is hovered over with the mouse. |
| remove( ) | Removes a gui element, and any child elements |
| settext( text ) | Sets the text of the element |
| setvisible( visible ) | Set the visibility of this element |
focus( )
Focuses a gui element.
Will cause a ELEMENTFOCUSLOST followed by an ELEMENT_FOCUSED event. If either events are trapped/returned from, then the focus will not change.
Defined at client/lua_api/gui/iguielement.cpp:208
getabsclippingrect( )
Find the rectangle that an element occupies that is visible to the user
Returns
-
The rectangle that this element occupies that is visible to the user
Defined at client/lua_api/gui/iguielement.cpp:96
getabsrect( )
Find the rectangle that an element occupies
Returns
-
The rectangle that this element occupies
Defined at client/lua_api/gui/iguielement.cpp:74
getrelrect( )
Find the relative rectangle that this element occupies
Returns
-
The rectangle that this element occupies relative to it's parent
Defined at client/lua_api/gui/iguielement.cpp:117
gettext( )
no short description provided
Returns
-
The caption text of the element. For input element like
Defined at client/lua_api/gui/iguielement.cpp:174
move( vector2d position )
Move an element (by an offset) from it's current position
Parameters
-
position (vector2d)
The offset to move this element by
Defined at client/lua_api/gui/iguielement.cpp:35
onHover( )
(Callback)Called when an @{iguielement is hovered over with the mouse.
If an element has child elements, you also get this call for each child element.
Defined at client/callbackhandeler.cpp:106
remove( )
Removes a gui element, and any child elements
Defined at client/lua_api/gui/iguielement.cpp:193
settext( string text )
Sets the text of the element
This function may do different things to different gui elements. For example, on a window, it sets the title. On a button, it sets the button's text.
Parameters
-
text (string)
The text to set on the element
Defined at client/lua_api/gui/iguielement.cpp:140
setvisible( boolean visible )
Set the visibility of this element
Parameters
-
visible (boolean)
Should this element be visible?
Defined at client/lua_api/gui/iguielement.cpp:56