tgui_modal
Datum used for instantiating and using a TGUI-controlled modal that prompts the user with a message and has buttons for responses.
Vars | |
autofocus | The bool that controls if this modal should grab window focus |
---|---|
buttons | The list of buttons (responses) provided on the TGUI window |
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. |
message | The textual body of the TGUI window |
start_time | The time at which the tgui_modal was created, for displaying timeout progress. |
timeout | The lifespan of the tgui_modal, 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_modal'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
buttons
The list of buttons (responses) provided on the TGUI window
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.
message
The textual body of the TGUI window
start_time
The time at which the tgui_modal was created, for displaying timeout progress.
timeout
The lifespan of the tgui_modal, 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_modal's prompt before returning. Returns early if the window was closed by the user.