Files
Paradise/obj/item/stack/cable_coil.html

7 lines
4.9 KiB
HTML

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../../"><link rel="stylesheet" href="dmdoc.css"><title>/obj/item/stack/cable_coil - 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="obj/item/stack/cable_coil.html#var">Var Details</a> - <a href="obj/item/stack/cable_coil.html#proc">Proc Details</a></header><main><h1>cable_coil <aside>/<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/<a href="obj/item/stack.html">stack</a>/<a href="obj/item/stack/cable_coil.html">cable_coil</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/modules/power/cables/cable_coil.dm#L9"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable_coil.dm 9"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/item/stack/cable_coil.html#var/cable_merge_id">cable_merge_id</a></th><td>Bitflag of the types of cable we can add cable to with this coil.
This is different to the cable connection flag since it only governs connecting on the same tile</td></tr><tr><th><a href="obj/item/stack/cable_coil.html#var/cable_type">cable_type</a></th><td>Deletes the cable coil upon getting empty.
Used for RCL cable spools to stop the stack from being eaten.
Type of cable this coil makes</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/item/stack/cable_coil.html#proc/cable_join">cable_join</a></th><td>called when cable_coil is click on an installed obj/cable or click on a turf that already contains a &quot;node&quot; cable</td></tr><tr><th><a href="obj/item/stack/cable_coil.html#proc/get_cable_color">get_cable_color</a></th><td>Used to decouple the physical color of the cable from the logical color. Used by RCL to stop its spool holder from being colored in.</td></tr><tr><th><a href="obj/item/stack/cable_coil.html#proc/place_turf">place_turf</a></th><td>called when cable_coil is clicked on a turf/simulated/floor</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/cable_merge_id"><aside class="declaration">var </aside>cable_merge_id <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/modules/power/cables/cable_coil.dm#L35"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable_coil.dm 35"></a></h3><p>Bitflag of the types of cable we can add cable to with this coil.
This is different to the cable connection flag since it only governs connecting on the same tile</p><h3 id="var/cable_type"><aside class="declaration">var </aside>cable_type <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/modules/power/cables/cable_coil.dm#L32"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable_coil.dm 32"></a></h3><p>Deletes the cable coil upon getting empty.
Used for RCL cable spools to stop the stack from being eaten.
Type of cable this coil makes</p><h2 id="proc">Proc Details</h2><h3 id="proc/cable_join"><aside class="declaration">proc </aside>cable_join<aside>(/<a href="obj.html">obj</a>/<a href="obj/structure.html">structure</a>/<a href="obj/structure/cable.html">cable</a>/C, /<a href="mob.html">mob</a>/user) <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/modules/power/cables/cable_coil.dm#L233"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable_coil.dm 233"></a></aside></h3><p>called when cable_coil is click on an installed obj/cable or click on a turf that already contains a &quot;node&quot; cable</p><h3 id="proc/get_cable_color"><aside class="declaration">proc </aside>get_cable_color<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/modules/power/cables/cable_coil.dm#L54"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable_coil.dm 54"></a></aside></h3><p>Used to decouple the physical color of the cable from the logical color. Used by RCL to stop its spool holder from being colored in.</p><h3 id="proc/place_turf"><aside class="declaration">proc </aside>place_turf<aside>(/<a href="turf.html">turf</a>/T, /<a href="mob.html">mob</a>/user, cable_direction) <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/modules/power/cables/cable_coil.dm#L181"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable_coil.dm 181"></a></aside></h3><p>called when cable_coil is clicked on a turf/simulated/floor</p></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/776b9861f70566b1e6a0763a465ef22f7920a3d6">776b986</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html>