tgui_list_input
![code/modules/tgui_input/list.dm 47](git.png)
Client does NOT have tgui_input on: Returns regular input
Datum used for instantiating and using a TGUI-controlled list input that prompts the user with a message and shows a list of selectable options
Vars | |
choice | The button that the user has pressed, null if no selection has been made |
---|---|
closed | Boolean field describing if the tgui_list_input was closed by the user. |
default | The default button to be selected |
invalid | Whether the tgui list input is invalid or not (i.e. due to all list entries being null) |
items | The list of items (responses) provided on the TGUI window |
items_map | Buttons (strings specifically) mapped to the actual value (e.g. a mob or a verb) |
message | The textual body of the TGUI window |
start_time | The time at which the tgui_list_input was created, for displaying timeout progress. |
state | The TGUI UI state that will be returned in ui_state(). Default: always_state |
timeout | The lifespan of the tgui_list_input, after which the window will close and delete itself. |
title | The title of the TGUI window |
Procs | |
wait | Waits for a user's response to the tgui_list_input's prompt before returning. Returns early if the window was closed by the user. |
Var Details
choice
![code/modules/tgui_input/list.dm 57](git.png)
The button that the user has pressed, null if no selection has been made
closed
![code/modules/tgui_input/list.dm 65](git.png)
Boolean field describing if the tgui_list_input was closed by the user.
default
![code/modules/tgui_input/list.dm 59](git.png)
The default button to be selected
invalid
![code/modules/tgui_input/list.dm 69](git.png)
Whether the tgui list input is invalid or not (i.e. due to all list entries being null)
items
![code/modules/tgui_input/list.dm 53](git.png)
The list of items (responses) provided on the TGUI window
items_map
![code/modules/tgui_input/list.dm 55](git.png)
Buttons (strings specifically) mapped to the actual value (e.g. a mob or a verb)
message
![code/modules/tgui_input/list.dm 51](git.png)
The textual body of the TGUI window
start_time
![code/modules/tgui_input/list.dm 61](git.png)
The time at which the tgui_list_input was created, for displaying timeout progress.
state
![code/modules/tgui_input/list.dm 67](git.png)
The TGUI UI state that will be returned in ui_state(). Default: always_state
timeout
![code/modules/tgui_input/list.dm 63](git.png)
The lifespan of the tgui_list_input, after which the window will close and delete itself.
title
![code/modules/tgui_input/list.dm 49](git.png)
The title of the TGUI window
Proc Details
wait
Waits for a user's response to the tgui_list_input's prompt before returning. Returns early if the window was closed by the user.