Files
Paradise/datum/component/connect_range.html

5 lines
4.5 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/component/connect_range - 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/component/connect_range.html#var">Var Details</a></header><main><h1>connect_range <aside>/<a href="datum.html">datum</a>/<a href="datum/component.html">component</a>/<a href="datum/component/connect_range.html">connect_range</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/connect_range.dm#L6"><img src="git.png" width="16" height="16" title="code/datums/components/connect_range.dm 6"></a></h1><p>This component behaves similar to connect_loc_behalf but for all turfs in range, hooking into a signal on each of them.
Just like connect_loc_behalf, It can react to that signal on behalf of a seperate listener.
Good for components, though it carries some overhead. Can't be an element as that may lead to bugs.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/component/connect_range.html#var/connections">connections</a></th><td>An assoc list of signal -&gt; procpath to register to the loc this object is on.</td></tr><tr><th><a href="datum/component/connect_range.html#var/range">range</a></th><td>The component will hook into signals only on turfs not farther from tracked than this.</td></tr><tr><th><a href="datum/component/connect_range.html#var/tracked">tracked</a></th><td>The atom the component is tracking. The component will delete itself if the tracked is deleted.
Signals will also be updated whenever it moves (if it's a movable).</td></tr><tr><th><a href="datum/component/connect_range.html#var/turfs">turfs</a></th><td>The turfs currently connected to this component</td></tr><tr><th><a href="datum/component/connect_range.html#var/works_in_containers">works_in_containers</a></th><td>Whether the component works when the movable isn't directly located on a turf.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/connections"><aside class="declaration">var </aside>connections <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/connect_range.dm#L10"><img src="git.png" width="16" height="16" title="code/datums/components/connect_range.dm 10"></a></h3><p>An assoc list of signal -&gt; procpath to register to the loc this object is on.</p><h3 id="var/range"><aside class="declaration">var </aside>range <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/connect_range.dm#L20"><img src="git.png" width="16" height="16" title="code/datums/components/connect_range.dm 20"></a></h3><p>The component will hook into signals only on turfs not farther from tracked than this.</p><h3 id="var/tracked"><aside class="declaration">var </aside>tracked <aside> /<a href="atom.html">atom</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/connect_range.dm#L17"><img src="git.png" width="16" height="16" title="code/datums/components/connect_range.dm 17"></a></h3><p>The atom the component is tracking. The component will delete itself if the tracked is deleted.
Signals will also be updated whenever it moves (if it's a movable).</p><h3 id="var/turfs"><aside class="declaration">var </aside>turfs <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/connect_range.dm#L12"><img src="git.png" width="16" height="16" title="code/datums/components/connect_range.dm 12"></a></h3><p>The turfs currently connected to this component</p><h3 id="var/works_in_containers"><aside class="declaration">var </aside>works_in_containers <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/components/connect_range.dm#L22"><img src="git.png" width="16" height="16" title="code/datums/components/connect_range.dm 22"></a></h3><p>Whether the component works when the movable isn't directly located on a turf.</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>