7 lines
9.8 KiB
HTML
7 lines
9.8 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/obj/docking_port - /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.html#var">Var Details</a> - <a href="obj/docking_port.html#proc">Proc Details</a></header><main><h1>docking_port <aside>/<a href="obj.html">obj</a>/<a href="obj/docking_port.html">docking_port</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L7"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 7"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/docking_port.html#var/delete_after">delete_after</a></th><td>Delete this port after ship fly off.</td></tr><tr><th><a href="obj/docking_port.html#var/dheight">dheight</a></th><td>position relative to covered area, parallel to dir. You shouldn't modify this for mobile dockingports, set automatically.</td></tr><tr><th><a href="obj/docking_port.html#var/dir">dir</a></th><td>Common standard is for this to point -away- from the dockingport door, ie towards the ship</td></tr><tr><th><a href="obj/docking_port.html#var/dwidth">dwidth</a></th><td>position relative to covered area, perpendicular to dir. You shouldn't modify this for mobile dockingports, set automatically.</td></tr><tr><th><a href="obj/docking_port.html#var/height">height</a></th><td>size of covered area, parallel to dir. You shouldn't modify this for mobile dockingports, set automatically.</td></tr><tr><th><a href="obj/docking_port.html#var/hidden">hidden</a></th><td>are we invisible to shuttle navigation computers?</td></tr><tr><th><a href="obj/docking_port.html#var/port_destinations">port_destinations</a></th><td>Possible destinations</td></tr><tr><th><a href="obj/docking_port.html#var/registered">registered</a></th><td>are we registered in SSshuttles?</td></tr><tr><th><a href="obj/docking_port.html#var/shuttle_id">shuttle_id</a></th><td>The identifier of the port or ship.
|
||
This will be used in numerous other places like the console,
|
||
stationary ports and whatnot to tell them your ship's mobile
|
||
port can be used in these places, or the docking port is compatible, etc.</td></tr><tr><th><a href="obj/docking_port.html#var/width">width</a></th><td>size of covered area, perpendicular to dir. You shouldn't modify this for mobile dockingports, set automatically.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/docking_port.html#proc/register">register</a></th><td>register to SSshuttles</td></tr><tr><th><a href="obj/docking_port.html#proc/return_coords">return_coords</a></th><td>returns a list(x0,y0, x1,y1) where points 0 and 1 are bounding corners of the projected rectangle</td></tr><tr><th><a href="obj/docking_port.html#proc/return_ordered_turfs">return_ordered_turfs</a></th><td>returns turfs within our projected rectangle in a specific order.this ensures that turfs are copied over in the same order, regardless of any rotation</td></tr><tr><th><a href="obj/docking_port.html#proc/return_turfs">return_turfs</a></th><td>returns turfs within our projected rectangle in no particular order</td></tr><tr><th><a href="obj/docking_port.html#proc/unregister">unregister</a></th><td>unregister from SSshuttles</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/delete_after"><aside class="declaration">var </aside>delete_after <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L37"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 37"></a></h3><p>Delete this port after ship fly off.</p><h3 id="var/dheight"><aside class="declaration">var </aside>dheight <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L30"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 30"></a></h3><p>position relative to covered area, parallel to dir. You shouldn't modify this for mobile dockingports, set automatically.</p><h3 id="var/dir">dir <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L22"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 22"></a></h3><p>Common standard is for this to point -away- from the dockingport door, ie towards the ship</p><h3 id="var/dwidth"><aside class="declaration">var </aside>dwidth <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L28"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 28"></a></h3><p>position relative to covered area, perpendicular to dir. You shouldn't modify this for mobile dockingports, set automatically.</p><h3 id="var/height"><aside class="declaration">var </aside>height <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L26"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 26"></a></h3><p>size of covered area, parallel to dir. You shouldn't modify this for mobile dockingports, set automatically.</p><h3 id="var/hidden"><aside class="declaration">var </aside>hidden <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L34"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 34"></a></h3><p>are we invisible to shuttle navigation computers?</p><h3 id="var/port_destinations"><aside class="declaration">var </aside>port_destinations <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L20"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 20"></a></h3><p>Possible destinations</p><h3 id="var/registered"><aside class="declaration">var </aside>registered <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L40"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 40"></a></h3><p>are we registered in SSshuttles?</p><h3 id="var/shuttle_id"><aside class="declaration">var </aside>shuttle_id <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L18"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 18"></a></h3><p>The identifier of the port or ship.
|
||
This will be used in numerous other places like the console,
|
||
stationary ports and whatnot to tell them your ship's mobile
|
||
port can be used in these places, or the docking port is compatible, etc.</p><h3 id="var/width"><aside class="declaration">var </aside>width <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L24"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 24"></a></h3><p>size of covered area, perpendicular to dir. You shouldn't modify this for mobile dockingports, set automatically.</p><h2 id="proc">Proc Details</h2><h3 id="proc/register"><aside class="declaration">proc </aside>register<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L43"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 43"></a></aside></h3><p>register to SSshuttles</p><h3 id="proc/return_coords"><aside class="declaration">proc </aside>return_coords<aside>(_x, _y, _dir) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L84"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 84"></a></aside></h3><p>returns a list(x0,y0, x1,y1) where points 0 and 1 are bounding corners of the projected rectangle</p><h3 id="proc/return_ordered_turfs"><aside class="declaration">proc </aside>return_ordered_turfs<aside>(_x, _y, _z, _dir) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L121"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 121"></a></aside></h3><p>returns turfs within our projected rectangle in a specific order.this ensures that turfs are copied over in the same order, regardless of any rotation</p><h3 id="proc/return_turfs"><aside class="declaration">proc </aside>return_turfs<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L114"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 114"></a></aside></h3><p>returns turfs within our projected rectangle in no particular order</p><h3 id="proc/unregister"><aside class="declaration">proc </aside>unregister<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/shuttle/shuttle.dm#L51"><img src="git.png" width="16" height="16" title="code/modules/shuttle/shuttle.dm 51"></a></aside></h3><p>unregister from SSshuttles</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> |