Files
Paradise/datum/mod_link.html

1 line
7.7 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/mod_link - 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/mod_link.html#var">Var Details</a></header><main><h1>mod_link <aside>/<a href="datum.html">datum</a>/<a href="datum/mod_link.html">mod_link</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/mod/mod_link.dm#L355"><img src="git.png" width="16" height="16" title="code/modules/mod/mod_link.dm 355"></a></h1><p>A MODlink datum, used to handle unique functions that will be used in the MODlink call.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/mod_link.html#var/can_call_callback">can_call_callback</a></th><td>A callback that returns whether the MODlink can currently call.</td></tr><tr><th><a href="datum/mod_link.html#var/delete_visual_callback">delete_visual_callback</a></th><td>A callback that deletes the visuals of the MODlink.</td></tr><tr><th><a href="datum/mod_link.html#var/frequency">frequency</a></th><td>The frequency of the MODlink. You can only call other MODlinks on the same frequency.</td></tr><tr><th><a href="datum/mod_link.html#var/get_user_callback">get_user_callback</a></th><td>A callback that returns the user of the MODlink.</td></tr><tr><th><a href="datum/mod_link.html#var/get_visual_callback">get_visual_callback</a></th><td>A callback that receives the visuals of the other MODlink.</td></tr><tr><th><a href="datum/mod_link.html#var/holder">holder</a></th><td>The atom that holds the MODlink.</td></tr><tr><th><a href="datum/mod_link.html#var/id">id</a></th><td>The unique ID of the MODlink.</td></tr><tr><th><a href="datum/mod_link.html#var/link_call">link_call</a></th><td>A reference to the call between two MODlinks.</td></tr><tr><th><a href="datum/mod_link.html#var/make_visual_callback">make_visual_callback</a></th><td>A callback that returns the visuals of the MODlink.</td></tr><tr><th><a href="datum/mod_link.html#var/name">name</a></th><td>Generic name for multitool buffers.</td></tr><tr><th><a href="datum/mod_link.html#var/visual">visual</a></th><td>A reference to the visuals generated by the MODlink.</td></tr><tr><th><a href="datum/mod_link.html#var/visual_overlays">visual_overlays</a></th><td>A list of all overlays of the user, copied everytime they have an overlay change.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/can_call_callback"><aside class="declaration">var </aside>can_call_callback <aside> /<a href="datum.html">datum</a>/callback</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/mod/mod_link.dm#L373"><img src="git.png" width="16" height="16" title="code/modules/mod/mod_link.dm 373"></a></h3><p>A callback that returns whether the MODlink can currently call.</p><h3 id="var/delete_visual_callback"><aside class="declaration">var </aside>delete_visual_callback <aside> /<a href="datum.html">datum</a>/callback</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/mod/mod_link.dm#L379"><img src="git.png" width="16" height="16" title="code/modules/mod/mod_link.dm 379"></a></h3><p>A callback that deletes the visuals of the MODlink.</p><h3 id="var/frequency"><aside class="declaration">var </aside>frequency <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/mod/mod_link.dm#L359"><img src="git.png" width="16" height="16" title="code/modules/mod/mod_link.dm 359"></a></h3><p>The frequency of the MODlink. You can only call other MODlinks on the same frequency.</p><h3 id="var/get_user_callback"><aside class="declaration">var </aside>get_user_callback <aside> /<a href="datum.html">datum</a>/callback</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/mod/mod_link.dm#L371"><img src="git.png" width="16" height="16" title="code/modules/mod/mod_link.dm 371"></a></h3><p>A callback that returns the user of the MODlink.</p><h3 id="var/get_visual_callback"><aside class="declaration">var </aside>get_visual_callback <aside> /<a href="datum.html">datum</a>/callback</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/mod/mod_link.dm#L377"><img src="git.png" width="16" height="16" title="code/modules/mod/mod_link.dm 377"></a></h3><p>A callback that receives the visuals of the other MODlink.</p><h3 id="var/holder"><aside class="declaration">var </aside>holder <aside> /<a href="atom.html">atom</a>/<a href="atom/movable.html">movable</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/mod/mod_link.dm#L363"><img src="git.png" width="16" height="16" title="code/modules/mod/mod_link.dm 363"></a></h3><p>The atom that holds the MODlink.</p><h3 id="var/id"><aside class="declaration">var </aside>id <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/mod/mod_link.dm#L361"><img src="git.png" width="16" height="16" title="code/modules/mod/mod_link.dm 361"></a></h3><p>The unique ID of the MODlink.</p><h3 id="var/link_call"><aside class="declaration">var </aside>link_call <aside> /<a href="datum.html">datum</a>/<a href="datum/mod_link_call.html">mod_link_call</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/mod/mod_link.dm#L369"><img src="git.png" width="16" height="16" title="code/modules/mod/mod_link.dm 369"></a></h3><p>A reference to the call between two MODlinks.</p><h3 id="var/make_visual_callback"><aside class="declaration">var </aside>make_visual_callback <aside> /<a href="datum.html">datum</a>/callback</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/mod/mod_link.dm#L375"><img src="git.png" width="16" height="16" title="code/modules/mod/mod_link.dm 375"></a></h3><p>A callback that returns the visuals of the MODlink.</p><h3 id="var/name"><aside class="declaration">var </aside>name <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/mod/mod_link.dm#L357"><img src="git.png" width="16" height="16" title="code/modules/mod/mod_link.dm 357"></a></h3><p>Generic name for multitool buffers.</p><h3 id="var/visual"><aside class="declaration">var </aside>visual <aside> /<a href="atom.html">atom</a>/<a href="atom/movable.html">movable</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/mod/mod_link.dm#L365"><img src="git.png" width="16" height="16" title="code/modules/mod/mod_link.dm 365"></a></h3><p>A reference to the visuals generated by the MODlink.</p><h3 id="var/visual_overlays"><aside class="declaration">var </aside>visual_overlays <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/mod/mod_link.dm#L367"><img src="git.png" width="16" height="16" title="code/modules/mod/mod_link.dm 367"></a></h3><p>A list of all overlays of the user, copied everytime they have an overlay change.</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>