mobile

Vars
assigned_transit	The transit dock assigned exclusively to this shuttle.
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
docking_points	List of all stationary docking ports that spawned on the ship roundstart, used for docking to other ships.
engine_list	A list of all engines currently linked to the shuttle.
gravgen_list	A list of all gravity generators currently linked to the shuttle.
ignitionTime	time spent "starting the engines". Also rate limits how often we try to reserve transit space if its ever full of transiting shuttles.
landing_sound	The landing sound to be played
launch_sound	The launch sound to be played
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
ripples	List of all the ripple effects made at this shuttle's future docking location.
shuttle_areas	All currently linked areas that will be moved when the shuttle (un)docks
shuttle_sounds	Does this shuttle play sounds upon landing and takeoff?
sound_range	The sound range coeff for the landing and take off sound effects
spawn_points	List of spawn points on the ship
takeoff_sound	The take off sound to be played
timer	used as a timer (if you want time left to complete move, use timeLeft proc)
turf_count	The amount of turfs the shuttle is made up of (closed and open, doesn't include lattices)
Procs
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`.
throw_exception	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

Var Details

var
assigned_transit
– /obj/docking_port/stationary/transit

The transit dock assigned exclusively to this shuttle.

var
callTime
–

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

var
can_move_docking_ports
–

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

var
current_ship
– /datum/overmap/ship/controlled

The linked overmap object, if there is one

var
docking_points
– /list/obj/docking_port/stationary

List of all stationary docking ports that spawned on the ship roundstart, used for docking to other ships.

var
engine_list
– /list

A list of all engines currently linked to the shuttle.

var
gravgen_list
– /list

A list of all gravity generators currently linked to the shuttle.

var
ignitionTime
–

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

var
landing_sound
–

The landing sound to be played

var
launch_sound
–

The launch sound to be played

var
mode
–

current shuttle mode

var
movement_force
– /list

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

var
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.

var
prearrivalTime
–

time spent after transit 'landing' before actually arriving

var
preferred_direction
–

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

var
rechargeTime
–

time spent after arrival before being able to begin ignition

var
ripples
– /list

List of all the ripple effects made at this shuttle's future docking location.

var
shuttle_areas
– /list

All currently linked areas that will be moved when the shuttle (un)docks

var
shuttle_sounds
–

Does this shuttle play sounds upon landing and takeoff?

var
sound_range
–

The sound range coeff for the landing and take off sound effects

var
spawn_points
– /list/atom

List of spawn points on the ship

var
takeoff_sound
–

The take off sound to be played

var
timer
–

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

var
turf_count
–

The amount of turfs the shuttle is made up of (closed and open, doesn't include lattices)

Proc Details

proc
get_status_text_tgui
()

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

proc
initiate_docking
(/obj/docking_port/stationary/new_dock, movement_direction, force)

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

proc
throw_exception
(/exception/e)

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

mobile /obj/docking_port/mobile

Vars

Procs

Var Details

var assigned_transit – /obj/docking_port/stationary/transit

var callTime –

var can_move_docking_ports –

var current_ship – /datum/overmap/ship/controlled

var docking_points – /list/obj/docking_port/stationary

var engine_list – /list

var gravgen_list – /list

var ignitionTime –

var landing_sound –

var launch_sound –

var mode –

var movement_force – /list

var port_direction –

var prearrivalTime –

var preferred_direction –

var rechargeTime –

var ripples – /list

var shuttle_areas – /list

var shuttle_sounds –

var sound_range –

var spawn_points – /list/atom

var takeoff_sound –

var timer –

var turf_count –