cyberpresidentvanellope/Paradise
1
0
Fork 0
mirror of https://github.com/ParadiseSS13/Paradise.git synced 2026-08-26 13:37:58 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
Paradise/obj/structure/cable.html
T

3 lines
10 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>/obj/structure/cable - 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/structure/cable.html#var">Var Details</a> - <a href="obj/structure/cable.html#proc">Proc Details</a></header><main><h1>cable <aside>/<a href="obj.html">obj</a>/<a href="obj/structure.html">structure</a>/<a href="obj/structure/cable.html">cable</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/power/cables/cable.dm#L21"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable.dm 21"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/structure/cable.html#var/cable_coil_type">cable_coil_type</a></th><td>The type of cable coil you make when deconstructed</td></tr><tr><th><a href="obj/structure/cable.html#var/connect_type">connect_type</a></th><td>Types of cables that can connect to this cable</td></tr><tr><th><a href="obj/structure/cable.html#var/d1">d1</a></th><td>The direction of endpoint one of this cable</td></tr><tr><th><a href="obj/structure/cable.html#var/d2">d2</a></th><td>The direction of enpoint two of this cable</td></tr><tr><th><a href="obj/structure/cable.html#var/extra_insulated">extra_insulated</a></th><td>Whether the cable has additional insulation to prevent shocking on contact</td></tr><tr><th><a href="obj/structure/cable.html#var/merge_id">merge_id</a></th><td>The types of cables that can merge with this cable</td></tr><tr><th><a href="obj/structure/cable.html#var/powernet">powernet</a></th><td>The regional powernet this cable is registered to</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/structure/cable.html#proc/add_power_demand">add_power_demand</a></th><td>Adds power demand to the powernet, machines should use this</td></tr><tr><th><a href="obj/structure/cable.html#proc/add_queued_power_demand">add_queued_power_demand</a></th><td>Adds queued power demand to be met next process cycle, non_machines should use this</td></tr><tr><th><a href="obj/structure/cable.html#proc/get_available_power">get_available_power</a></th><td>Gets power available (NOT EXTRA) on this cables powernet, machines should use this, engines should add power to the net with this proc</td></tr><tr><th><a href="obj/structure/cable.html#proc/get_queued_available_power">get_queued_available_power</a></th><td>Gets available (NOT EXTRA) power queued for next process cycle on this cables powernet, non_machines should use this</td></tr><tr><th><a href="obj/structure/cable.html#proc/get_queued_surplus">get_queued_surplus</a></th><td>Gets surplus power queued for next process cycle on this cables powernet, non_machines should use this</td></tr><tr><th><a href="obj/structure/cable.html#proc/get_surplus">get_surplus</a></th><td>Gets surplus power available on this cables powernet, machines should use this</td></tr><tr><th><a href="obj/structure/cable.html#proc/hide">hide</a></th><td>If underfloor, hide the cable</td></tr><tr><th><a href="obj/structure/cable.html#proc/merge_connected_networks">merge_connected_networks</a></th><td>merge_connected_networks(), merge_connected_networks_on_turf(), and merge_diagonal_networks() all deal with merging
cables' powernets together</td></tr><tr><th><a href="obj/structure/cable.html#proc/shuttleRotate">shuttleRotate</a></th><td>Structure rotate procs</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/cable_coil_type"><aside class="declaration">var </aside>cable_coil_type <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/power/cables/cable.dm#L43"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable.dm 43"></a></h3><p>The type of cable coil you make when deconstructed</p><h3 id="var/connect_type"><aside class="declaration">var </aside>connect_type <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/power/cables/cable.dm#L47"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable.dm 47"></a></h3><p>Types of cables that can connect to this cable</p><h3 id="var/d1"><aside class="declaration">var </aside>d1 <aside>– /tmp</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/power/cables/cable.dm#L36"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable.dm 36"></a></h3><p>The direction of endpoint one of this cable</p><h3 id="var/d2"><aside class="declaration">var </aside>d2 <aside>– /tmp</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/power/cables/cable.dm#L38"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable.dm 38"></a></h3><p>The direction of enpoint two of this cable</p><h3 id="var/extra_insulated"><aside class="declaration">var </aside>extra_insulated <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/power/cables/cable.dm#L45"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable.dm 45"></a></h3><p>Whether the cable has additional insulation to prevent shocking on contact</p><h3 id="var/merge_id"><aside class="declaration">var </aside>merge_id <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/power/cables/cable.dm#L49"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable.dm 49"></a></h3><p>The types of cables that can merge with this cable</p><h3 id="var/powernet"><aside class="declaration">var </aside>powernet <aside>– /<a href="datum.html">datum</a>/<a href="datum/regional_powernet.html">regional_powernet</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/power/cables/cable.dm#L40"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable.dm 40"></a></h3><p>The regional powernet this cable is registered to</p><h2 id="proc">Proc Details</h2><h3 id="proc/add_power_demand"><aside class="declaration">proc </aside>add_power_demand<aside>(amount) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/power/cables/cable.dm#L201"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable.dm 201"></a></aside></h3><p>Adds power demand to the powernet, machines should use this</p><h3 id="proc/add_queued_power_demand"><aside class="declaration">proc </aside>add_queued_power_demand<aside>(amount) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/power/cables/cable.dm#L213"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable.dm 213"></a></aside></h3><p>Adds queued power demand to be met next process cycle, non_machines should use this</p><h3 id="proc/get_available_power"><aside class="declaration">proc </aside>get_available_power<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/power/cables/cable.dm#L209"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable.dm 209"></a></aside></h3><p>Gets power available (NOT EXTRA) on this cables powernet, machines should use this, engines should add power to the net with this proc</p><h3 id="proc/get_queued_available_power"><aside class="declaration">proc </aside>get_queued_available_power<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/power/cables/cable.dm#L221"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable.dm 221"></a></aside></h3><p>Gets available (NOT EXTRA) power queued for next process cycle on this cables powernet, non_machines should use this</p><h3 id="proc/get_queued_surplus"><aside class="declaration">proc </aside>get_queued_surplus<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/power/cables/cable.dm#L217"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable.dm 217"></a></aside></h3><p>Gets surplus power queued for next process cycle on this cables powernet, non_machines should use this</p><h3 id="proc/get_surplus"><aside class="declaration">proc </aside>get_surplus<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/power/cables/cable.dm#L205"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable.dm 205"></a></aside></h3><p>Gets surplus power available on this cables powernet, machines should use this</p><h3 id="proc/hide">hide<aside>(i) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/power/cables/cable.dm#L84"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable.dm 84"></a></aside></h3><p>If underfloor, hide the cable</p><h3 id="proc/merge_connected_networks"><aside class="declaration">proc </aside>merge_connected_networks<aside>(direction) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/power/cables/cable.dm#L238"><img src="git.png" width="16" height="16" title="code/modules/power/cables/cable.dm 238"></a></aside></h3><p>merge_connected_networks(), merge_connected_networks_on_turf(), and merge_diagonal_networks() all deal with merging
cables' powernets together</p><h3 id="proc/shuttleRotate"><aside class="parent"><a title="/atom" href="atom.html#proc/shuttleRotate">↑</a></aside>shuttleRotate<aside>(rotation, params) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/modules/shuttle/shuttle_rotate.dm#L57"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle_rotate.dm 57"></a></aside></h3><p>Structure rotate procs</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>
Reference in New Issue View Git Blame Copy Permalink