Class UI.TextMenu
UI Text Menu class.
To displays text menus.
This class should be ignored. Use Game.TextMenu class instead.
Fields
| UI.TextMenu.rightAlignmentXPos | Right-alignment items's horizontal position. |
| UI.TextMenu.bottomPaddingSize | Bottom padding size for each lines. |
Methods
| UI.TextMenu:IsVisible () | Checks whether current text menu is visible. |
| UI.TextMenu:Draw () | Draws current text menu if permitted. |
| UI.TextMenu:Hide () | Hides current text menu. |
| UI.TextMenu:SelectMenuItem (menu_item) | Selects an item from the menu. |
| UI.TextMenu:Load (KeysBitfield, DisplayTime, NeedMore, str[, drawWhenLoaded=true]) | Loads a text menu config. |
| UI.TextMenu:Close ([dontSendSignal=true[, isTimedOut=false[, isReplaced=false]]]) | Close the text menu. |
Fields
- UI.TextMenu.rightAlignmentXPos
-
Right-alignment items's horizontal position.
To avoids blocking player's crosshairs.
- rightAlignmentXPos. number (default 300)
- UI.TextMenu.bottomPaddingSize
-
Bottom padding size for each lines.
- bottomPaddingSize number (default 2)
Methods
- UI.TextMenu:IsVisible ()
-
Checks whether current text menu is visible.
Returns:
-
bool
Returns true if visible.
- UI.TextMenu:Draw ()
-
Draws current text menu if permitted.
Returns:
-
self
This class.
- UI.TextMenu:Hide ()
-
Hides current text menu.
Returns:
-
self
This class.
- UI.TextMenu:SelectMenuItem (menu_item)
-
Selects an item from the menu.
Parameters:
- menu_item number The selected menu item slot.
Returns:
-
self
This class.
See also:
- UI.TextMenu:Load (KeysBitfield, DisplayTime, NeedMore, str[, drawWhenLoaded=true])
-
Loads a text menu config.
Used for ShowMenu network message parser.
Parameters:
- KeysBitfield short a bitfield of keys that are valid input.
- DisplayTime char the duration, in seconds, the menu should stay up. -1 means is stays until something is chosen.
- NeedMore byte a boolean, TRUE if there is more string yet to be received before displaying the menu, FALSE if it's the last string.
- str string menu string to display.
- drawWhenLoaded bool Draws the menu after fully loaded succesfully. (default true)
Returns:
-
self
This class.
- UI.TextMenu:Close ([dontSendSignal=true[, isTimedOut=false[, isReplaced=false]]])
-
Close the text menu.
Parameters:
- dontSendSignal bool Don't send special EXIT signals. Overriden other signal parameters. (default true)
- isTimedOut bool Menu display time is expired. (default false)
- isReplaced bool Menu is replaced with another incoming menu. (default false)
Returns:
-
self
This class.