Files

9 lines
4.5 KiB
HTML

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../../"><link rel="stylesheet" href="dmdoc.css"><title>code/__DEFINES/dcs/dcs_helpers.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/dcs/dcs_helpers.html#define">Define Details</a></header><main><h1>code/__DEFINES/dcs/dcs_helpers.dm <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/dcs/dcs_helpers.dm"><img src="git.png" width="16" height="16" title="code/__DEFINES/dcs/dcs_helpers.dm"></a></h1><table class="summary" cellspacing="0"><tr><th><a href="code/__DEFINES/dcs/dcs_helpers.html#define/SEND_SIGNAL">SEND_SIGNAL</a></th><td>Used to trigger signals and call procs registered for that signal
The datum hosting the signal is automaticaly added as the first argument
Returns a bitfield gathered from all registered procs
Arguments given here are packaged in a list and given to _SendSignal</td></tr><tr><th><a href="code/__DEFINES/dcs/dcs_helpers.html#define/SIGNAL_HANDLER">SIGNAL_HANDLER</a></th><td>Signifies that this proc is used to handle signals.
Every proc you pass to RegisterSignal must have this.</td></tr><tr><th><a href="code/__DEFINES/dcs/dcs_helpers.html#define/AddElement">AddElement</a></th><td>A wrapper for _AddElement that allows us to pretend we're using normal named arguments</td></tr><tr><th><a href="code/__DEFINES/dcs/dcs_helpers.html#define/RemoveElement">RemoveElement</a></th><td>A wrapper for _RemoveElement that allows us to pretend we're using normal named arguments</td></tr><tr><th><a href="code/__DEFINES/dcs/dcs_helpers.html#define/AddComponent">AddComponent</a></th><td>A wrapper for _AddComponent that allows us to pretend we're using normal named arguments</td></tr></table><h2 id="define">Define Details</h2><h3 id="define/AddComponent"><aside class="declaration">#define </aside>AddComponent<aside>(arguments ...)</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/dcs/dcs_helpers.dm#L19"><img src="git.png" width="16" height="16" title="code/__DEFINES/dcs/dcs_helpers.dm 19"></a></h3><p>A wrapper for _AddComponent that allows us to pretend we're using normal named arguments</p><h3 id="define/AddElement"><aside class="declaration">#define </aside>AddElement<aside>(arguments ...)</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/dcs/dcs_helpers.dm#L14"><img src="git.png" width="16" height="16" title="code/__DEFINES/dcs/dcs_helpers.dm 14"></a></h3><p>A wrapper for _AddElement that allows us to pretend we're using normal named arguments</p><h3 id="define/RemoveElement"><aside class="declaration">#define </aside>RemoveElement<aside>(arguments ...)</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/dcs/dcs_helpers.dm#L16"><img src="git.png" width="16" height="16" title="code/__DEFINES/dcs/dcs_helpers.dm 16"></a></h3><p>A wrapper for _RemoveElement that allows us to pretend we're using normal named arguments</p><h3 id="define/SEND_SIGNAL"><aside class="declaration">#define </aside>SEND_SIGNAL<aside>(target, sigtype, arguments ...)</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/dcs/dcs_helpers.dm#L5"><img src="git.png" width="16" height="16" title="code/__DEFINES/dcs/dcs_helpers.dm 5"></a></h3><p>Used to trigger signals and call procs registered for that signal
The datum hosting the signal is automaticaly added as the first argument
Returns a bitfield gathered from all registered procs
Arguments given here are packaged in a list and given to _SendSignal</p><h3 id="define/SIGNAL_HANDLER"><aside class="declaration">#define </aside>SIGNAL_HANDLER <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/__DEFINES/dcs/dcs_helpers.dm#L11"><img src="git.png" width="16" height="16" title="code/__DEFINES/dcs/dcs_helpers.dm 11"></a></h3><p>Signifies that this proc is used to handle signals.
Every proc you pass to RegisterSignal must have this.</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>