tgui_input_number
![code/modules/tgui_input/number.dm 48](git.png)
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. |
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. |
round_value | Whether the submitted number is rounded down into an integer. |
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
![code/modules/tgui_input/number.dm 50](git.png)
Boolean field describing if the tgui_input_number was closed by the user.
default
![code/modules/tgui_input/number.dm 52](git.png)
The default (or current) value, shown as a default. Users can press reset with this.
entry
![code/modules/tgui_input/number.dm 54](git.png)
The entry that the user has return_typed in.
max_value
![code/modules/tgui_input/number.dm 56](git.png)
The maximum value that can be entered.
message
![code/modules/tgui_input/number.dm 58](git.png)
The prompt's body, if any, of the TGUI window.
min_value
![code/modules/tgui_input/number.dm 60](git.png)
The minimum value that can be entered.
round_value
![code/modules/tgui_input/number.dm 62](git.png)
Whether the submitted number is rounded down into an integer.
start_time
![code/modules/tgui_input/number.dm 64](git.png)
The time at which the number input was created, for displaying timeout progress.
state
![code/modules/tgui_input/number.dm 72](git.png)
The TGUI UI state that will be returned in ui_state(). Default: always_state
timeout
![code/modules/tgui_input/number.dm 66](git.png)
The lifespan of the number input, after which the window will close and delete itself.
title
![code/modules/tgui_input/number.dm 68](git.png)
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.