Files
Paradise/code/__DEFINES/tgui_defines.html

1 line
8.3 KiB
HTML

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../"><link rel="stylesheet" href="dmdoc.css"><title>code/__DEFINES/tgui_defines.dm - 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="code/__DEFINES/tgui_defines.html#define">Define Details</a></header><main><h1>code/__DEFINES/tgui_defines.dm <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgui_defines.dm"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgui_defines.dm"></a></h1><table class="summary" cellspacing="0"><tr><th><a href="code/__DEFINES/tgui_defines.html#define/UI_INTERACTIVE">UI_INTERACTIVE</a></th><td>Green eye; fully interactive</td></tr><tr><th><a href="code/__DEFINES/tgui_defines.html#define/UI_UPDATE">UI_UPDATE</a></th><td>Orange eye; updates but is not interactive</td></tr><tr><th><a href="code/__DEFINES/tgui_defines.html#define/UI_DISABLED">UI_DISABLED</a></th><td>Red eye; disabled, does not update</td></tr><tr><th><a href="code/__DEFINES/tgui_defines.html#define/UI_CLOSE">UI_CLOSE</a></th><td>UI Should close</td></tr><tr><th><a href="code/__DEFINES/tgui_defines.html#define/TGUI_WINDOW_SOFT_LIMIT">TGUI_WINDOW_SOFT_LIMIT</a></th><td>Maximum number of windows that can be suspended/reused</td></tr><tr><th><a href="code/__DEFINES/tgui_defines.html#define/TGUI_WINDOW_HARD_LIMIT">TGUI_WINDOW_HARD_LIMIT</a></th><td>Maximum number of open windows</td></tr><tr><th><a href="code/__DEFINES/tgui_defines.html#define/TGUI_PING_TIMEOUT">TGUI_PING_TIMEOUT</a></th><td>Maximum ping timeout allowed to detect zombie windows</td></tr><tr><th><a href="code/__DEFINES/tgui_defines.html#define/TGUI_REFRESH_FULL_UPDATE_COOLDOWN">TGUI_REFRESH_FULL_UPDATE_COOLDOWN</a></th><td>Used for rate-limiting to prevent DoS by excessively refreshing a TGUI window</td></tr><tr><th><a href="code/__DEFINES/tgui_defines.html#define/TGUI_WINDOW_CLOSED">TGUI_WINDOW_CLOSED</a></th><td>Window does not exist</td></tr><tr><th><a href="code/__DEFINES/tgui_defines.html#define/TGUI_WINDOW_LOADING">TGUI_WINDOW_LOADING</a></th><td>Window was just opened, but is still not ready to be sent data</td></tr><tr><th><a href="code/__DEFINES/tgui_defines.html#define/TGUI_WINDOW_READY">TGUI_WINDOW_READY</a></th><td>Window is free and ready to receive data</td></tr><tr><th><a href="code/__DEFINES/tgui_defines.html#define/TGUI_WINDOW_ID">TGUI_WINDOW_ID</a></th><td>Get a window id based on the provided pool index</td></tr><tr><th><a href="code/__DEFINES/tgui_defines.html#define/TGUI_WINDOW_INDEX">TGUI_WINDOW_INDEX</a></th><td>Get a pool index of the provided window id</td></tr><tr><th><a href="code/__DEFINES/tgui_defines.html#define/TGUI_CREATE_MESSAGE">TGUI_CREATE_MESSAGE</a></th><td>Creates a message packet for sending via output()</td></tr></table><h2 id="define">Define Details</h2><h3 id="define/TGUI_CREATE_MESSAGE"><aside class="declaration">#define </aside>TGUI_CREATE_MESSAGE<aside>(type, payload)</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgui_defines.dm#L42"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgui_defines.dm 42"></a></h3><p>Creates a message packet for sending via output()</p><h3 id="define/TGUI_PING_TIMEOUT"><aside class="declaration">#define </aside>TGUI_PING_TIMEOUT <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgui_defines.dm#L25"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgui_defines.dm 25"></a></h3><p>Maximum ping timeout allowed to detect zombie windows</p><h3 id="define/TGUI_REFRESH_FULL_UPDATE_COOLDOWN"><aside class="declaration">#define </aside>TGUI_REFRESH_FULL_UPDATE_COOLDOWN <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgui_defines.dm#L27"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgui_defines.dm 27"></a></h3><p>Used for rate-limiting to prevent DoS by excessively refreshing a TGUI window</p><h3 id="define/TGUI_WINDOW_CLOSED"><aside class="declaration">#define </aside>TGUI_WINDOW_CLOSED <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgui_defines.dm#L30"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgui_defines.dm 30"></a></h3><p>Window does not exist</p><h3 id="define/TGUI_WINDOW_HARD_LIMIT"><aside class="declaration">#define </aside>TGUI_WINDOW_HARD_LIMIT <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgui_defines.dm#L22"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgui_defines.dm 22"></a></h3><p>Maximum number of open windows</p><h3 id="define/TGUI_WINDOW_ID"><aside class="declaration">#define </aside>TGUI_WINDOW_ID<aside>(index)</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgui_defines.dm#L37"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgui_defines.dm 37"></a></h3><p>Get a window id based on the provided pool index</p><h3 id="define/TGUI_WINDOW_INDEX"><aside class="declaration">#define </aside>TGUI_WINDOW_INDEX<aside>(window_id)</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgui_defines.dm#L39"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgui_defines.dm 39"></a></h3><p>Get a pool index of the provided window id</p><h3 id="define/TGUI_WINDOW_LOADING"><aside class="declaration">#define </aside>TGUI_WINDOW_LOADING <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgui_defines.dm#L32"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgui_defines.dm 32"></a></h3><p>Window was just opened, but is still not ready to be sent data</p><h3 id="define/TGUI_WINDOW_READY"><aside class="declaration">#define </aside>TGUI_WINDOW_READY <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgui_defines.dm#L34"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgui_defines.dm 34"></a></h3><p>Window is free and ready to receive data</p><h3 id="define/TGUI_WINDOW_SOFT_LIMIT"><aside class="declaration">#define </aside>TGUI_WINDOW_SOFT_LIMIT <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgui_defines.dm#L20"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgui_defines.dm 20"></a></h3><p>Maximum number of windows that can be suspended/reused</p><h3 id="define/UI_CLOSE"><aside class="declaration">#define </aside>UI_CLOSE <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgui_defines.dm#L17"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgui_defines.dm 17"></a></h3><p>UI Should close</p><h3 id="define/UI_DISABLED"><aside class="declaration">#define </aside>UI_DISABLED <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgui_defines.dm#L15"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgui_defines.dm 15"></a></h3><p>Red eye; disabled, does not update</p><h3 id="define/UI_INTERACTIVE"><aside class="declaration">#define </aside>UI_INTERACTIVE <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgui_defines.dm#L11"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgui_defines.dm 11"></a></h3><p>Green eye; fully interactive</p><h3 id="define/UI_UPDATE"><aside class="declaration">#define </aside>UI_UPDATE <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgui_defines.dm#L13"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgui_defines.dm 13"></a></h3><p>Orange eye; updates but is not interactive</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>