/tg/ Station 13 - Modules - TypesVar Details - Proc Details

tgui_list_input

Client does NOT have tgui_input on: Returns regular input

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

choiceThe button that the user has pressed, null if no selection has been made
closedBoolean field describing if the tgui_list_input was closed by the user.
defaultThe default button to be selected
itemsThe list of items (responses) provided on the TGUI window
items_mapButtons (strings specifically) mapped to the actual value (e.g. a mob or a verb)
messageThe textual body of the TGUI window
start_timeThe time at which the tgui_list_input was created, for displaying timeout progress.
timeoutThe lifespan of the tgui_list_input, after which the window will close and delete itself.
titleThe title of the TGUI window

Procs

waitWaits 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

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

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.

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.