Paradise/datum/tgs_chat_command.html

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/tgs_chat_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/tgs_chat_command.html#var">Var Details</a> - <a href="datum/tgs_chat_command.html#proc">Proc Details</a></header><main><h1>tgs_chat_command <aside>/<a href="datum.html">datum</a>/<a href="datum/tgs_chat_command.html">tgs_chat_command</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgs.dm#L285"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 285"></a></h1><p>User definable chat command.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/tgs_chat_command.html#var/admin_only">admin_only</a></th><td>If this command should be available to game administrators only.</td></tr><tr><th><a href="datum/tgs_chat_command.html#var/help_text">help_text</a></th><td>The help text displayed for this command.</td></tr><tr><th><a href="datum/tgs_chat_command.html#var/ignore_type">ignore_type</a></th><td>A subtype of <a href="datum/tgs_chat_command.html" title="/datum/tgs_chat_command">/datum/tgs_chat_command</a> that is ignored when enumerating available commands. Use this to create shared base /datums for commands.</td></tr><tr><th><a href="datum/tgs_chat_command.html#var/name">name</a></th><td>The string to trigger this command on a chat bot. e.g <code>@bot name ...</code> or <code>!tgs name ...</code>.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/tgs_chat_command.html#proc/Run">Run</a></th><td>Process command activation. Should return a <a href="datum/tgs_message_content.html" title="/datum/tgs_message_content">/datum/tgs_message_content</a> to respond to the issuer with.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/admin_only"><aside class="declaration">var </aside>admin_only <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgs.dm#L291"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 291"></a></h3><p>If this command should be available to game administrators only.</p><h3 id="var/help_text"><aside class="declaration">var </aside>help_text <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgs.dm#L289"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 289"></a></h3><p>The help text displayed for this command.</p><h3 id="var/ignore_type"><aside class="declaration">var </aside>ignore_type <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgs.dm#L293"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 293"></a></h3><p>A subtype of <a href="datum/tgs_chat_command.html" title="/datum/tgs_chat_command">/datum/tgs_chat_command</a> that is ignored when enumerating available commands. Use this to create shared base /datums for commands.</p><h3 id="var/name"><aside class="declaration">var </aside>name <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgs.dm#L287"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 287"></a></h3><p>The string to trigger this command on a chat bot. e.g <code>@bot name ...</code> or <code>!tgs name ...</code>.</p><h2 id="proc">Proc Details</h2><h3 id="proc/Run"><aside class="declaration">proc </aside>Run<aside>(/<a href="datum.html">datum</a>/<a href="datum/tgs_chat_user.html">tgs_chat_user</a>/sender, params)  <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgs.dm#L301"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 301"></a></aside></h3><p>Process command activation. Should return a <a href="datum/tgs_message_content.html" title="/datum/tgs_message_content">/datum/tgs_message_content</a> to respond to the issuer with.</p>
<p>sender - The <a href="datum/tgs_chat_user.html" title="/datum/tgs_chat_user">/datum/tgs_chat_user</a> who issued the command.
params - The trimmed string following the command `/datum/tgs_chat_command/var/name].</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>
	<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/tgs_chat_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/tgs_chat_command.html#var">Var Details</a> - <a href="datum/tgs_chat_command.html#proc">Proc Details</a></header><main><h1>tgs_chat_command <aside>/<a href="datum.html">datum</a>/<a href="datum/tgs_chat_command.html">tgs_chat_command</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgs.dm#L285"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 285"></a></h1><p>User definable chat command.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/tgs_chat_command.html#var/admin_only">admin_only</a></th><td>If this command should be available to game administrators only.</td></tr><tr><th><a href="datum/tgs_chat_command.html#var/help_text">help_text</a></th><td>The help text displayed for this command.</td></tr><tr><th><a href="datum/tgs_chat_command.html#var/ignore_type">ignore_type</a></th><td>A subtype of <a href="datum/tgs_chat_command.html" title="/datum/tgs_chat_command">/datum/tgs_chat_command</a> that is ignored when enumerating available commands. Use this to create shared base /datums for commands.</td></tr><tr><th><a href="datum/tgs_chat_command.html#var/name">name</a></th><td>The string to trigger this command on a chat bot. e.g <code>@bot name ...</code> or <code>!tgs name ...</code>.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/tgs_chat_command.html#proc/Run">Run</a></th><td>Process command activation. Should return a <a href="datum/tgs_message_content.html" title="/datum/tgs_message_content">/datum/tgs_message_content</a> to respond to the issuer with.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/admin_only"><aside class="declaration">var </aside>admin_only <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgs.dm#L291"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 291"></a></h3><p>If this command should be available to game administrators only.</p><h3 id="var/help_text"><aside class="declaration">var </aside>help_text <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgs.dm#L289"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 289"></a></h3><p>The help text displayed for this command.</p><h3 id="var/ignore_type"><aside class="declaration">var </aside>ignore_type <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgs.dm#L293"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 293"></a></h3><p>A subtype of <a href="datum/tgs_chat_command.html" title="/datum/tgs_chat_command">/datum/tgs_chat_command</a> that is ignored when enumerating available commands. Use this to create shared base /datums for commands.</p><h3 id="var/name"><aside class="declaration">var </aside>name <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgs.dm#L287"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 287"></a></h3><p>The string to trigger this command on a chat bot. e.g <code>@bot name ...</code> or <code>!tgs name ...</code>.</p><h2 id="proc">Proc Details</h2><h3 id="proc/Run"><aside class="declaration">proc </aside>Run<aside>(/<a href="datum.html">datum</a>/<a href="datum/tgs_chat_user.html">tgs_chat_user</a>/sender, params) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/tgs.dm#L301"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 301"></a></aside></h3><p>Process command activation. Should return a <a href="datum/tgs_message_content.html" title="/datum/tgs_message_content">/datum/tgs_message_content</a> to respond to the issuer with.</p>
	`<p>sender - The <a href="datum/tgs_chat_user.html" title="/datum/tgs_chat_user">/datum/tgs_chat_user</a> who issued the command.`
	params - The trimmed string following the command `/datum/tgs_chat_command/var/name].</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>