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. |
timeout | The lifespan of the text 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_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.
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.
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
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.