mirror of
https://github.com/ParadiseSS13/Paradise.git
synced 2026-08-26 21:48:21 +01:00
13 lines
3.7 KiB
HTML
13 lines
3.7 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/world_topic_handler - 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/world_topic_handler.html#var">Var Details</a> - <a href="datum/world_topic_handler.html#proc">Proc Details</a></header><main><h1>world_topic_handler <aside>/<a href="datum.html">datum</a>/<a href="datum/world_topic_handler.html">world_topic_handler</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/world_topic/_topic_base.dm#L1"><img src="git.png" width="16" height="16" title="code/modules/world_topic/_topic_base.dm 1"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/world_topic_handler.html#var/requires_commskey">requires_commskey</a></th><td>Set this to TRUE if the topic handler needs an authorised comms key</td></tr><tr><th><a href="datum/world_topic_handler.html#var/topic_key">topic_key</a></th><td>Key which invokes this topic</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/world_topic_handler.html#proc/execute">execute</a></th><td>Actually executes the user's topic</td></tr><tr><th><a href="datum/world_topic_handler.html#proc/invoke">invoke</a></th><td>Invokes the world/Topic handler</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/requires_commskey"><aside class="declaration">var </aside>requires_commskey <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/world_topic/_topic_base.dm#L5"><img src="git.png" width="16" height="16" title="code/modules/world_topic/_topic_base.dm 5"></a></h3><p>Set this to TRUE if the topic handler needs an authorised comms key</p><h3 id="var/topic_key"><aside class="declaration">var </aside>topic_key <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/world_topic/_topic_base.dm#L3"><img src="git.png" width="16" height="16" title="code/modules/world_topic/_topic_base.dm 3"></a></h3><p>Key which invokes this topic</p><h2 id="proc">Proc Details</h2><h3 id="proc/execute"><aside class="declaration">proc </aside>execute<aside>(/list/input, key_valid) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/world_topic/_topic_base.dm#L34"><img src="git.png" width="16" height="16" title="code/modules/world_topic/_topic_base.dm 34"></a></aside></h3><p>Actually executes the user's topic</p>
|
|
<p>Override this to do your work in subtypes of this topic</p>
|
|
<p>Arguments:</p>
|
|
<ul>
|
|
<li>input - The list of topic data, sent from [/world/proc/Topic]</li>
|
|
<li>key_valid - Has the user entered the correct auth key</li>
|
|
</ul><h3 id="proc/invoke"><aside class="declaration">proc </aside>invoke<aside>(/list/input) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/world_topic/_topic_base.dm#L16"><img src="git.png" width="16" height="16" title="code/modules/world_topic/_topic_base.dm 16"></a></aside></h3><p>Invokes the world/Topic handler</p>
|
|
<p>This includes sanity checking for if the key is required, as well as other sanity checks
|
|
DO NOT OVERRIDE
|
|
Arguments:</p>
|
|
<ul>
|
|
<li>input - The list of topic data, sent from [/world/proc/Topic]</li>
|
|
</ul></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> |