tgui_list_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 | |
buttons | The list of buttons (responses) provided on the TGUI window |
---|---|
buttons_map | Buttons (strings specifically) mapped to the actual value (e.g. a mob or a verb) |
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. |
message | The textual body of the TGUI window |
start_time | The time at which the tgui_list_input was created, for displaying timeout progress. |
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
buttons

The list of buttons (responses) provided on the TGUI window
buttons_map

Buttons (strings specifically) mapped to the actual value (e.g. a mob or a verb)
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.
message

The textual body of the TGUI window
start_time

The time at which the tgui_list_input was created, for displaying timeout progress.
timeout

The lifespan of the tgui_list_input, after which the window will close and delete itself.
title

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.