tgui_modal
Datum used for instantiating and using a TGUI-controlled modal that prompts the user with a message and has items for responses.
Vars | |
autofocus | The bool that controls if this modal should grab window focus |
---|---|
choice | The button that the user has pressed, null if no selection has been made |
closed | Boolean field describing if the tgui_modal was closed by the user. |
content_window | The name of the part to be used for the alert's content, to be used in lieu of message |
items | The list of items (responses) provided on the TGUI window |
message | The textual body of the TGUI window |
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_modal, after which the window will close and delete itself. |
title | The title of the TGUI window |
user | The user of the TGUI window |
Procs | |
wait | Waits for a user's response to the tgui_alert's prompt before returning. Returns early if the window was closed by the user. |
Var Details
autofocus
The bool that controls if this modal should grab window focus
choice
The button that the user has pressed, null if no selection has been made
closed
Boolean field describing if the tgui_modal was closed by the user.
content_window
The name of the part to be used for the alert's content, to be used in lieu of message
items
The list of items (responses) provided on the TGUI window
message
The textual body of the TGUI window
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_modal, 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
wait
Waits for a user's response to the tgui_alert's prompt before returning. Returns early if the window was closed by the user.