sheepishgoat
11 lines
5.0 KiB
HTML
11 lines
5.0 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../../"><link rel="stylesheet" href="dmdoc.css"><title>code/__DEFINES/dcs/helpers.dm - /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="code/__DEFINES/dcs/helpers.html#define">Define Details</a></header><main><h1>code/__DEFINES/dcs/helpers.dm <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/dcs/helpers.dm0"><img src="git.png" width="16" height="16" title="code/__DEFINES/dcs/helpers.dm0"></a></h1><table class="summary" cellspacing="0"><tr><th><a href="code/__DEFINES/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/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/helpers.html#define/SIGNAL_HANDLER_DOES_SLEEP">SIGNAL_HANDLER_DOES_SLEEP</a></th><td>Signifies that this proc is used to handle signals, but also sleeps.
|
|
Do not use this for new work.</td></tr><tr><th><a href="code/__DEFINES/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/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/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/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/dcs/helpers.dm#L23"><img src="git.png" width="16" height="16" title="code/__DEFINES/dcs/helpers.dm 23"></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/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/dcs/helpers.dm#L18"><img src="git.png" width="16" height="16" title="code/__DEFINES/dcs/helpers.dm 18"></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/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/dcs/helpers.dm#L20"><img src="git.png" width="16" height="16" title="code/__DEFINES/dcs/helpers.dm 20"></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/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/dcs/helpers.dm#L5"><img src="git.png" width="16" height="16" title="code/__DEFINES/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/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/dcs/helpers.dm#L11"><img src="git.png" width="16" height="16" title="code/__DEFINES/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><h3 id="define/SIGNAL_HANDLER_DOES_SLEEP"><aside class="declaration">#define </aside>SIGNAL_HANDLER_DOES_SLEEP <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/dcs/helpers.dm#L15"><img src="git.png" width="16" height="16" title="code/__DEFINES/dcs/helpers.dm 15"></a></h3><p>Signifies that this proc is used to handle signals, but also sleeps.
|
|
Do not use this for new work.</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> |