tgui_input_keycombo ![code/modules/tgui/tgui_input/keycombo_input.dm 46](git.png)
Datum used for instantiating and using a TGUI-controlled key input that prompts the user with a message and listens for key presses.
Vars | |
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. |
deletion_timer | The attached timer that handles this objects timeout deletion |
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 |
Procs | |
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. |
Var Details
closed ![code/modules/tgui/tgui_input/keycombo_input.dm 48](git.png)
Boolean field describing if the tgui_input_number was closed by the user.
default ![code/modules/tgui/tgui_input/keycombo_input.dm 50](git.png)
The default (or current) value, shown as a default. Users can press reset with this.
deletion_timer ![code/modules/tgui/tgui_input/keycombo_input.dm 60](git.png)
The attached timer that handles this objects timeout deletion
entry ![code/modules/tgui/tgui_input/keycombo_input.dm 52](git.png)
The entry that the user has return_typed in.
message ![code/modules/tgui/tgui_input/keycombo_input.dm 54](git.png)
The prompt's body, if any, of the TGUI window.
start_time ![code/modules/tgui/tgui_input/keycombo_input.dm 56](git.png)
The time at which the number input was created, for displaying timeout progress.
state ![code/modules/tgui/tgui_input/keycombo_input.dm 66](git.png)
The TGUI UI state that will be returned in ui_state(). Default: always_state
timeout ![code/modules/tgui/tgui_input/keycombo_input.dm 58](git.png)
The lifespan of the number input, after which the window will close and delete itself.
title ![code/modules/tgui/tgui_input/keycombo_input.dm 62](git.png)
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.