tgui_alert ![code/modules/tgui_input/alert.dm 49](git.png)
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_alert was closed by the user. |
message | The textual body of the TGUI window |
start_time | The time at which the tgui_alert 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 tgui_alert, 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_alert's prompt before returning. Returns early if the window was closed by the user. |
Var Details
autofocus ![code/modules/tgui_input/alert.dm 63](git.png)
The bool that controls if this modal should grab window focus
buttons ![code/modules/tgui_input/alert.dm 55](git.png)
The list of buttons (responses) provided on the TGUI window
choice ![code/modules/tgui_input/alert.dm 57](git.png)
The button that the user has pressed, null if no selection has been made
closed ![code/modules/tgui_input/alert.dm 65](git.png)
Boolean field describing if the tgui_alert was closed by the user.
message ![code/modules/tgui_input/alert.dm 53](git.png)
The textual body of the TGUI window
start_time ![code/modules/tgui_input/alert.dm 59](git.png)
The time at which the tgui_alert was created, for displaying timeout progress.
state ![code/modules/tgui_input/alert.dm 69](git.png)
The TGUI UI state that will be returned in ui_state(). Default: always_state
timeout ![code/modules/tgui_input/alert.dm 61](git.png)
The lifespan of the tgui_alert, after which the window will close and delete itself.
title ![code/modules/tgui_input/alert.dm 51](git.png)
The title 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.