firedoor

Vars
active	Is this firelock active/closed?
affecting_areas	List of areas we handle. See CalculateAffectingAreas()
alarm_type	Type of alarm we're under. See code/defines/firealarm.dm for the list. This var being null means there is no alarm.
assemblytype	The type of door frame to drop during deconstruction
being_held_open	Tracks if the firelock is being held open by a crowbar. If so, we don't close until they walk away
ignore_alarms	Should the firelock ignore atmosphere when choosing to stay open/closed?
is_playing_alarm	Keeps track of if we're playing the alarm sound loop (as only one firelock per group should be). Used during power changes.
issue_turfs	List of problem turfs with bad temperature
light_xoffset	X offset for the overlay lights, so that they line up with the thin border firelocks
light_yoffset	Y offset for the overlay lights, so that they line up with the thin border firelocks
merger_id	The merger_id and merger_typecache variables are used to make rows of firelocks activate at the same time.
my_area	For the few times we affect only the area we're actually in. Set during Init. If we get moved, we don't update, but this is consistant with fire alarms and also kinda funny so call it intentional.
soundloop	looping sound datum for our fire alarm siren.
warn_lights	Overlay object for the warning lights. This and some plane settings allows the lights to glow in the dark.
Procs
CalculateAffectingAreas	Calculates what areas we should worry about.
activate	Proc that handles activation of the firelock and all this details
add_as_source	Adds this fire door as a source of trouble to all of its areas
adjust_lights_starting_offset	Sets the offset for the warning lights.
correct_state	Corrects the current state of the door, based on its activity.
crack_open	Open the firedoor without resetting existing alarms
release_constraints	Reset our temporary alarm ignoring Consider if we should close ourselves/our neighbors or not
remove_as_source	Removes this firedoor from all areas it's serving as a source of problems for
reset	Proc that handles reset steps
start_activation_process	Begins activation process of us and our neighbors.
start_deactivation_process	Begins deactivation process of us and our neighbors.
try_to_crowbar	We check for adjacency when using the primary attack.
try_to_crowbar_secondary	A simple toggle for firedoors between on and off

Var Details

var
active
–

Is this firelock active/closed?

var
affecting_areas
– /list

List of areas we handle. See CalculateAffectingAreas()

var
alarm_type
–

Type of alarm we're under. See code/defines/firealarm.dm for the list. This var being null means there is no alarm.

var
assemblytype
–

The type of door frame to drop during deconstruction

var
being_held_open
–

Tracks if the firelock is being held open by a crowbar. If so, we don't close until they walk away

var
ignore_alarms
–

Should the firelock ignore atmosphere when choosing to stay open/closed?

var
is_playing_alarm
–

Keeps track of if we're playing the alarm sound loop (as only one firelock per group should be). Used during power changes.

var
issue_turfs
– /list/turf

List of problem turfs with bad temperature

var
light_xoffset
–

X offset for the overlay lights, so that they line up with the thin border firelocks

var
light_yoffset
–

Y offset for the overlay lights, so that they line up with the thin border firelocks

var
merger_id
–

The merger_id and merger_typecache variables are used to make rows of firelocks activate at the same time.

var
my_area
– /area

For the few times we affect only the area we're actually in. Set during Init. If we get moved, we don't update, but this is consistant with fire alarms and also kinda funny so call it intentional.

var
soundloop
– /datum/looping_sound/firealarm

looping sound datum for our fire alarm siren.

var
warn_lights
– /mutable_appearance

Overlay object for the warning lights. This and some plane settings allows the lights to glow in the dark.

Proc Details

proc
CalculateAffectingAreas
()

Calculates what areas we should worry about.

This proc builds a list of areas we are in and areas we border and writes it to affecting_areas.

proc
activate
(code)

Proc that handles activation of the firelock and all this details

Sets active and alarm type to properly represent our state. Also calls set_status() on all fire alarms in all affected areas, tells the area the firelock sits in to report the event (AI, alarm consoles, etc) and finally calls correct_state(), which will handle opening or closing this fire lock.

proc
add_as_source
()

Adds this fire door as a source of trouble to all of its areas

proc
adjust_lights_starting_offset
()

Sets the offset for the warning lights.

Used for special firelocks with light overlays that don't line up to their sprite.

proc
correct_state
()

Corrects the current state of the door, based on its activity.

This proc is called after weld and power restore events. Gives the illusion that the door is constantly attempting to move without actually having to process it. Timers also call this, so that if activity changes during the timer, the door doesn't close or open incorrectly.

proc
crack_open
(delay)

Open the firedoor without resetting existing alarms

delay - Reconsider if this door should be open or closed after some period

proc
release_constraints
()

Reset our temporary alarm ignoring Consider if we should close ourselves/our neighbors or not

proc
remove_as_source
()

Removes this firedoor from all areas it's serving as a source of problems for

proc
reset
()

Proc that handles reset steps

Clears the alarm state and attempts to open the firelock.

proc
start_activation_process
(code)

Begins activation process of us and our neighbors.

This proc will call activate() on every fire lock (including us) listed in the merge group datum. Returns without doing anything if we're already active, cause of course

Arguments: code should be one of three defined alarm types, or can be not supplied. Will dictate the color of the fire alarm lights, and defaults to "firelock_alarm_type_generic"

proc
start_deactivation_process
()

Begins deactivation process of us and our neighbors.

This proc will call reset() on every fire lock (including us) listed in the merge group datum. sets our alarm type to null, signifying no alarm.

try_to_crowbar
(/obj/item/acting_object, /mob/user, forced)

We check for adjacency when using the primary attack.

↑
try_to_crowbar_secondary
(/obj/item/acting_object, /mob/user)

A simple toggle for firedoors between on and off

firedoor /obj/machinery/door/firedoor

Vars

Procs

Var Details

var active –

var affecting_areas – /list

var alarm_type –

var assemblytype –

var being_held_open –

var ignore_alarms –

var is_playing_alarm –

var issue_turfs – /list/turf

var light_xoffset –

var light_yoffset –

var merger_id –

var my_area – /area

var soundloop – /datum/looping_sound/firealarm

var warn_lights – /mutable_appearance

Proc Details

proc CalculateAffectingAreas()

proc activate(code)

proc add_as_source()

proc adjust_lights_starting_offset()

proc correct_state()

proc crack_open(delay)

proc release_constraints()

proc remove_as_source()

proc reset()

proc start_activation_process(code)

proc start_deactivation_process()

try_to_crowbar(/obj/item/acting_object, /mob/user, forced)

↑try_to_crowbar_secondary(/obj/item/acting_object, /mob/user)