shuttle

Vars
admin_emergency_no_recall	Did admins force-prevent the recall of the shuttle?
arrivals	The mobile docking port of the arrivals shuttle.
assoc_mobile	Now it's only for ID generation in /obj/docking_port/mobile/register()
assoc_stationary	Now it's only for ID generation in /obj/docking_port/stationary/register()
backup_shuttle	The mobile docking port of the backup emergency shuttle.
beacon_list	A list of all the beacons that can be docked to.
centcom_message	Remarks from CentCom on how well you checked the last order.
chef_groceries	Queued supplies to be purchased for the chef.
custom_shuttles	A list of all the custom shuttles.
discovered_plants	Typepaths for unusual plants we've already sent CentCom, associated with their potencies.
emergency	Emergency shuttle stuff The mobile docking port of the emergency shuttle.
emergencyCallAmount	How many times was the escape shuttle called?
emergency_call_time	Time taken for emergency shuttle to reach the station when called (in deciseconds).
emergency_dock_time	Time taken for emergency shuttle to leave again once it has docked (in deciseconds).
emergency_escape_time	Time taken for emergency shuttle to reach a safe distance after leaving station (in deciseconds).
emergency_last_call_loc	Where was the emergency shuttle last called from?
emergency_no_escape	Is the departure of the shuttle currently prevented? FALSE for no, any other number for yes (thanks shuttle code).
emergency_no_recall	Do we prevent the recall of the shuttle?
existing_shuttle	The existing shuttle associated with the selected shuttle map_template.
express_consoles	List of express consoles that are waiting for pack initialization
has_purchase_shuttle_access	A list of job accesses that are able to purchase any shuttles.
hidden_shuttle_turf_images	Only the images from the /datum/controller/subsystem/shuttle/hidden_shuttle_turfs list.
hidden_shuttle_turfs	All turfs hidden from navigation computers associated with a list containing the image hiding them and the type of the turf they are pretending to be
hostile_environments	Things blocking escape shuttle from leaving.
last_call_time	Previous time left to the call, only useful for disabling and re-enabling the shuttle for admins so it doesn't have to start the whole timer again.
last_mode	Previous mode of the shuttle before it was forcefully disabled by admins.
lockdown	Disallow transit after nuke goes off
mobile_docking_ports	A list of all the mobile docking ports.
order_number	Order number given to next order.
points	Number of trade-points we have (basically money).
preview_reservation	The turf reservation for the current previewed shuttle.
preview_shuttle	The docking port associated to the preview_template that's currently being previewed.
preview_template	The shuttle map_template of the shuttle we want to preview.
request_list	Wishlist items made by crew for cargo to purchase at their leisure.
selected	The currently selected shuttle map_template in the shuttle manipulator's template viewer.
shopping_list	Queued supply packs to be purchased.
shuttle_insurance	If the event happens where the crew can purchase shuttle insurance, catastrophe can't run.
shuttle_loading	Are we currently in the process of loading a shuttle? Useful to ensure we don't load more than one at once, to avoid weird inconsistencies and possible runtimes.
shuttle_loan	The current shuttle loan event, if any.
shuttle_purchase_requirements_met	For keeping track of ingame events that would unlock new shuttles, such as defeating a boss or discovering a secret item.
stationary_docking_ports	A list of all the stationary docking ports.
supermatter_cascade	Did the supermatter start a cascade event?
supply	Supply shuttle stuff The current cargo shuttle's mobile docking port.
supply_blocked	Is the cargo shuttle currently blocked from leaving?
supply_packs	All of the possible supply packs that can be purchased by cargo.
trade_blockade	Things blocking the cargo shuttle from leaving.
transit_docking_ports	A list of all the transit docking ports.
transit_request_failures	An associative list of the mobile docking ports that have failed a transit request, with the amount of times they've actually failed that transit request, up to MAX_TRANSIT_REQUEST_RETRIES
transit_requesters	A list of all the mobile docking ports currently requesting a spot in hyperspace.
transit_utilized	How many turfs our shuttles are currently utilizing in reservation space
Procs
action_load	Loads a shuttle template and sends it to a given destination port, optionally replacing the existing shuttle
call_evac_shuttle	Call the emergency shuttle. If you are doing this on behalf of a player, use requestEvac instead. `signal_origin` is fluff occasionally provided to players.
canEvac	Check if we can call the evac shuttle. Returns TRUE if we can. Otherwise, returns a string detailing the problem.
load_template	Loads a shuttle template into the transit Z level, usually referred to elsewhere in the code as a shuttle preview. Does not register the shuttle so it can't be used yet, that's handled in action_load()
moveShuttle	Moves a shuttle to a new location
requestEvac	Calls the emergency shuttle.
transit_space_clearing	Gotta manage our space brother
unload_preview	Removes the preview_shuttle from the transit Z-level

Var Details

var
admin_emergency_no_recall

Did admins force-prevent the recall of the shuttle?

var
arrivals
– /obj/docking_port/mobile/arrivals

The mobile docking port of the arrivals shuttle.

var
assoc_mobile
– /list

Now it's only for ID generation in /obj/docking_port/mobile/register()

var
assoc_stationary
– /list

Now it's only for ID generation in /obj/docking_port/stationary/register()

var
backup_shuttle
– /obj/docking_port/mobile/emergency/backup

The mobile docking port of the backup emergency shuttle.

var
beacon_list
– /list

A list of all the beacons that can be docked to.

var
centcom_message

Remarks from CentCom on how well you checked the last order.

var
chef_groceries
– /list

Queued supplies to be purchased for the chef.

var
custom_shuttles
– /list

A list of all the custom shuttles.

var
discovered_plants
– /list

Typepaths for unusual plants we've already sent CentCom, associated with their potencies.

var
emergency
– /obj/docking_port/mobile/emergency

Emergency shuttle stuff The mobile docking port of the emergency shuttle.

var
emergencyCallAmount

How many times was the escape shuttle called?

var
emergency_call_time

Time taken for emergency shuttle to reach the station when called (in deciseconds).

var
emergency_dock_time

Time taken for emergency shuttle to leave again once it has docked (in deciseconds).

var
emergency_escape_time

Time taken for emergency shuttle to reach a safe distance after leaving station (in deciseconds).

var
emergency_last_call_loc
– /area

Where was the emergency shuttle last called from?

var
emergency_no_escape

Is the departure of the shuttle currently prevented? FALSE for no, any other number for yes (thanks shuttle code).

var
emergency_no_recall

Do we prevent the recall of the shuttle?

var
existing_shuttle
– /obj/docking_port/mobile

The existing shuttle associated with the selected shuttle map_template.

var
express_consoles
– /list/obj/machinery/computer/cargo/express

List of express consoles that are waiting for pack initialization

var
has_purchase_shuttle_access
– /list

A list of job accesses that are able to purchase any shuttles.

var
hidden_shuttle_turf_images
– /list

Only the images from the /datum/controller/subsystem/shuttle/hidden_shuttle_turfs list.

var
hidden_shuttle_turfs
– /list

All turfs hidden from navigation computers associated with a list containing the image hiding them and the type of the turf they are pretending to be

var
hostile_environments
– /list

Things blocking escape shuttle from leaving.

var
last_call_time

Previous time left to the call, only useful for disabling and re-enabling the shuttle for admins so it doesn't have to start the whole timer again.

var
last_mode

Previous mode of the shuttle before it was forcefully disabled by admins.

var
lockdown

Disallow transit after nuke goes off

var
mobile_docking_ports
– /list

A list of all the mobile docking ports.

var
order_number

Order number given to next order.

var
points

Number of trade-points we have (basically money).

var
preview_reservation
– /datum/turf_reservation

The turf reservation for the current previewed shuttle.

var
preview_shuttle
– /obj/docking_port/mobile

The docking port associated to the preview_template that's currently being previewed.

var
preview_template
– /datum/map_template/shuttle

The shuttle map_template of the shuttle we want to preview.

var
request_list
– /list

Wishlist items made by crew for cargo to purchase at their leisure.

var
selected
– /datum/map_template/shuttle

The currently selected shuttle map_template in the shuttle manipulator's template viewer.

var
shopping_list
– /list

Queued supply packs to be purchased.

var
shuttle_insurance

If the event happens where the crew can purchase shuttle insurance, catastrophe can't run.

var
shuttle_loading

Are we currently in the process of loading a shuttle? Useful to ensure we don't load more than one at once, to avoid weird inconsistencies and possible runtimes.

var
shuttle_loan
– /datum/round_event/shuttle_loan

The current shuttle loan event, if any.

var
shuttle_purchase_requirements_met
– /list

For keeping track of ingame events that would unlock new shuttles, such as defeating a boss or discovering a secret item.

var
stationary_docking_ports
– /list

A list of all the stationary docking ports.

var
supermatter_cascade

Did the supermatter start a cascade event?

var
supply
– /obj/docking_port/mobile/supply

Supply shuttle stuff The current cargo shuttle's mobile docking port.

var
supply_blocked

Is the cargo shuttle currently blocked from leaving?

var
supply_packs
– /list

All of the possible supply packs that can be purchased by cargo.

var
trade_blockade
– /list

Things blocking the cargo shuttle from leaving.

var
transit_docking_ports
– /list

A list of all the transit docking ports.

var
transit_request_failures
– /list

An associative list of the mobile docking ports that have failed a transit request, with the amount of times they've actually failed that transit request, up to MAX_TRANSIT_REQUEST_RETRIES

var
transit_requesters
– /list

A list of all the mobile docking ports currently requesting a spot in hyperspace.

var
transit_utilized

How many turfs our shuttles are currently utilizing in reservation space

Proc Details

proc
action_load
(/datum/map_template/shuttle/loading_template, /obj/docking_port/stationary/destination_port, replace)

Loads a shuttle template and sends it to a given destination port, optionally replacing the existing shuttle

Arguments:

loading_template - The shuttle template to load
destination_port - The station docking port to send the shuttle to once loaded
replace - Whether to replace the shuttle or create a new one

proc
call_evac_shuttle
(call_reason, signal_origin)

Call the emergency shuttle. If you are doing this on behalf of a player, use requestEvac instead. signal_origin is fluff occasionally provided to players.

proc
canEvac
()

Check if we can call the evac shuttle. Returns TRUE if we can. Otherwise, returns a string detailing the problem.

proc
load_template
(/datum/map_template/shuttle/loading_template)

Loads a shuttle template into the transit Z level, usually referred to elsewhere in the code as a shuttle preview. Does not register the shuttle so it can't be used yet, that's handled in action_load()

Arguments:

loading_template - The shuttle template to load

proc
moveShuttle
(shuttle_id, dock_id, timed)

Moves a shuttle to a new location

Arguments:

shuttle_id - The ID of the shuttle (mobile docking port) to move
dock_id - The ID of the destination (stationary docking port) to move to
timed - If true, have the shuttle follow normal spool-up, jump, dock process. If false, immediately move to the new location.

proc
requestEvac
(/mob/user, call_reason)

Calls the emergency shuttle.

Arguments:

user - The mob that called the shuttle.
call_reason - The reason the shuttle was called, which should be non-html-encoded text.

proc
transit_space_clearing
(/datum/turf_reservation/source)

Gotta manage our space brother

proc
unload_preview
()

Removes the preview_shuttle from the transit Z-level

shuttle /datum/controller/subsystem/shuttle

Vars

Procs

Var Details

var admin_emergency_no_recall

var arrivals – /obj/docking_port/mobile/arrivals

var assoc_mobile – /list

var assoc_stationary – /list

var backup_shuttle – /obj/docking_port/mobile/emergency/backup

var beacon_list – /list

var centcom_message

var chef_groceries – /list

var custom_shuttles – /list

var discovered_plants – /list

var emergency – /obj/docking_port/mobile/emergency

var emergencyCallAmount

var emergency_call_time

var emergency_dock_time

var emergency_escape_time

var emergency_last_call_loc – /area

var emergency_no_escape

var emergency_no_recall

var existing_shuttle – /obj/docking_port/mobile

var express_consoles – /list/obj/machinery/computer/cargo/express

var has_purchase_shuttle_access – /list

var hidden_shuttle_turf_images – /list

var hidden_shuttle_turfs – /list

var hostile_environments – /list

var last_call_time

var last_mode

var lockdown

var mobile_docking_ports – /list

var order_number

var points

var preview_reservation – /datum/turf_reservation

var preview_shuttle – /obj/docking_port/mobile

var preview_template – /datum/map_template/shuttle

var request_list – /list

var selected – /datum/map_template/shuttle

var shopping_list – /list

var shuttle_insurance

var shuttle_loading

var shuttle_loan – /datum/round_event/shuttle_loan

var shuttle_purchase_requirements_met – /list

var stationary_docking_ports – /list

var supermatter_cascade

var supply – /obj/docking_port/mobile/supply

var supply_blocked

var supply_packs – /list

var trade_blockade – /list

var transit_docking_ports – /list

var transit_request_failures – /list

var transit_requesters – /list

var transit_utilized

Proc Details

proc action_load(/datum/map_template/shuttle/loading_template, /obj/docking_port/stationary/destination_port, replace)

proc call_evac_shuttle(call_reason, signal_origin)

proc canEvac()

proc load_template(/datum/map_template/shuttle/loading_template)

proc moveShuttle(shuttle_id, dock_id, timed)

proc requestEvac(/mob/user, call_reason)

proc transit_space_clearing(/datum/turf_reservation/source)

proc unload_preview()

shuttle
/datum/controller/subsystem/shuttle

var
admin_emergency_no_recall

var
arrivals
– /obj/docking_port/mobile/arrivals

var
assoc_mobile
– /list

var
assoc_stationary
– /list

var
backup_shuttle
– /obj/docking_port/mobile/emergency/backup

var
beacon_list
– /list

var
centcom_message

var
chef_groceries
– /list

var
custom_shuttles
– /list

var
discovered_plants
– /list

var
emergency
– /obj/docking_port/mobile/emergency

var
emergencyCallAmount

var
emergency_call_time

var
emergency_dock_time

var
emergency_escape_time

var
emergency_last_call_loc
– /area

var
emergency_no_escape

var
emergency_no_recall

var
existing_shuttle
– /obj/docking_port/mobile

var
express_consoles
– /list/obj/machinery/computer/cargo/express

var
has_purchase_shuttle_access
– /list

var
hidden_shuttle_turf_images
– /list

var
hidden_shuttle_turfs
– /list

var
hostile_environments
– /list

var
last_call_time

var
last_mode

var
lockdown

var
mobile_docking_ports
– /list

var
order_number

var
points

var
preview_reservation
– /datum/turf_reservation

var
preview_shuttle
– /obj/docking_port/mobile

var
preview_template
– /datum/map_template/shuttle

var
request_list
– /list

var
selected
– /datum/map_template/shuttle

var
shopping_list
– /list

var
shuttle_insurance

var
shuttle_loading

var
shuttle_loan
– /datum/round_event/shuttle_loan

var
shuttle_purchase_requirements_met
– /list

var
stationary_docking_ports
– /list

var
supermatter_cascade

var
supply
– /obj/docking_port/mobile/supply

var
supply_blocked

var
supply_packs
– /list

var
trade_blockade
– /list

var
transit_docking_ports
– /list

var
transit_request_failures
– /list

var
transit_requesters
– /list

var
transit_utilized

proc
action_load
(/datum/map_template/shuttle/loading_template, /obj/docking_port/stationary/destination_port, replace)

proc
call_evac_shuttle
(call_reason, signal_origin)

proc
canEvac
()

proc
load_template
(/datum/map_template/shuttle/loading_template)

proc
moveShuttle
(shuttle_id, dock_id, timed)

proc
requestEvac
(/mob/user, call_reason)

proc
transit_space_clearing
(/datum/turf_reservation/source)

proc
unload_preview
()