mirror of
https://github.com/ParadiseSS13/Paradise.git
synced 2026-08-26 21:48:21 +01:00
10 lines
2.8 KiB
HTML
10 lines
2.8 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/redis_callback - 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/redis_callback.html#var">Var Details</a> - <a href="datum/redis_callback.html#proc">Proc Details</a></header><main><h1>Redis callback <aside>/<a href="datum.html">datum</a>/<a href="datum/redis_callback.html">redis_callback</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/redis/redis_callback.dm#L10"><img src="git.png" width="16" height="16" title="code/modules/redis/redis_callback.dm 10"></a></h1><p>Callback datum for subscribed redis channel handling</p>
|
|
<p>This datum is used for easily assigning callbacks for SSredis to use
|
|
when a message is receievd on a channel. Define a channel on the <code>channel</code>
|
|
var and SSredis will automatically register subtypes of <a href="datum/redis_callback.html" title="/datum/redis_callback">/datum/redis_callback</a></p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/redis_callback.html#var/channel">channel</a></th><td>Channel for this callback to listen on</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/redis_callback.html#proc/on_message">on_message</a></th><td>Message handler callback</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/channel"><aside class="declaration">var </aside>channel <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/redis/redis_callback.dm#L12"><img src="git.png" width="16" height="16" title="code/modules/redis/redis_callback.dm 12"></a></h3><p>Channel for this callback to listen on</p><h2 id="proc">Proc Details</h2><h3 id="proc/on_message"><aside class="declaration">proc </aside>on_message<aside>(message) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/redis/redis_callback.dm#L23"><img src="git.png" width="16" height="16" title="code/modules/redis/redis_callback.dm 23"></a></aside></h3><p>Message handler callback</p>
|
|
<p>This callback is ran when a message is received on the assigned channel.
|
|
Make sure you override it on subtypes or it wont work.</p>
|
|
<p>Arguments:</p>
|
|
<ul>
|
|
<li>message - The message received on the redis channel</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> |