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
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 item to be selected
items	The list of items (responses) provided on the TGUI window
items_map	Items (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
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

var
choice
–

The button that the user has pressed, null if no selection has been made

var
closed
–

Boolean field describing if the tgui_list_input was closed by the user.

var
default
–

The default item to be selected

var
items
– /list

The list of items (responses) provided on the TGUI window

var
items_map
– /list

Items (strings specifically) mapped to the actual value (e.g. a mob or a verb)

var
message
–

The textual body of the TGUI window

var
start_time
–

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

var
timeout
–

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

var
title
–

The title of the TGUI window

Proc Details

proc
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.

tgui_list_input /datum/tgui_list_input

Vars

Procs

Var Details

var choice –

var closed –

var default –

var items – /list

var items_map – /list

var message –

var start_time –

var timeout –

var title –