shuttle
![code/controllers/subsystem/shuttle.dm 3](git.png)
Vars | |
jump_completion_time | Time taken for a bluespace jump to complete after it initiates (in deciseconds) |
---|---|
jump_mode | Current state of the jump |
jump_request_time | Time taken for bluespace jump to begin after it is requested (in deciseconds) |
jump_timer | Timer ID of the timer used for telling which stage of an endround "jump" the ships are in |
lockdown | Stops ALL shuttles from being able to move |
mobile | List of all instantiated /obj/item/docking_port/mobile in existence |
ordernum | Order number given to next cargo order |
stationary | List of all instantiated /obj/item/docking_port/stationary in existence |
supplyBlocked | Whether express consoles are blocked from ordering anything or not |
supply_packs | List of all singleton supply pack instances |
transit | List of all instantiated /obj/item/docking_port/stationary/transit in existence |
transit_request_failures | Assoc list of an object that has attempted transit to the amount of times it has failed to do so |
transit_requesters | List of all shuttles queued for transit |
Procs | |
action_load | This proc loads a shuttle from a specified template. If no destination port is specified, the shuttle will be spawned at a generated transit doc. Doing this is how most ships are loaded. |
cancel_jump | Cancels a currently requested bluespace jump. Can only be done after the jump has been requested but before the jump has actually begun. |
initiate_jump | Initiates a bluespace jump, ending the round after a delay of jump_completion_time deciseconds. This cannot be interrupted by conventional means. |
load_template | This proc is THE proc that loads a shuttle from a specified template. Anything else should go through this in order to spawn a new shuttle. |
replace_shuttle | This proc replaces the given shuttle with a fresh new one spawned from a template. spawned at a generated transit doc. Doing this is how most ships are loaded. |
request_jump | Requests a bluespace jump, which, after jump_request_time deciseconds, will initiate a bluespace jump. |
Var Details
jump_completion_time
![code/controllers/subsystem/shuttle.dm 29](git.png)
Time taken for a bluespace jump to complete after it initiates (in deciseconds)
jump_mode
![code/controllers/subsystem/shuttle.dm 25](git.png)
Current state of the jump
jump_request_time
![code/controllers/subsystem/shuttle.dm 27](git.png)
Time taken for bluespace jump to begin after it is requested (in deciseconds)
jump_timer
![code/controllers/subsystem/shuttle.dm 23](git.png)
Timer ID of the timer used for telling which stage of an endround "jump" the ships are in
lockdown
![code/controllers/subsystem/shuttle.dm 39](git.png)
Stops ALL shuttles from being able to move
mobile
![code/controllers/subsystem/shuttle.dm 11](git.png)
List of all instantiated /obj/item/docking_port/mobile in existence
ordernum
![code/controllers/subsystem/shuttle.dm 34](git.png)
Order number given to next cargo order
stationary
![code/controllers/subsystem/shuttle.dm 13](git.png)
List of all instantiated /obj/item/docking_port/stationary in existence
supplyBlocked
![code/controllers/subsystem/shuttle.dm 32](git.png)
Whether express consoles are blocked from ordering anything or not
supply_packs
![code/controllers/subsystem/shuttle.dm 36](git.png)
List of all singleton supply pack instances
transit
![code/controllers/subsystem/shuttle.dm 15](git.png)
List of all instantiated /obj/item/docking_port/stationary/transit in existence
transit_request_failures
![code/controllers/subsystem/shuttle.dm 20](git.png)
Assoc list of an object that has attempted transit to the amount of times it has failed to do so
transit_requesters
![code/controllers/subsystem/shuttle.dm 18](git.png)
List of all shuttles queued for transit
Proc Details
action_load
This proc loads a shuttle from a specified template. If no destination port is specified, the shuttle will be spawned at a generated transit doc. Doing this is how most ships are loaded.
- loading_template - The shuttle map template to load. Can NOT be null.
- destination_port - The port the newly loaded shuttle will be sent to after being fully spawned in. If you want to have a transit dock be created, use [proc/load_template] instead. Should NOT be null.
cancel_jump
Cancels a currently requested bluespace jump. Can only be done after the jump has been requested but before the jump has actually begun.
initiate_jump
Initiates a bluespace jump, ending the round after a delay of jump_completion_time deciseconds. This cannot be interrupted by conventional means.
load_template
This proc is THE proc that loads a shuttle from a specified template. Anything else should go through this in order to spawn a new shuttle.
- template - The shuttle map template to load. Can NOT be null.
- spawn_transit - Whether or not to send the new shuttle to a newly-generated transit dock after loading.
replace_shuttle
This proc replaces the given shuttle with a fresh new one spawned from a template. spawned at a generated transit doc. Doing this is how most ships are loaded.
Hopefully this doesn't need to be used, it's a last resort for admin-coders at best, but I wanted to preserve the functionality of old action_load() in case it was needed.
- to_replace - The shuttle to replace. Should NOT be null.
- replacement - The shuttle map template to load in place of the old shuttle. Can NOT be null.
request_jump
Requests a bluespace jump, which, after jump_request_time deciseconds, will initiate a bluespace jump.