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_input_keycombo.html
T

4 lines
7.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_input_keycombo - 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_input_keycombo.html#var">Var Details</a> - <a href="datum/tgui_input_keycombo.html#proc">Proc Details</a></header><main><h1>tgui_input_keycombo <aside>/<a href="datum.html">datum</a>/<a href="datum/tgui_input_keycombo.html">tgui_input_keycombo</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/keycombo_input.dm#L46"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/keycombo_input.dm 46"></a></h1><p>Datum used for instantiating and using a TGUI-controlled key input that prompts the user with
a message and listens for key presses.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/tgui_input_keycombo.html#var/closed">closed</a></th><td>Boolean field describing if the tgui_input_number was closed by the user.</td></tr><tr><th><a href="datum/tgui_input_keycombo.html#var/default">default</a></th><td>The default (or current) value, shown as a default. Users can press reset with this.</td></tr><tr><th><a href="datum/tgui_input_keycombo.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_input_keycombo.html#var/entry">entry</a></th><td>The entry that the user has return_typed in.</td></tr><tr><th><a href="datum/tgui_input_keycombo.html#var/message">message</a></th><td>The prompt's body, if any, of the TGUI window.</td></tr><tr><th><a href="datum/tgui_input_keycombo.html#var/start_time">start_time</a></th><td>The time at which the number input was created, for displaying timeout progress.</td></tr><tr><th><a href="datum/tgui_input_keycombo.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_input_keycombo.html#var/timeout">timeout</a></th><td>The lifespan of the number input, after which the window will close and delete itself.</td></tr><tr><th><a href="datum/tgui_input_keycombo.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_input_keycombo.html#proc/wait">wait</a></th><td>Waits for a user's response to the tgui_input_keycombo'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/closed"><aside class="declaration">var </aside>closed <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/keycombo_input.dm#L48"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/keycombo_input.dm 48"></a></h3><p>Boolean field describing if the tgui_input_number 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/keycombo_input.dm#L50"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/keycombo_input.dm 50"></a></h3><p>The default (or current) value, shown as a default. Users can press reset with this.</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/keycombo_input.dm#L60"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/keycombo_input.dm 60"></a></h3><p>The attached timer that handles this objects timeout deletion</p><h3 id="var/entry"><aside class="declaration">var </aside>entry <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/keycombo_input.dm#L52"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/keycombo_input.dm 52"></a></h3><p>The entry that the user has return_typed in.</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/keycombo_input.dm#L54"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/keycombo_input.dm 54"></a></h3><p>The prompt's body, if any, of the TGUI window.</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/keycombo_input.dm#L56"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/keycombo_input.dm 56"></a></h3><p>The time at which the number 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/keycombo_input.dm#L64"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/keycombo_input.dm 64"></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/keycombo_input.dm#L58"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/keycombo_input.dm 58"></a></h3><p>The lifespan of the number 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/keycombo_input.dm#L62"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/keycombo_input.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/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/keycombo_input.dm#L87"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/keycombo_input.dm 87"></a></aside></h3><p>Waits for a user's response to the tgui_input_keycombo'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