shikix/GS13NG
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
gh-pages
GS13NG/datum/tgui_modal.html
T
sheepishgoat 705fd9528e Deploying to gh-pages from @ e8e0068531 🚀
2025-02-05 06:19:18 +00:00

4 lines
6.1 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/tgui_modal - /tg/ Station 13</title></head><body><header><a href="index.html">/tg/ Station 13</a> - <a href="index.html#modules">Modules</a> - <a href="index.html#types">Types</a> — <a href="datum/tgui_modal.html#var">Var Details</a> - <a href="datum/tgui_modal.html#proc">Proc Details</a></header><main><h1>tgui_modal <aside>/<a href="datum.html">datum</a>/<a href="datum/tgui_modal.html">tgui_modal</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui/tgui_alert.dm#L60"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_alert.dm 60"></a></h1><p>Datum used for instantiating and using a TGUI-controlled modal that prompts the user with
a message and has buttons for responses.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/tgui_modal.html#var/autofocus">autofocus</a></th><td>The bool that controls if this modal should grab window focus</td></tr><tr><th><a href="datum/tgui_modal.html#var/buttons">buttons</a></th><td>The list of buttons (responses) provided on the TGUI window</td></tr><tr><th><a href="datum/tgui_modal.html#var/choice">choice</a></th><td>The button that the user has pressed, null if no selection has been made</td></tr><tr><th><a href="datum/tgui_modal.html#var/closed">closed</a></th><td>Boolean field describing if the tgui_modal was closed by the user.</td></tr><tr><th><a href="datum/tgui_modal.html#var/message">message</a></th><td>The textual body of the TGUI window</td></tr><tr><th><a href="datum/tgui_modal.html#var/start_time">start_time</a></th><td>The time at which the tgui_modal was created, for displaying timeout progress.</td></tr><tr><th><a href="datum/tgui_modal.html#var/timeout">timeout</a></th><td>The lifespan of the tgui_modal, after which the window will close and delete itself.</td></tr><tr><th><a href="datum/tgui_modal.html#var/title">title</a></th><td>The title of the TGUI window</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/tgui_modal.html#proc/wait">wait</a></th><td>Waits for a user's response to the tgui_modal's prompt before returning. Returns early if
the window was closed by the user.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/autofocus"><aside class="declaration">var </aside>autofocus <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui/tgui_alert.dm#L74"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_alert.dm 74"></a></h3><p>The bool that controls if this modal should grab window focus</p><h3 id="var/buttons"><aside class="declaration">var </aside>buttons <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui/tgui_alert.dm#L66"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_alert.dm 66"></a></h3><p>The list of buttons (responses) provided on the TGUI window</p><h3 id="var/choice"><aside class="declaration">var </aside>choice <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui/tgui_alert.dm#L68"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_alert.dm 68"></a></h3><p>The button that the user has pressed, null if no selection has been made</p><h3 id="var/closed"><aside class="declaration">var </aside>closed <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui/tgui_alert.dm#L78"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_alert.dm 78"></a></h3><p>Boolean field describing if the tgui_modal was closed by the user.</p><h3 id="var/message"><aside class="declaration">var </aside>message <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui/tgui_alert.dm#L64"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_alert.dm 64"></a></h3><p>The textual body of the TGUI window</p><h3 id="var/start_time"><aside class="declaration">var </aside>start_time <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui/tgui_alert.dm#L70"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_alert.dm 70"></a></h3><p>The time at which the tgui_modal was created, for displaying timeout progress.</p><h3 id="var/timeout"><aside class="declaration">var </aside>timeout <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui/tgui_alert.dm#L72"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_alert.dm 72"></a></h3><p>The lifespan of the tgui_modal, after which the window will close and delete itself.</p><h3 id="var/title"><aside class="declaration">var </aside>title <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui/tgui_alert.dm#L62"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_alert.dm 62"></a></h3><p>The title of the TGUI window</p><h2 id="proc">Proc Details</h2><h3 id="proc/wait"><aside class="declaration">proc </aside>wait<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui/tgui_alert.dm#L97"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_alert.dm 97"></a></aside></h3><p>Waits for a user's response to the tgui_modal's prompt before returning. Returns early if
the window was closed by the user.</p></main><footer>tgstation.dme <a href="https://github.com/evilew/GS13-Citadel/tree/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e">e8e0068</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.9.0</a></footer></body></html>
Reference in New Issue View Git Blame Copy Permalink