4 lines
6.3 KiB
HTML
4 lines
6.3 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/tgui_list_input - /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_list_input.html#var">Var Details</a> - <a href="datum/tgui_list_input.html#proc">Proc Details</a></header><main><h1>tgui_list_input <aside>/<a href="datum.html">datum</a>/<a href="datum/tgui_list_input.html">tgui_list_input</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui/tgui_input_list.dm#L62"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input_list.dm 62"></a></h1><p>Datum used for instantiating and using a TGUI-controlled list input that prompts the user with
|
||
a message and shows a list of selectable options</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/tgui_list_input.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_list_input.html#var/buttons_map">buttons_map</a></th><td>Buttons (strings specifically) mapped to the actual value (e.g. a mob or a verb)</td></tr><tr><th><a href="datum/tgui_list_input.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_list_input.html#var/closed">closed</a></th><td>Boolean field describing if the tgui_list_input was closed by the user.</td></tr><tr><th><a href="datum/tgui_list_input.html#var/message">message</a></th><td>The textual body of the TGUI window</td></tr><tr><th><a href="datum/tgui_list_input.html#var/start_time">start_time</a></th><td>The time at which the tgui_list_input was created, for displaying timeout progress.</td></tr><tr><th><a href="datum/tgui_list_input.html#var/timeout">timeout</a></th><td>The lifespan of the tgui_list_input, after which the window will close and delete itself.</td></tr><tr><th><a href="datum/tgui_list_input.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_list_input.html#proc/wait">wait</a></th><td>Waits for a user's response to the tgui_list_input'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/buttons"><aside class="declaration">var </aside>buttons <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui/tgui_input_list.dm#L68"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input_list.dm 68"></a></h3><p>The list of buttons (responses) provided on the TGUI window</p><h3 id="var/buttons_map"><aside class="declaration">var </aside>buttons_map <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui/tgui_input_list.dm#L70"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input_list.dm 70"></a></h3><p>Buttons (strings specifically) mapped to the actual value (e.g. a mob or a verb)</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_input_list.dm#L72"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input_list.dm 72"></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_input_list.dm#L80"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input_list.dm 80"></a></h3><p>Boolean field describing if the tgui_list_input 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_input_list.dm#L66"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input_list.dm 66"></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_input_list.dm#L74"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input_list.dm 74"></a></h3><p>The time at which the tgui_list_input 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_input_list.dm#L76"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input_list.dm 76"></a></h3><p>The lifespan of the tgui_list_input, 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_input_list.dm#L64"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input_list.dm 64"></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_input_list.dm#L114"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input_list.dm 114"></a></aside></h3><p>Waits for a user's response to the tgui_list_input'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> |