tgui_modal
![code/modules/tgui/tgui_alert.dm 58](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 | |
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
buttons
![code/modules/tgui/tgui_alert.dm 64](git.png)
The list of buttons (responses) provided on the TGUI window
choice
![code/modules/tgui/tgui_alert.dm 66](git.png)
The button that the user has pressed, null if no selection has been made
closed
![code/modules/tgui/tgui_alert.dm 74](git.png)
Boolean field describing if the tgui_modal was closed by the user.
message
![code/modules/tgui/tgui_alert.dm 62](git.png)
The textual body of the TGUI window
start_time
![code/modules/tgui/tgui_alert.dm 68](git.png)
The time at which the tgui_modal was created, for displaying timeout progress.
timeout
![code/modules/tgui/tgui_alert.dm 70](git.png)
The lifespan of the tgui_modal, after which the window will close and delete itself.
title
![code/modules/tgui/tgui_alert.dm 60](git.png)
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.