Files

3 lines
11 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/controller/subsystem/shuttle - 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/controller/subsystem/shuttle.html#var">Var Details</a> - <a href="datum/controller/subsystem/shuttle.html#proc">Proc Details</a></header><main><h1>shuttle <aside>/<a href="datum.html">datum</a>/<a href="datum/controller.html">controller</a>/<a href="datum/controller/subsystem.html">subsystem</a>/<a href="datum/controller/subsystem/shuttle.html">shuttle</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSshuttles.dm#L10"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSshuttles.dm 10"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/controller/subsystem/shuttle.html#var/custom_escape_shuttle_loading">custom_escape_shuttle_loading</a></th><td>Whether or not a custom shuttle is currently loading at centcomm.</td></tr><tr><th><a href="datum/controller/subsystem/shuttle.html#var/custom_shuttle_ordered">custom_shuttle_ordered</a></th><td>Whether or not a custom shuttle has been ordered.</td></tr><tr><th><a href="datum/controller/subsystem/shuttle.html#var/emergency_locked_in">emergency_locked_in</a></th><td>Have we locked in the emergency shuttle, to prevent people from breaking things / wasting player money?</td></tr><tr><th><a href="datum/controller/subsystem/shuttle.html#var/hostile_environments">hostile_environments</a></th><td>Things blocking escape shuttle from leaving.</td></tr><tr><th><a href="datum/controller/subsystem/shuttle.html#var/mobile_docking_ports">mobile_docking_ports</a></th><td>A list of all the mobile docking ports.</td></tr><tr><th><a href="datum/controller/subsystem/shuttle.html#var/refuel_delay">refuel_delay</a></th><td>Default refuel delay</td></tr><tr><th><a href="datum/controller/subsystem/shuttle.html#var/shuttle_loan_UID">shuttle_loan_UID</a></th><td>The current shuttle loan event, if any.</td></tr><tr><th><a href="datum/controller/subsystem/shuttle.html#var/stationary_docking_ports">stationary_docking_ports</a></th><td>A list of all the stationary docking ports.</td></tr><tr><th><a href="datum/controller/subsystem/shuttle.html#var/supply_shuttle_turfs">supply_shuttle_turfs</a></th><td>Supply shuttle turfs to make mail be put down faster</td></tr><tr><th><a href="datum/controller/subsystem/shuttle.html#var/transit_docking_ports">transit_docking_ports</a></th><td>A list of all the transit docking ports.</td></tr><tr><th><a href="datum/controller/subsystem/shuttle.html#var/transit_request_failures">transit_request_failures</a></th><td>An associative list of the mobile docking ports that have failed a transit request, with the amount of times they've actually failed that transit request, up to MAX_TRANSIT_REQUEST_RETRIES</td></tr><tr><th><a href="datum/controller/subsystem/shuttle.html#var/transit_requesters">transit_requesters</a></th><td>A list of all the mobile docking ports currently requesting a spot in hyperspace.</td></tr><tr><th><a href="datum/controller/subsystem/shuttle.html#var/transit_utilized">transit_utilized</a></th><td>How many turfs our shuttles are currently utilizing in reservation space</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/controller/subsystem/shuttle.html#proc/load_template">load_template</a></th><td>Loads a shuttle from the template into a cordon. Returns its docking port if successful.</td></tr><tr><th><a href="datum/controller/subsystem/shuttle.html#proc/replace_shuttle">replace_shuttle</a></th><td>Create a new shuttle and replace the emergency shuttle with it.
if loaded shuttle is passed in, a new one will not be loaded.</td></tr><tr><th><a href="datum/controller/subsystem/shuttle.html#proc/transit_space_clearing">transit_space_clearing</a></th><td>Gotta manage our space brother</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/custom_escape_shuttle_loading"><aside class="declaration">var </aside>custom_escape_shuttle_loading <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSshuttles.dm#L53"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSshuttles.dm 53"></a></h3><p>Whether or not a custom shuttle is currently loading at centcomm.</p><h3 id="var/custom_shuttle_ordered"><aside class="declaration">var </aside>custom_shuttle_ordered <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSshuttles.dm#L50"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSshuttles.dm 50"></a></h3><p>Whether or not a custom shuttle has been ordered.</p><h3 id="var/emergency_locked_in"><aside class="declaration">var </aside>emergency_locked_in <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSshuttles.dm#L55"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSshuttles.dm 55"></a></h3><p>Have we locked in the emergency shuttle, to prevent people from breaking things / wasting player money?</p><h3 id="var/hostile_environments"><aside class="declaration">var </aside>hostile_environments <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSshuttles.dm#L33"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSshuttles.dm 33"></a></h3><p>Things blocking escape shuttle from leaving.</p><h3 id="var/mobile_docking_ports"><aside class="declaration">var </aside>mobile_docking_ports <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSshuttles.dm#L19"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSshuttles.dm 19"></a></h3><p>A list of all the mobile docking ports.</p><h3 id="var/refuel_delay"><aside class="declaration">var </aside>refuel_delay <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSshuttles.dm#L48"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSshuttles.dm 48"></a></h3><p>Default refuel delay</p><h3 id="var/shuttle_loan_UID"><aside class="declaration">var </aside>shuttle_loan_UID <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSshuttles.dm#L40"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSshuttles.dm 40"></a></h3><p>The current shuttle loan event, if any.</p><h3 id="var/stationary_docking_ports"><aside class="declaration">var </aside>stationary_docking_ports <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSshuttles.dm#L21"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSshuttles.dm 21"></a></h3><p>A list of all the stationary docking ports.</p><h3 id="var/supply_shuttle_turfs"><aside class="declaration">var </aside>supply_shuttle_turfs <aside> /static/list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSshuttles.dm#L38"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSshuttles.dm 38"></a></h3><p>Supply shuttle turfs to make mail be put down faster</p><h3 id="var/transit_docking_ports"><aside class="declaration">var </aside>transit_docking_ports <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSshuttles.dm#L23"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSshuttles.dm 23"></a></h3><p>A list of all the transit docking ports.</p><h3 id="var/transit_request_failures"><aside class="declaration">var </aside>transit_request_failures <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSshuttles.dm#L60"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSshuttles.dm 60"></a></h3><p>An associative list of the mobile docking ports that have failed a transit request, with the amount of times they've actually failed that transit request, up to MAX_TRANSIT_REQUEST_RETRIES</p><h3 id="var/transit_requesters"><aside class="declaration">var </aside>transit_requesters <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSshuttles.dm#L58"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSshuttles.dm 58"></a></h3><p>A list of all the mobile docking ports currently requesting a spot in hyperspace.</p><h3 id="var/transit_utilized"><aside class="declaration">var </aside>transit_utilized <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSshuttles.dm#L62"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSshuttles.dm 62"></a></h3><p>How many turfs our shuttles are currently utilizing in reservation space</p><h2 id="proc">Proc Details</h2><h3 id="proc/load_template"><aside class="declaration">proc </aside>load_template<aside>(/<a href="datum.html">datum</a>/<a href="datum/map_template.html">map_template</a>/shuttle/template) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSshuttles.dm#L355"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSshuttles.dm 355"></a></aside></h3><p>Loads a shuttle from the template into a cordon. Returns its docking port if successful.</p><h3 id="proc/replace_shuttle"><aside class="declaration">proc </aside>replace_shuttle<aside>(/<a href="obj.html">obj</a>/<a href="obj/docking_port.html">docking_port</a>/<a href="obj/docking_port/mobile.html">mobile</a>/loaded_shuttle) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSshuttles.dm#L379"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSshuttles.dm 379"></a></aside></h3><p>Create a new shuttle and replace the emergency shuttle with it.
if loaded shuttle is passed in, a new one will not be loaded.</p><h3 id="proc/transit_space_clearing"><aside class="declaration">proc </aside>transit_space_clearing<aside>(/<a href="datum.html">datum</a>/<a href="datum/turf_reservation.html">turf_reservation</a>/source) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/controllers/subsystem/SSshuttles.dm#L570"><img src="git.png" width="16" height="16" title="code/controllers/subsystem/SSshuttles.dm 570"></a></aside></h3><p>Gotta manage our space brother</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>