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

11 lines
9.2 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_text - 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_text.html#var">Var Details</a> - <a href="datum/tgui_input_text.html#proc">Proc Details</a></header><main><h1>tgui_input_text <aside>/<a href="datum.html">datum</a>/<a href="datum/tgui_input_text.html">tgui_input_text</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/text_input.dm#L58"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/text_input.dm 58"></a></h1><p>tgui_input_text</p>
<p>Datum used for instantiating and using a TGUI-controlled text input that prompts the user with
a message and has an input for text entry.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/tgui_input_text.html#var/closed">closed</a></th><td>Boolean field describing if the tgui_input_text was closed by the user.</td></tr><tr><th><a href="datum/tgui_input_text.html#var/default">default</a></th><td>The default (or current) value, shown as a default.</td></tr><tr><th><a href="datum/tgui_input_text.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_text.html#var/encode">encode</a></th><td>Whether the input should be stripped using html_encode</td></tr><tr><th><a href="datum/tgui_input_text.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_text.html#var/max_length">max_length</a></th><td>The maximum length for text entry</td></tr><tr><th><a href="datum/tgui_input_text.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_text.html#var/multiline">multiline</a></th><td>Multiline input for larger input boxes.</td></tr><tr><th><a href="datum/tgui_input_text.html#var/start_time">start_time</a></th><td>The time at which the text input was created, for displaying timeout progress.</td></tr><tr><th><a href="datum/tgui_input_text.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_text.html#var/timeout">timeout</a></th><td>The lifespan of the text input, after which the window will close and delete itself.</td></tr><tr><th><a href="datum/tgui_input_text.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_text.html#proc/set_entry">set_entry</a></th><td>Sets the return value for the tgui text proc.
If html encoding is enabled, the text will be encoded.
This can sometimes result in a string that is longer than the max length.
If the string is longer than the max length, it will be clipped.</td></tr><tr><th><a href="datum/tgui_input_text.html#proc/wait">wait</a></th><td>Waits for a user's response to the tgui_input_text'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/text_input.dm#L60"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/text_input.dm 60"></a></h3><p>Boolean field describing if the tgui_input_text 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/text_input.dm#L62"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/text_input.dm 62"></a></h3><p>The default (or current) value, shown as a default.</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/text_input.dm#L78"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/text_input.dm 78"></a></h3><p>The attached timer that handles this objects timeout deletion</p><h3 id="var/encode"><aside class="declaration">var </aside>encode <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/text_input.dm#L64"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/text_input.dm 64"></a></h3><p>Whether the input should be stripped using html_encode</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/text_input.dm#L66"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/text_input.dm 66"></a></h3><p>The entry that the user has return_typed in.</p><h3 id="var/max_length"><aside class="declaration">var </aside>max_length <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/text_input.dm#L68"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/text_input.dm 68"></a></h3><p>The maximum length for text entry</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/text_input.dm#L70"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/text_input.dm 70"></a></h3><p>The prompt's body, if any, of the TGUI window.</p><h3 id="var/multiline"><aside class="declaration">var </aside>multiline <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/text_input.dm#L72"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/text_input.dm 72"></a></h3><p>Multiline input for larger input boxes.</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/text_input.dm#L74"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/text_input.dm 74"></a></h3><p>The time at which the text 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/text_input.dm#L82"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/text_input.dm 82"></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/text_input.dm#L76"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/text_input.dm 76"></a></h3><p>The lifespan of the text 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/text_input.dm#L80"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/text_input.dm 80"></a></h3><p>The title of the TGUI window</p><h2 id="proc">Proc Details</h2><h3 id="proc/set_entry"><aside class="declaration">proc </aside>set_entry<aside>(entry) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/tgui/tgui_input/text_input.dm#L169"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/text_input.dm 169"></a></aside></h3><p>Sets the return value for the tgui text proc.
If html encoding is enabled, the text will be encoded.
This can sometimes result in a string that is longer than the max length.
If the string is longer than the max length, it will be clipped.</p><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/text_input.dm#L108"><img src="git.png" width="16" height="16" title="code/modules/tgui/tgui_input/text_input.dm 108"></a></aside></h3><p>Waits for a user's response to the tgui_input_text'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