White Sands - Modules - TypesVar Details - Proc Details

/obj/structure/overmap/ship/simulated

Simulated overmap ship

A ship that corresponds to an actual, physical shuttle. Can be docked to any other overmap object with a corresponding docking port and/or zlevel. SUPPOSED to be linked to the corresponding shuttle's mobile docking port, but you never know do you

Vars

avg_fuel_amntAverage fuel fullness percentage
dock_change_start_timeThe time the shuttle started launching
dockedThe overmap object the ship is docked to, if any
est_thrustVessel estimated thrust
massVessel approximate mass
repair_timerThe timer ID of the repair timer.
shuttleThe docking port of the linked shuttle
stateState of the shuttle: idle, flying, docking, or undocking

Procs

burn_enginesBurns the engines in one direction, accelerating in that direction. If no dir variable is provided, it decelerates the vessel.
calculate_avg_fuelCalculates the average fuel fullness of all engines.
calculate_massCalculates the mass based on the amount of turfs in the shuttle's areas
check_locProc called after a shuttle is moved, used for checking a ship's location when it's moved manually (E.G. calling the mining shuttle via a console)
complete_dockCalled after the shuttle docks, and finishes the transfer to the new location.
dockDocks the shuttle by requesting a port at the requested spot.
overmap_object_actActs on the specified option. Used for docking.
recieve_damageDestroy if integrity <= 0 and no concious mobs on shuttle
refresh_enginesJust double checks all the engines on the shuttle
repairHandles repairs. Called by a repeating timer that is created when the ship docks.
undockUndocks the shuttle by launching the shuttle with no destination (this causes it to remain in transit)

Var Details

avg_fuel_amnt

Average fuel fullness percentage

dock_change_start_time

The time the shuttle started launching

docked

The overmap object the ship is docked to, if any

est_thrust

Vessel estimated thrust

mass

Vessel approximate mass

repair_timer

The timer ID of the repair timer.

shuttle

The docking port of the linked shuttle

state

State of the shuttle: idle, flying, docking, or undocking

Proc Details

burn_engines

Burns the engines in one direction, accelerating in that direction. If no dir variable is provided, it decelerates the vessel.

calculate_avg_fuel

Calculates the average fuel fullness of all engines.

calculate_mass

Calculates the mass based on the amount of turfs in the shuttle's areas

check_loc

Proc called after a shuttle is moved, used for checking a ship's location when it's moved manually (E.G. calling the mining shuttle via a console)

complete_dock

Called after the shuttle docks, and finishes the transfer to the new location.

dock

Docks the shuttle by requesting a port at the requested spot.

overmap_object_act

Acts on the specified option. Used for docking.

recieve_damage

Destroy if integrity <= 0 and no concious mobs on shuttle

refresh_engines

Just double checks all the engines on the shuttle

repair

Handles repairs. Called by a repeating timer that is created when the ship docks.

undock

Undocks the shuttle by launching the shuttle with no destination (this causes it to remain in transit)