airlock

Vars
aiControlDisabled	If 1, AI control is disabled until the AI hacks back in and disables the lock. If 2, the AI has bypassed the lock. If -1, the control is enabled but the AI had bypassed it earlier, so if it is disabled again the AI would have no trouble getting back in.
air_tight	TRUE means density will be set as soon as the door begins to close
airlock_material	Material of inner filling; if its an airlock with glass, this should be set to "glass"
airlock_state	The current state of the airlock, used to construct the airlock overlays
assemblytype	The type of door frame to drop during deconstruction
backup_power_time	Paired with backup_power_timer. Records its remaining time when something happens to interrupt power regen
backup_power_timer	Timer id, active when we are actively waiting for the backup power to be restored
closeOtherId	Cyclelinking for airlocks that aren't on the same x or y coord as the target.
cycle_pump	Airlock pump that overrides airlock controlls when set up for cycling
delayed_close_requested	TRUE means the door will automatically close the next time it's opened.
door_area	Area the door is located in
engineering_override	Determines if engineers get access to this door on orange alert
external	Is this door external? E.g. does it lead to space? Shuttle docking systems bolt doors with this flag.
fill_state_suffix	For those airlocks you might want to have varying "fillings" for, without having to have an icon file per door with a different filling.
fire_active	If there is an active fire alarm in the door's area
greyscale_accent_color	For the airlocks that use a greyscale accent door color, set this color to the accent color you want it to be.
hackProof	If true, this door can't be hacked by the AI
has_environment_lights	Does this airlock emit a light?
lights	Bolt lights show by default
main_power_time	Paired with main_power_timer. Records its remaining time when something happens to interrupt power regen
main_power_timer	Timer id, active when we are actively waiting for the main power to be restored
normalspeed	Controls if the door closes quickly or not. FALSE = the door autocloses in 1.5 seconds, TRUE = 8 seconds - see autoclose_in()
note	Any papers pinned to the airlock
note_overlay_file	Used for papers and photos pinned to the airlock
previous_airlock	What airlock assembly mineral plating was applied to
seal	The seal on the airlock
secondsElectrified	How many seconds remain until the door is no longer electrified. -1/MACHINE_ELECTRIFIED_PERMANENT = permanently electrified until someone fixes it.
security_level	How much are wires secured
shockedby	Logging for door electrification.
Procs
allowed	Check for the three states of open access. Emergency, Unrestricted, and Engineering Override
beforeShuttleMove	Turf move procs
check_hacking	Performs basic checks to make sure we are still able to hack an airlock. If control is restored early through outside means, opens the airlock's control interface.
check_security_level	When the signal is received of a changed security level, check if it's orange.
finish_emag_act	Timer proc, called ~0.6 seconds after [emag_act]. Finishes the emag sequence by breaking the airlock, permanently locking it, and disabling power.
get_note_state	Returns a string representing the type of note pinned to this airlock Arguments:
get_wires	Generates the airlock's wire layout based on the current area the airlock resides in.
hack	Attemps to override airlocks that have the AI control wire disabled.
handle_backup_power	Call to update our backup power outage timer Will trigger a proper timer if we're actively restoring power, if not we'll dump the remaining time in a var on the airlock
handle_main_power	Call to update our main power outage timer Will trigger a proper timer if we're actively restoring power, if not we'll dump the remaining time in a var on the airlock
power_wires_changed	If our power wires have changed, then our backup/main power regen may have failed, so let's just check in yeah?
remaining_backup_outage	Returns the amount of time we have to wait before backup power comes back Assuming it was actively regenerating Returns 0 if it is active
remaining_main_outage	Returns the amount of time we have to wait before main power comes back Assuming it was actively regenerating Returns 0 if it is active
secure_close	Forces the airlock to close and bolt
secure_open	Forces the airlock to unbolt and open
set_emergency_exit	Set the airlock's emergency exit status arg: active TRUE/FALSE
should_try_removing_electronics	Returns if a crowbar would remove the airlock electronics
temp_emergency_exit	Make the airlock unrestricted as a temporary emergency exit.
try_remove_seal	Used when attempting to remove a seal from an airlock
try_to_force_door_open	Additional checks depending on what we want to happen to door (should we try and open it normally, or do we want this open at all costs?)
update_fire_status	Change the airlock's fire_active status, triggered by COMSIG_AREA_FIRE_CHANGED Activates fire status overlay and increases door speed.

Var Details

var
aiControlDisabled
–

If 1, AI control is disabled until the AI hacks back in and disables the lock. If 2, the AI has bypassed the lock. If -1, the control is enabled but the AI had bypassed it earlier, so if it is disabled again the AI would have no trouble getting back in.

var
air_tight
–

TRUE means density will be set as soon as the door begins to close

var
airlock_material
–

Material of inner filling; if its an airlock with glass, this should be set to "glass"

var
airlock_state
–

The current state of the airlock, used to construct the airlock overlays

var
assemblytype
–

The type of door frame to drop during deconstruction

var
backup_power_time
–

Paired with backup_power_timer. Records its remaining time when something happens to interrupt power regen

var
backup_power_timer
–

Timer id, active when we are actively waiting for the backup power to be restored

var
closeOtherId
–

Cyclelinking for airlocks that aren't on the same x or y coord as the target.

var
cycle_pump
– /obj/machinery/atmospherics/components/unary/airlock_pump

Airlock pump that overrides airlock controlls when set up for cycling

var
delayed_close_requested
–

TRUE means the door will automatically close the next time it's opened.

var
door_area
– /area

Area the door is located in

var
engineering_override
–

Determines if engineers get access to this door on orange alert

var
external
–

Is this door external? E.g. does it lead to space? Shuttle docking systems bolt doors with this flag.

var
fill_state_suffix
–

For those airlocks you might want to have varying "fillings" for, without having to have an icon file per door with a different filling.

var
fire_active
–

If there is an active fire alarm in the door's area

var
greyscale_accent_color
–

For the airlocks that use a greyscale accent door color, set this color to the accent color you want it to be.

var
hackProof
–

If true, this door can't be hacked by the AI

var
has_environment_lights
–

Does this airlock emit a light?

var
lights
–

Bolt lights show by default

var
main_power_time
–

Paired with main_power_timer. Records its remaining time when something happens to interrupt power regen

var
main_power_timer
–

Timer id, active when we are actively waiting for the main power to be restored

var
normalspeed
–

Controls if the door closes quickly or not. FALSE = the door autocloses in 1.5 seconds, TRUE = 8 seconds - see autoclose_in()

var
note
– /obj/item

Any papers pinned to the airlock

var
note_overlay_file
–

Used for papers and photos pinned to the airlock

var
previous_airlock
–

What airlock assembly mineral plating was applied to

var
seal
– /obj/item

The seal on the airlock

var
secondsElectrified
–

How many seconds remain until the door is no longer electrified. -1/MACHINE_ELECTRIFIED_PERMANENT = permanently electrified until someone fixes it.

var
security_level
–

How much are wires secured

var
shockedby
–

Logging for door electrification.

Proc Details

↑
allowed
(/mob/user)

Check for the three states of open access. Emergency, Unrestricted, and Engineering Override

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

Turf move procs

Area move procs

Machinery move procs

proc
check_hacking
(/mob/user, success_message)

Performs basic checks to make sure we are still able to hack an airlock. If control is restored early through outside means, opens the airlock's control interface.

↑
check_security_level
(/datum/source, level)

When the signal is received of a changed security level, check if it's orange.

proc
finish_emag_act
()

Timer proc, called ~0.6 seconds after [emag_act]. Finishes the emag sequence by breaking the airlock, permanently locking it, and disabling power.

proc
get_note_state
(frame_state)

Returns a string representing the type of note pinned to this airlock Arguments:

frame_state - The AIRLOCK_FRAME_ value, as used in update_overlays()

proc
get_wires
()

Generates the airlock's wire layout based on the current area the airlock resides in.

Returns a new /datum/wires/ with the appropriate wire layout based on the airlock_wires of the area the airlock is in.

proc
hack
(/mob/user)

Attemps to override airlocks that have the AI control wire disabled.

proc
handle_backup_power
()

Call to update our backup power outage timer Will trigger a proper timer if we're actively restoring power, if not we'll dump the remaining time in a var on the airlock

proc
handle_main_power
()

Call to update our main power outage timer Will trigger a proper timer if we're actively restoring power, if not we'll dump the remaining time in a var on the airlock

proc
power_wires_changed
(/datum/source, wire)

If our power wires have changed, then our backup/main power regen may have failed, so let's just check in yeah?

proc
remaining_backup_outage
()

Returns the amount of time we have to wait before backup power comes back Assuming it was actively regenerating Returns 0 if it is active

proc
remaining_main_outage
()

Returns the amount of time we have to wait before main power comes back Assuming it was actively regenerating Returns 0 if it is active

proc
secure_close
()

Forces the airlock to close and bolt

proc
secure_open
()

Forces the airlock to unbolt and open

proc
set_emergency_exit
(active)

Set the airlock's emergency exit status arg: active TRUE/FALSE

proc
should_try_removing_electronics
()

Returns if a crowbar would remove the airlock electronics

proc
temp_emergency_exit
(duration)

Make the airlock unrestricted as a temporary emergency exit.

Arguments:

duration - How long the door will operate as an emergency exit before reverting to normal operation

↑
try_remove_seal
(/mob/living/user)

Used when attempting to remove a seal from an airlock

Called when attacking an airlock with an empty hand, returns TRUE (there was a seal and we removed it, or failed to remove it) or FALSE (there was no seal) Arguments:

user - Whoever is attempting to remove the seal

↑
try_to_force_door_open
(force_type)

Additional checks depending on what we want to happen to door (should we try and open it normally, or do we want this open at all costs?)

proc
update_fire_status
(/datum/source, fire)

Change the airlock's fire_active status, triggered by COMSIG_AREA_FIRE_CHANGED Activates fire status overlay and increases door speed.

Arguments:

source - The /area with changed fire status
fire - the new fire status (TRUE/FALSE)

airlock /obj/machinery/door/airlock

Vars

Procs

Var Details

var aiControlDisabled –

var air_tight –

var airlock_material –

var airlock_state –

var assemblytype –

var backup_power_time –

var backup_power_timer –

var closeOtherId –

var cycle_pump – /obj/machinery/atmospherics/components/unary/airlock_pump

var delayed_close_requested –

var door_area – /area

var engineering_override –

var external –

var fill_state_suffix –

var fire_active –

var greyscale_accent_color –

var hackProof –

var has_environment_lights –

var lights –

var main_power_time –

var main_power_timer –

var normalspeed –

var note – /obj/item

var note_overlay_file –

var previous_airlock –

var seal – /obj/item

var secondsElectrified –

var security_level –

var shockedby –