mobile

Vars
alert_coeff	Speed multiplier based on station alert level
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_engine_power	How much engine power (thrust) the shuttle currently has.
engine_coeff	How fast the shuttle should be, taking engine thrust into account.
engine_list	List of all currently used engines that propels us.
event_list	List of shuttle events that can run or are running
ignitionTime	time spent "starting the engines". Also rate limits how often we try to reserve transit space if its ever full of transiting shuttles.
initial_engine_power	How much engine power (thrust) the shuttle starts with at mapload.
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
shuttle_areas	List of all areas our shuttle holds.
timer	used as a timer (if you want time left to complete move, use timeLeft proc)
Procs
announce_shuttle_events	Let people know shits about to go down
beforeShuttleMove	Misc move procs
calculate_docking_port_information	Calculated and populates the information used for docking and some internal vars. This can also be used to calculate from shuttle_areas so that you can expand/shrink shuttles!
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`.
intoTheSunset	Ghosts and marks as escaped (for greentext purposes) all mobs, then deletes the shuttle. Used by the Shuttle Manipulator
postregister	Actions to be taken after shuttle is loaded and has been moved to its final location
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
process_events	Process all the shuttle events for every shuttle tick we get
register	Actions to be taken after shuttle is loaded but before it has been moved out of transit z-level to its final location
request	Calls the shuttle to the destination port, respecting its ignition and call timers

Var Details

var
alert_coeff
–

Speed multiplier based on station alert level

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_engine_power
–

How much engine power (thrust) the shuttle currently has.

var
engine_coeff
–

How fast the shuttle should be, taking engine thrust into account.

var
engine_list
– /list/obj/machinery/power/shuttle_engine

List of all currently used engines that propels us.

var
event_list
– /list/datum/shuttle_event

List of shuttle events that can run or are running

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
initial_engine_power
–

How much engine power (thrust) the shuttle starts with at mapload.

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
shuttle_areas
– /list

List of all areas our shuttle holds.

var
timer
–

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

Proc Details

proc
announce_shuttle_events
()

Let people know shits about to go down

beforeShuttleMove
(/turf/newT, rotation, move_mode, /obj/docking_port/mobile/moving_dock)

Misc move procs

proc
calculate_docking_port_information
(/datum/map_template/shuttle/loading_from)

Calculated and populates the information used for docking and some internal vars. This can also be used to calculate from shuttle_areas so that you can expand/shrink shuttles!

Arguments:

loading_from - The template that the shuttle was loaded from, if not given we iterate shuttle_areas to calculate information instead

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
intoTheSunset
()

Ghosts and marks as escaped (for greentext purposes) all mobs, then deletes the shuttle. Used by the Shuttle Manipulator

proc
postregister
(replace)

Actions to be taken after shuttle is loaded and has been moved to its final location

Arguments:

replace - TRUE if this shuttle is replacing an existing one. FALSE by default.

proc
preflight_check
(/list/old_turfs, /list/new_turfs, /list/areas_to_move, rotation)

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

proc
process_events
()

Process all the shuttle events for every shuttle tick we get

↑
register
(replace)

Actions to be taken after shuttle is loaded but before it has been moved out of transit z-level to its final location

Arguments:

replace - TRUE if this shuttle is replacing an existing one. FALSE by default.

proc
request
(/obj/docking_port/stationary/destination_port)

Calls the shuttle to the destination port, respecting its ignition and call timers

Arguments:

destination_port - Stationary docking port to move the shuttle to

mobile /obj/docking_port/mobile

Vars

Procs

Var Details

var alert_coeff –

var callTime –

var can_move_docking_ports –

var current_engine_power –

var engine_coeff –

var engine_list – /list/obj/machinery/power/shuttle_engine

var event_list – /list/datum/shuttle_event

var ignitionTime –

var initial_engine_power –

var mode –

var movement_force – /list

var port_direction –

var prearrivalTime –

var preferred_direction –

var rechargeTime –

var shuttle_areas – /list

var timer –

Proc Details

proc announce_shuttle_events()

beforeShuttleMove(/turf/newT, rotation, move_mode, /obj/docking_port/mobile/moving_dock)

proc calculate_docking_port_information(/datum/map_template/shuttle/loading_from)

proc get_status_text_tgui()

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

proc intoTheSunset()

proc postregister(replace)

proc preflight_check(/list/old_turfs, /list/new_turfs, /list/areas_to_move, rotation)

proc process_events()

↑register(replace)

proc request(/obj/docking_port/stationary/destination_port)

mobile
/obj/docking_port/mobile

var
alert_coeff
–

var
callTime
–

var
can_move_docking_ports
–

var
current_engine_power
–

var
engine_coeff
–

var
engine_list
– /list/obj/machinery/power/shuttle_engine

var
event_list
– /list/datum/shuttle_event

var
ignitionTime
–

var
initial_engine_power
–

var
mode
–

var
movement_force
– /list

var
port_direction
–

var
prearrivalTime
–

var
preferred_direction
–

var
rechargeTime
–

var
shuttle_areas
– /list

var
timer
–

proc
announce_shuttle_events
()

beforeShuttleMove
(/turf/newT, rotation, move_mode, /obj/docking_port/mobile/moving_dock)

proc
calculate_docking_port_information
(/datum/map_template/shuttle/loading_from)

proc
get_status_text_tgui
()

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

proc
intoTheSunset
()

proc
postregister
(replace)

proc
preflight_check
(/list/old_turfs, /list/new_turfs, /list/areas_to_move, rotation)

proc
process_events
()

↑
register
(replace)

proc
request
(/obj/docking_port/stationary/destination_port)