sheepishgoat
20 lines
7.6 KiB
HTML
20 lines
7.6 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/tgui_panel - /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_panel.html#var">Var Details</a> - <a href="datum/tgui_panel.html#proc">Proc Details</a></header><main><h1>tgui_panel <aside>/<a href="datum.html">datum</a>/<a href="datum/tgui_panel.html">tgui_panel</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui_panel/tgui_panel.dm#L10"><img src="git.png" width="16" height="16" title="code/modules/tgui_panel/tgui_panel.dm 10"></a></h1><p>tgui_panel datum
|
||
Hosts tgchat and other nice features.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/tgui_panel.html#var/telemetry_analyzed_at">telemetry_analyzed_at</a></th><td>Time of telemetry analysis completion</td></tr><tr><th><a href="datum/tgui_panel.html#var/telemetry_connections">telemetry_connections</a></th><td>List of previous client connections</td></tr><tr><th><a href="datum/tgui_panel.html#var/telemetry_requested_at">telemetry_requested_at</a></th><td>Time of telemetry request</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/tgui_panel.html#proc/analyze_telemetry">analyze_telemetry</a></th><td>private</td></tr><tr><th><a href="datum/tgui_panel.html#proc/initialize">initialize</a></th><td>public</td></tr><tr><th><a href="datum/tgui_panel.html#proc/is_ready">is_ready</a></th><td>public</td></tr><tr><th><a href="datum/tgui_panel.html#proc/on_initialize_timed_out">on_initialize_timed_out</a></th><td>private</td></tr><tr><th><a href="datum/tgui_panel.html#proc/on_message">on_message</a></th><td>private</td></tr><tr><th><a href="datum/tgui_panel.html#proc/play_music">play_music</a></th><td>public</td></tr><tr><th><a href="datum/tgui_panel.html#proc/request_telemetry">request_telemetry</a></th><td>private</td></tr><tr><th><a href="datum/tgui_panel.html#proc/send_roundrestart">send_roundrestart</a></th><td>public</td></tr><tr><th><a href="datum/tgui_panel.html#proc/stop_music">stop_music</a></th><td>public</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/telemetry_analyzed_at"><aside class="declaration">var </aside>telemetry_analyzed_at <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui_panel/telemetry.dm#L20"><img src="git.png" width="16" height="16" title="code/modules/tgui_panel/telemetry.dm 20"></a></h3><p>Time of telemetry analysis completion</p><h3 id="var/telemetry_connections"><aside class="declaration">var </aside>telemetry_connections <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui_panel/telemetry.dm#L22"><img src="git.png" width="16" height="16" title="code/modules/tgui_panel/telemetry.dm 22"></a></h3><p>List of previous client connections</p><h3 id="var/telemetry_requested_at"><aside class="declaration">var </aside>telemetry_requested_at <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui_panel/telemetry.dm#L18"><img src="git.png" width="16" height="16" title="code/modules/tgui_panel/telemetry.dm 18"></a></h3><p>Time of telemetry request</p><h2 id="proc">Proc Details</h2><h3 id="proc/analyze_telemetry"><aside class="declaration">proc </aside>analyze_telemetry<aside>(payload) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui_panel/telemetry.dm#L45"><img src="git.png" width="16" height="16" title="code/modules/tgui_panel/telemetry.dm 45"></a></aside></h3><p>private</p>
|
||
<p>Analyzes a telemetry packet.</p>
|
||
<p>Is currently only useful for detecting ban evasion attempts.</p><h3 id="proc/initialize"><aside class="declaration">proc </aside>initialize<aside>(force) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui_panel/tgui_panel.dm#L39"><img src="git.png" width="16" height="16" title="code/modules/tgui_panel/tgui_panel.dm 39"></a></aside></h3><p>public</p>
|
||
<p>Initializes tgui panel.</p><h3 id="proc/is_ready"><aside class="declaration">proc </aside>is_ready<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui_panel/tgui_panel.dm#L31"><img src="git.png" width="16" height="16" title="code/modules/tgui_panel/tgui_panel.dm 31"></a></aside></h3><p>public</p>
|
||
<p>TRUE if panel is initialized and ready to receive messages.</p><h3 id="proc/on_initialize_timed_out"><aside class="declaration">proc </aside>on_initialize_timed_out<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui_panel/tgui_panel.dm#L60"><img src="git.png" width="16" height="16" title="code/modules/tgui_panel/tgui_panel.dm 60"></a></aside></h3><p>private</p>
|
||
<p>Called when initialization has timed out.</p><h3 id="proc/on_message"><aside class="declaration">proc </aside>on_message<aside>(type, payload) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui_panel/tgui_panel.dm#L69"><img src="git.png" width="16" height="16" title="code/modules/tgui_panel/tgui_panel.dm 69"></a></aside></h3><p>private</p>
|
||
<p>Callback for handling incoming tgui messages.</p><h3 id="proc/play_music"><aside class="declaration">proc </aside>play_music<aside>(url, extra_data) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui_panel/audio.dm#L22"><img src="git.png" width="16" height="16" title="code/modules/tgui_panel/audio.dm 22"></a></aside></h3><p>public</p>
|
||
<p>Sends music data to the browser.</p>
|
||
<p>Optional settings:</p>
|
||
<ul>
|
||
<li>pitch: the playback rate</li>
|
||
<li>start: the start time of the sound</li>
|
||
<li>end: when the musics stops playing</li>
|
||
</ul>
|
||
<p>required url string Must be an https URL.
|
||
optional extra_data list Optional settings.</p><h3 id="proc/request_telemetry"><aside class="declaration">proc </aside>request_telemetry<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui_panel/telemetry.dm#L29"><img src="git.png" width="16" height="16" title="code/modules/tgui_panel/telemetry.dm 29"></a></aside></h3><p>private</p>
|
||
<p>Requests some telemetry from the client.</p><h3 id="proc/send_roundrestart"><aside class="declaration">proc </aside>send_roundrestart<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui_panel/tgui_panel.dm#L98"><img src="git.png" width="16" height="16" title="code/modules/tgui_panel/tgui_panel.dm 98"></a></aside></h3><p>public</p>
|
||
<p>Sends a round restart notification.</p><h3 id="proc/stop_music"><aside class="declaration">proc </aside>stop_music<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/tgui_panel/audio.dm#L39"><img src="git.png" width="16" height="16" title="code/modules/tgui_panel/audio.dm 39"></a></aside></h3><p>public</p>
|
||
<p>Stops playing music through the browser.</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> |