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

tgui_input_keycombo

Datum used for instantiating and using a TGUI-controlled key input that prompts the user with a message and listens for key presses.

Vars

closedBoolean field describing if the tgui_input_number was closed by the user.
defaultThe default (or current) value, shown as a default. Users can press reset with this.
entryThe entry that the user has return_typed in.
messageThe prompt's body, if any, of the TGUI window.
start_timeThe time at which the number input was created, for displaying timeout progress.
stateThe TGUI UI state that will be returned in ui_state(). Default: always_state
timeoutThe lifespan of the number 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_input_keycombo's prompt before returning. Returns early if the window was closed by the user.

Var Details

closed

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

default

The default (or current) value, shown as a default. Users can press reset with this.

entry

The entry that the user has return_typed in.

message

The prompt's body, if any, of the TGUI window.

start_time

The time at which the number 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 number 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_input_keycombo's prompt before returning. Returns early if the window was closed by the user.