Files
Paradise/datum/server_command.html

4 lines
3.6 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/server_command - 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/server_command.html#var">Var Details</a></header><main><h1>Server Command <aside>/<a href="datum.html">datum</a>/<a href="datum/server_command.html">server_command</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/server_commands/servermsg.dm#L10"><img src="git.png" width="16" height="16" title="code/modules/server_commands/servermsg.dm 10"></a></h1><p>Datum to handle both sending and receiving of server commands</p>
<p>This datum is an extension of the redis callback and is designed for tighter integration with the BYOND servers.
This list is registered and managed by SSintancing, not SSredis.
NOTE: These commands are &quot;fire and forget&quot;. If you need specific data from each server, use world/Topic still</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/server_command.html#var/command_args">command_args</a></th><td>Associative list of command args</td></tr><tr><th><a href="datum/server_command.html#var/command_name">command_name</a></th><td>The command name (must be unique)</td></tr><tr><th><a href="datum/server_command.html#var/ignoreself">ignoreself</a></th><td>Does the sending server want to ignore this command? This is almost always yes unless you are doing testing stuff</td></tr><tr><th><a href="datum/server_command.html#var/source">source</a></th><td>The source BYOND server for this message</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/command_args"><aside class="declaration">var </aside>command_args <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/server_commands/servermsg.dm#L18"><img src="git.png" width="16" height="16" title="code/modules/server_commands/servermsg.dm 18"></a></h3><p>Associative list of command args</p><h3 id="var/command_name"><aside class="declaration">var </aside>command_name <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/server_commands/servermsg.dm#L16"><img src="git.png" width="16" height="16" title="code/modules/server_commands/servermsg.dm 16"></a></h3><p>The command name (must be unique)</p><h3 id="var/ignoreself"><aside class="declaration">var </aside>ignoreself <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/server_commands/servermsg.dm#L12"><img src="git.png" width="16" height="16" title="code/modules/server_commands/servermsg.dm 12"></a></h3><p>Does the sending server want to ignore this command? This is almost always yes unless you are doing testing stuff</p><h3 id="var/source"><aside class="declaration">var </aside>source <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/server_commands/servermsg.dm#L14"><img src="git.png" width="16" height="16" title="code/modules/server_commands/servermsg.dm 14"></a></h3><p>The source BYOND server for this message</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>