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

var
closed
–

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

var
default
–

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

var
entry
–

The entry that the user has return_typed in.

var
max_value
–

The maximum value that can be entered.

var
message
–

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

var
min_value
–

The minimum value that can be entered.

var
round_value
–

Whether the submitted number is rounded down into an integer.

var
start_time
–

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

var
state
– /datum/ui_state

The TGUI UI state that will be returned in ui_state(). Default: always_state

var
timeout
–

The lifespan of the number 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_input_number's prompt before returning. Returns early if the window was closed by the user.

tgui_input_number /datum/tgui_input_number

Vars

Procs

Var Details

var closed –

var default –

var entry –

var max_value –

var message –

var min_value –

var round_value –

var start_time –

var state – /datum/ui_state

var timeout –

var title –