Space Station 13 - Modules - TypesVar Details - Proc Details

tgui_input_text

tgui_input_text

Datum used for instantiating and using a TGUI-controlled text input that prompts the user with a message and has an input for text entry.

Vars

closedBoolean field describing if the tgui_input_text was closed by the user.
defaultThe default (or current) value, shown as a default.
deletion_timerThe attached timer that handles this objects timeout deletion
encodeWhether the input should be stripped using html_encode
entryThe entry that the user has return_typed in.
max_lengthThe maximum length for text entry
messageThe prompt's body, if any, of the TGUI window.
multilineMultiline input for larger input boxes.
start_timeThe time at which the text 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 text input, after which the window will close and delete itself.
titleThe title of the TGUI window

Procs

set_entrySets the return value for the tgui text proc. If html encoding is enabled, the text will be encoded. This can sometimes result in a string that is longer than the max length. If the string is longer than the max length, it will be clipped.
waitWaits for a user's response to the tgui_input_text's prompt before returning. Returns early if the window was closed by the user.

Var Details

closed

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

default

The default (or current) value, shown as a default.

deletion_timer

The attached timer that handles this objects timeout deletion

encode

Whether the input should be stripped using html_encode

entry

The entry that the user has return_typed in.

max_length

The maximum length for text entry

message

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

multiline

Multiline input for larger input boxes.

start_time

The time at which the text 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 text input, after which the window will close and delete itself.

title

The title of the TGUI window

Proc Details

set_entry

Sets the return value for the tgui text proc. If html encoding is enabled, the text will be encoded. This can sometimes result in a string that is longer than the max length. If the string is longer than the max length, it will be clipped.

wait

Waits for a user's response to the tgui_input_text's prompt before returning. Returns early if the window was closed by the user.