White Sands - Modules - TypesVar Details - Proc Details

shuttle

Vars

callTimetime spent in transit (deciseconds). Should not be lower then 10 seconds without editing the animation of the hyperspace ripples.
can_move_docking_portsif this shuttle can move docking ports other than the one it is docked at
current_shipThe linked overmap object, if there is one
ignitionTimetime spent "starting the engines". Also rate limits how often we try to reserve transit space if its ever full of transiting shuttles.
modecurrent shuttle mode
movement_forceWhether or not you want your ship to knock people down, and also whether it will throw them several tiles upon launching.
port_directionrelative direction of the docking port from the front of the shuttle NORTH is towards front, EAST would be starboard side, WEST port, etc.
prearrivalTimetime spent after transit 'landing' before actually arriving
preferred_directionThe direction the shuttle prefers to travel in, ie what direction the animation will cause it to appear to be traveling in
rechargeTimetime spent after arrival before being able to begin ignition
timerused as a timer (if you want time left to complete move, use timeLeft proc)

Procs

get_status_text_tguiGets shuttle location status in a form of string for tgui interfaces
initiate_dockingThis is the main proc. It instantly moves our mobile port to stationary port new_dock.
preflight_checkBoth lists are associative with a turf:bitflag structure. (new_turfs bitflag space unused currently) The bitflag contains the data for what inhabitants of that coordinate should be moved to the new location The bitflags can be found in __DEFINES/shuttles.dm

Var Details

callTime

time spent in transit (deciseconds). Should not be lower then 10 seconds without editing the animation of the hyperspace ripples.

can_move_docking_ports

if this shuttle can move docking ports other than the one it is docked at

current_ship

The linked overmap object, if there is one

ignitionTime

time spent "starting the engines". Also rate limits how often we try to reserve transit space if its ever full of transiting shuttles.

mode

current shuttle mode

movement_force

Whether or not you want your ship to knock people down, and also whether it will throw them several tiles upon launching.

port_direction

relative direction of the docking port from the front of the shuttle NORTH is towards front, EAST would be starboard side, WEST port, etc.

prearrivalTime

time spent after transit 'landing' before actually arriving

preferred_direction

The direction the shuttle prefers to travel in, ie what direction the animation will cause it to appear to be traveling in

rechargeTime

time spent after arrival before being able to begin ignition

timer

used as a timer (if you want time left to complete move, use timeLeft proc)

Proc Details

get_status_text_tgui

Gets shuttle location status in a form of string for tgui interfaces

initiate_docking

This is the main proc. It instantly moves our mobile port to stationary port new_dock.

preflight_check

Both lists are associative with a turf:bitflag structure. (new_turfs bitflag space unused currently) The bitflag contains the data for what inhabitants of that coordinate should be moved to the new location The bitflags can be found in __DEFINES/shuttles.dm

Hiding turfs if necessary

Unhiding turfs if necessary