Goonstation 13 - Modules - TypesVar Details - Proc Details

tgui_input_text

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

Vars

allowEmptyMakes the text box allow an empty string to be submitted
closedBoolean field describing if the tgui_input_text was closed by the user.
defaultThe default (or current) value, shown as a default.
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 tgui_modal was created, for displaying timeout progress.
themeThe TGUI theme used for the window
timeoutThe lifespan of the tgui_input_text, after which the window will close and delete itself.
titleThe title of the TGUI window
userThe user of the TGUI window

Procs

ui_dataYou cannot use default as a const
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

allowEmpty

Makes the text box allow an empty string to be submitted

closed

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

default

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

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 tgui_modal was created, for displaying timeout progress.

theme

The TGUI theme used for the window

timeout

The lifespan of the tgui_input_text, after which the window will close and delete itself.

title

The title of the TGUI window

user

The user of the TGUI window

Proc Details

ui_data

You cannot use default as a const

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.