tgui_input_number

Datum used for instantiating and using a TGUI-controlled number input that prompts the user with a message and has an input for number entry.
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. |
entry | The entry that the user has return_typed in. |
integer_only | If the final value will be rounded |
max_value | The maximum value that can be entered. |
message | The prompt's body, if any, of the TGUI window. |
min_value | The minimum value that can be entered. |
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 | |
Destroy | Checks for empty numbers - bank accounts, etc. Sanity check |
wait | Waits for a user's response to the tgui_input_number'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.
integer_only

If the final value will be rounded
max_value

The maximum value that can be entered.
message

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

The minimum value that can be entered.
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
Destroy
Checks for empty numbers - bank accounts, etc. Sanity check
wait
Waits for a user's response to the tgui_input_number's prompt before returning. Returns early if the window was closed by the user.