sheepishgoat
1 line
9.2 KiB
HTML
1 line
9.2 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../"><link rel="stylesheet" href="dmdoc.css"><title>/obj/docking_port/mobile - /tg/ Station 13</title></head><body><header><a href="index.html">/tg/ Station 13</a> - <a href="index.html#modules">Modules</a> - <a href="index.html#types">Types</a> — <a href="obj/docking_port/mobile.html#var">Var Details</a> - <a href="obj/docking_port/mobile.html#proc">Proc Details</a></header><main><h1>mobile <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></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L334"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 334"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/docking_port/mobile.html#var/callTime">callTime</a></th><td>time spent in transit (deciseconds). Should not be lower then 10 seconds without editing the animation of the hyperspace ripples.</td></tr><tr><th><a href="obj/docking_port/mobile.html#var/can_move_docking_ports">can_move_docking_ports</a></th><td>if this shuttle can move docking ports other than the one it is docked at</td></tr><tr><th><a href="obj/docking_port/mobile.html#var/ignitionTime">ignitionTime</a></th><td>time spent "starting the engines". Also rate limits how often we try to reserve transit space if its ever full of transiting shuttles.</td></tr><tr><th><a href="obj/docking_port/mobile.html#var/mode">mode</a></th><td>current shuttle mode</td></tr><tr><th><a href="obj/docking_port/mobile.html#var/movement_force">movement_force</a></th><td>Whether or not you want your ship to knock people down, and also whether it will throw them several tiles upon launching.</td></tr><tr><th><a href="obj/docking_port/mobile.html#var/parallax_speed">parallax_speed</a></th><td>parallax speed in seconds per loop</td></tr><tr><th><a href="obj/docking_port/mobile.html#var/port_direction">port_direction</a></th><td>relative direction of the docking port from the front of the shuttle. NORTH is towards front, EAST would be starboard side, WEST port, etc.</td></tr><tr><th><a href="obj/docking_port/mobile.html#var/prearrivalTime">prearrivalTime</a></th><td>time spent after transit 'landing' before actually arriving</td></tr><tr><th><a href="obj/docking_port/mobile.html#var/preferred_direction">preferred_direction</a></th><td>The direction the shuttle prefers to travel in, ie what direction the animation will cause it to appear to be traveling in</td></tr><tr><th><a href="obj/docking_port/mobile.html#var/rechargeTime">rechargeTime</a></th><td>time spent after arrival before being able to begin ignition</td></tr><tr><th><a href="obj/docking_port/mobile.html#var/timer">timer</a></th><td>used as a timer (if you want time left to complete move, use timeLeft proc)</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/docking_port/mobile.html#proc/get_status_text_tgui">get_status_text_tgui</a></th><td>Gets shuttle location status in a form of string for tgui interfaces</td></tr><tr><th><a href="obj/docking_port/mobile.html#proc/initiate_docking">initiate_docking</a></th><td>This is the main proc. It instantly moves our mobile port to stationary port <code>new_dock</code>.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/callTime"><aside class="declaration">var </aside>callTime <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L348"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 348"></a></h3><p>time spent in transit (deciseconds). Should not be lower then 10 seconds without editing the animation of the hyperspace ripples.</p><h3 id="var/can_move_docking_ports"><aside class="declaration">var </aside>can_move_docking_ports <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L377"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 377"></a></h3><p>if this shuttle can move docking ports other than the one it is docked at</p><h3 id="var/ignitionTime"><aside class="declaration">var </aside>ignitionTime <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L350"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 350"></a></h3><p>time spent "starting the engines". Also rate limits how often we try to reserve transit space if its ever full of transiting shuttles.</p><h3 id="var/mode"><aside class="declaration">var </aside>mode <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L346"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 346"></a></h3><p>current shuttle mode</p><h3 id="var/movement_force"><aside class="declaration">var </aside>movement_force <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L369"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 369"></a></h3><p>Whether or not you want your ship to knock people down, and also whether it will throw them several tiles upon launching.</p><h3 id="var/parallax_speed"><aside class="declaration">var </aside>parallax_speed <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L381"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 381"></a></h3><p>parallax speed in seconds per loop</p><h3 id="var/port_direction"><aside class="declaration">var </aside>port_direction <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L359"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 359"></a></h3><p>relative direction of the docking port from the front of the shuttle. NORTH is towards front, EAST would be starboard side, WEST port, etc.</p><h3 id="var/prearrivalTime"><aside class="declaration">var </aside>prearrivalTime <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L354"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 354"></a></h3><p>time spent after transit 'landing' before actually arriving</p><h3 id="var/preferred_direction"><aside class="declaration">var </aside>preferred_direction <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L357"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 357"></a></h3><p>The direction the shuttle prefers to travel in, ie what direction the animation will cause it to appear to be traveling in</p><h3 id="var/rechargeTime"><aside class="declaration">var </aside>rechargeTime <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L352"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 352"></a></h3><p>time spent after arrival before being able to begin ignition</p><h3 id="var/timer"><aside class="declaration">var </aside>timer <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L343"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 343"></a></h3><p>used as a timer (if you want time left to complete move, use timeLeft proc)</p><h2 id="proc">Proc Details</h2><h3 id="proc/get_status_text_tgui"><aside class="declaration">proc </aside>get_status_text_tgui<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L822"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 822"></a></aside></h3><p>Gets shuttle location status in a form of string for tgui interfaces</p><h3 id="proc/initiate_docking"><aside class="declaration">proc </aside>initiate_docking<aside>(/<a href="obj.html">obj</a>/<a href="obj/docking_port.html">docking_port</a>/stationary/new_dock, movement_direction, force) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/docking.dm#L2"><img src="git.png" width="16" height="16" title="code/modules/shuttle/docking.dm 2"></a></aside></h3><p>This is the main proc. It instantly moves our mobile port to stationary port <code>new_dock</code>.</p></main><footer>tgstation.dme <a href="https://github.com/evilew/GS13-Citadel/tree/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e">e8e0068</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.9.0</a></footer></body></html> |