Yogstation 13 - Modules - TypesVar Details - Proc Details

/obj/docking_port

Vars

delete_afterDelete this port after ship fly off.
dheightposition relative to covered area, parallel to dir. You shouldn't modify this for mobile dockingports, set automatically.
dirCommon standard is for this to point -away- from the dockingport door, ie towards the ship
dwidthposition relative to covered area, perpendicular to dir. You shouldn't modify this for mobile dockingports, set automatically.
heightsize of covered area, parallel to dir. You shouldn't modify this for mobile dockingports, set automatically.
hiddenare we invisible to shuttle navigation computers?
port_destinationsPossible destinations
registeredare we registered in SSshuttles?
shuttle_idThe 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.
widthsize of covered area, perpendicular to dir. You shouldn't modify this for mobile dockingports, set automatically.

Procs

registerregister to SSshuttles
return_coordsreturns a list(x0,y0, x1,y1) where points 0 and 1 are bounding corners of the projected rectangle
return_ordered_turfsreturns turfs within our projected rectangle in a specific order.this ensures that turfs are copied over in the same order, regardless of any rotation
unregisterunregister from SSshuttles

Var Details

delete_after

Delete this port after ship fly off.

dheight

position relative to covered area, parallel to dir. You shouldn't modify this for mobile dockingports, set automatically.

dir

Common standard is for this to point -away- from the dockingport door, ie towards the ship

dwidth

position relative to covered area, perpendicular to dir. You shouldn't modify this for mobile dockingports, set automatically.

height

size of covered area, parallel to dir. You shouldn't modify this for mobile dockingports, set automatically.

hidden

are we invisible to shuttle navigation computers?

port_destinations

Possible destinations

registered

are we registered in SSshuttles?

shuttle_id

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.

width

size of covered area, perpendicular to dir. You shouldn't modify this for mobile dockingports, set automatically.

Proc Details

register

register to SSshuttles

return_coords

returns a list(x0,y0, x1,y1) where points 0 and 1 are bounding corners of the projected rectangle

return_ordered_turfs

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

unregister

unregister from SSshuttles