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
closed	Boolean field describing if the tgui_input_text was closed by the user.
default	The default (or current) value, shown as a default.
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
Procs
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.

Var Details

var
closed

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

var
default

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

var
encode

Whether the input should be stripped using html_encode

var
entry

The entry that the user has return_typed in.

var
max_length

The maximum length for text entry

var
message

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

var
multiline

Multiline input for larger input boxes.

var
start_time

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

var
title

The title of the TGUI window

Proc Details

proc
set_entry
(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.

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

tgui_input_text /datum/tgui_input_text

Vars

Procs

Var Details

var closed

var default

var encode

var entry

var max_length

var message

var multiline

var start_time

var state – /datum/ui_state

var timeout

var title