cyberpresidentvanellope/Paradise
1
0
Fork 0
mirror of https://github.com/ParadiseSS13/Paradise.git synced 2026-08-26 13:37:58 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
Paradise/datum/tgui_list_input.html
T

4 lines
9.0 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_list_input - Space Station 13</title></head><body><header><a href="index.html">Space 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/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/list_input.dm#L51"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/list_input.dm 51"></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/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/default">default</a></th><td>The default button to be selected</td></tr><tr><th><a href="datum/tgui_list_input.html#var/deletion_timer">deletion_timer</a></th><td>The attached timer that handles this objects timeout deletion</td></tr><tr><th><a href="datum/tgui_list_input.html#var/invalid">invalid</a></th><td>Whether the tgui list input is invalid or not (i.e. due to all list entries being null)</td></tr><tr><th><a href="datum/tgui_list_input.html#var/items">items</a></th><td>The list of items (responses) provided on the TGUI window</td></tr><tr><th><a href="datum/tgui_list_input.html#var/items_map">items_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/message">message</a></th><td>The textual body of the TGUI window</td></tr><tr><th><a href="datum/tgui_list_input.html#var/modal_type">modal_type</a></th><td>The TGUI modal to use for this popup</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/state">state</a></th><td>The TGUI UI state that will be returned in ui_state(). Default: always_state</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/choice"><aside class="declaration">var </aside>choice <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/list_input.dm#L61"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/list_input.dm 61"></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 <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/list_input.dm#L71"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/list_input.dm 71"></a></h3><p>Boolean field describing if the tgui_list_input was closed by the user.</p><h3 id="var/default"><aside class="declaration">var </aside>default <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/list_input.dm#L63"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/list_input.dm 63"></a></h3><p>The default button to be selected</p><h3 id="var/deletion_timer"><aside class="declaration">var </aside>deletion_timer <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/list_input.dm#L69"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/list_input.dm 69"></a></h3><p>The attached timer that handles this objects timeout deletion</p><h3 id="var/invalid"><aside class="declaration">var </aside>invalid <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/list_input.dm#L75"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/list_input.dm 75"></a></h3><p>Whether the tgui list input is invalid or not (i.e. due to all list entries being null)</p><h3 id="var/items"><aside class="declaration">var </aside>items <aside>– /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/list_input.dm#L57"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/list_input.dm 57"></a></h3><p>The list of items (responses) provided on the TGUI window</p><h3 id="var/items_map"><aside class="declaration">var </aside>items_map <aside>– /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/list_input.dm#L59"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/list_input.dm 59"></a></h3><p>Buttons (strings specifically) mapped to the actual value (e.g. a mob or a verb)</p><h3 id="var/message"><aside class="declaration">var </aside>message <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/list_input.dm#L55"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/list_input.dm 55"></a></h3><p>The textual body of the TGUI window</p><h3 id="var/modal_type"><aside class="declaration">var </aside>modal_type <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/list_input.dm#L77"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/list_input.dm 77"></a></h3><p>The TGUI modal to use for this popup</p><h3 id="var/start_time"><aside class="declaration">var </aside>start_time <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/list_input.dm#L65"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/list_input.dm 65"></a></h3><p>The time at which the tgui_list_input was created, for displaying timeout progress.</p><h3 id="var/state"><aside class="declaration">var </aside>state <aside>– /<a href="datum.html">datum</a>/<a href="datum/ui_state.html">ui_state</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/list_input.dm#L73"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/list_input.dm 73"></a></h3><p>The TGUI UI state that will be returned in ui_state(). Default: always_state</p><h3 id="var/timeout"><aside class="declaration">var </aside>timeout <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/list_input.dm#L67"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/list_input.dm 67"></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 <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/list_input.dm#L53"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/list_input.dm 53"></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/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/list_input.dm#L107"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/list_input.dm 107"></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>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/8a8a00a2a9bec485351e5f219982b7315d3504fa">8a8a00a</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html>
Reference in New Issue View Git Blame Copy Permalink