closet

Vars
access_choices	access types for card reader
access_locked	should we prevent further access change
air_volume	Volume of the internal air
card_reader_installed	is the card reader installed in this machine
contents_pressure_protection	How close being inside of the thing provides complete pressure safety. Must be between 0 and 1!
contents_thermal_insulation	How insulated the thing is, for the purposes of calculating body temperature. Must be between 0 and 1!
divable	Whether a skittish person can dive inside this closet. Disable if opening the closet causes "bad things" to happen or that it leads to a logical inconsistency.
door_anim_angle	The maximum angle the door will be drawn at
door_anim_squish	Vertical squish of the door
door_anim_time	Amount of time it takes for the door animation to play
door_hinge_x	X position of the closet door hinge, relative to the center of the sprite
door_obj	The overlay for the closet's door
enable_door_overlay	Controls whether a door overlay should be applied using the icon_door value as the icon state
id_card	is this closet locked by an exclusive id, i.e. your own personal locker
internal_air	Internal gas for this closet.
is_animating_door	Whether or not this door is being animated
paint_jobs	Paint jobs for this closet, crates are a subtype of closet so they override these values
sealed	Whether this closet is sealed or not. If sealed, it'll have its own internal air
secure	secure locker or not, also used if overriding a non-secure locker with a secure door overlay to add fancy lights
strong_grab	true whenever someone with the strong pull component (or magnet modsuit module) is dragging this, preventing opening
x_shake_pixel_shift	How many pixels the closet can shift on the x axis when shaking
y_shake_pixel_shift	how many pixels the closet can shift on the y axes when shaking
Procs
add_to_roundstart_list	Adds the closet to a global list. Placed in its own proc so that crates may be excluded.
after_close	Proc to do effects after closet has closed
after_open	Proc to override for effects after opening a door
animate_door	Animates the closet door opening and closing
before_close	Proc to write checks before closing a door
before_open	Proc to write checks before opening a door
can_install_airlock_electronics	check if we can install airlock electronics in this closet
can_install_card_reader	check if we can install card reader in this closet
can_pryout_card_reader	check if we can pry out the card reader from this closet
can_unlock	returns TRUE if the closet is allowed to unlock
can_unscrew_airlock_electronics	check if we can unscrew airlock electronics from this closet
check_if_shake	Check if someone is still resisting inside, and choose to either keep shaking or stop shaking the closet
end_door_animation	Ends the door animation and removes the animated overlay
get_door_transform	Calculates the matrix to be applied to the animated door overlay
lock	toggles the lock state of a closet
on_magic_unlock	Signal proc for COMSIG_ATOM_MAGICALLY_UNLOCKED. Unlock and open up when we get knock casted.
play_closet_lock_sound	plays the closet's lock/unlock sound, this should be placed AFTER you've changed the lock state
populate_contents_immediate	Populate the closet with stuff that needs to be added before it is opened. This is useful for things like traitor objectives.
populate_with_random_maint_loot	Spawns two to six maintenance spawners inside the closet
set_access	sets the access for the closets from the swiped ID card
toggle	Toggles a closet open or closed, to the opposite state. Does not respect locked or welded states, however.
tool_interact	returns TRUE if attackBy call shouldn't be continued (because tool was used/closet was of wrong type), FALSE if otherwise
unlock	unlocks the closet

Var Details

var
access_choices
– /list

access types for card reader

var
access_locked

should we prevent further access change

var
air_volume

Volume of the internal air

var
card_reader_installed

is the card reader installed in this machine

↑
contents_pressure_protection

How close being inside of the thing provides complete pressure safety. Must be between 0 and 1!

↑
contents_thermal_insulation

How insulated the thing is, for the purposes of calculating body temperature. Must be between 0 and 1!

var
divable

Whether a skittish person can dive inside this closet. Disable if opening the closet causes "bad things" to happen or that it leads to a logical inconsistency.

var
door_anim_angle

The maximum angle the door will be drawn at

var
door_anim_squish

Vertical squish of the door

var
door_anim_time

Amount of time it takes for the door animation to play

var
door_hinge_x

X position of the closet door hinge, relative to the center of the sprite

var
door_obj
– /obj/effect/overlay/closet_door

The overlay for the closet's door

var
enable_door_overlay

Controls whether a door overlay should be applied using the icon_door value as the icon state

var
id_card
– /datum/weakref

is this closet locked by an exclusive id, i.e. your own personal locker

var
internal_air
– /datum/gas_mixture

Internal gas for this closet.

var
is_animating_door

Whether or not this door is being animated

var
paint_jobs
– /list

Paint jobs for this closet, crates are a subtype of closet so they override these values

var
sealed

Whether this closet is sealed or not. If sealed, it'll have its own internal air

var
secure

secure locker or not, also used if overriding a non-secure locker with a secure door overlay to add fancy lights

var
strong_grab

true whenever someone with the strong pull component (or magnet modsuit module) is dragging this, preventing opening

var
x_shake_pixel_shift

How many pixels the closet can shift on the x axis when shaking

var
y_shake_pixel_shift

how many pixels the closet can shift on the y axes when shaking

Proc Details

proc
add_to_roundstart_list
()

Adds the closet to a global list. Placed in its own proc so that crates may be excluded.

proc
after_close
(/mob/living/user)

Proc to do effects after closet has closed

proc
after_open
(/mob/living/user, force)

Proc to override for effects after opening a door

proc
animate_door
(closing)

Animates the closet door opening and closing

proc
before_close
(/mob/living/user)

Proc to write checks before closing a door

proc
before_open
(/mob/living/user, force)

Proc to write checks before opening a door

proc
can_install_airlock_electronics
(/mob/user)

check if we can install airlock electronics in this closet

proc
can_install_card_reader
(/mob/user)

check if we can install card reader in this closet

proc
can_pryout_card_reader
(/mob/user)

check if we can pry out the card reader from this closet

proc
can_unlock
(/mob/living/user, /obj/item/card/id/player_id, /obj/item/card/id/registered_id)

returns TRUE if the closet is allowed to unlock

user: the player trying to unlock this closet
player_id: the id of the player trying to unlock this closet
registered_id: the id registered to this closet, null if no one registered

proc
can_unscrew_airlock_electronics
(/mob/user)

check if we can unscrew airlock electronics from this closet

proc
check_if_shake
()

Check if someone is still resisting inside, and choose to either keep shaking or stop shaking the closet

proc
end_door_animation
()

Ends the door animation and removes the animated overlay

proc
get_door_transform
(angle)

Calculates the matrix to be applied to the animated door overlay

proc
lock
()

toggles the lock state of a closet

proc
on_magic_unlock
(/datum/source, /datum/action/cooldown/spell/aoe/knock/spell, /atom/caster)

Signal proc for COMSIG_ATOM_MAGICALLY_UNLOCKED. Unlock and open up when we get knock casted.

proc
play_closet_lock_sound
()

plays the closet's lock/unlock sound, this should be placed AFTER you've changed the lock state

proc
populate_contents_immediate
()

Populate the closet with stuff that needs to be added before it is opened. This is useful for things like traitor objectives.

proc
populate_with_random_maint_loot
()

Spawns two to six maintenance spawners inside the closet

proc
set_access
(/list/accesses)

sets the access for the closets from the swiped ID card

proc
toggle
(/mob/living/user)

Toggles a closet open or closed, to the opposite state. Does not respect locked or welded states, however.

proc
tool_interact
(/obj/item/weapon, /mob/living/user)

returns TRUE if attackBy call shouldn't be continued (because tool was used/closet was of wrong type), FALSE if otherwise

proc
unlock
()

unlocks the closet

closet /obj/structure/closet

Vars

Procs

Var Details

var access_choices – /list

var access_locked

var air_volume

var card_reader_installed

↑contents_pressure_protection

↑contents_thermal_insulation

var divable

var door_anim_angle

var door_anim_squish

var door_anim_time

var door_hinge_x

var door_obj – /obj/effect/overlay/closet_door

var enable_door_overlay

var id_card – /datum/weakref

var internal_air – /datum/gas_mixture

var is_animating_door

var paint_jobs – /list

var sealed

var secure

var strong_grab

var x_shake_pixel_shift

var y_shake_pixel_shift

Proc Details

proc add_to_roundstart_list()

proc after_close(/mob/living/user)

proc after_open(/mob/living/user, force)

proc animate_door(closing)

proc before_close(/mob/living/user)

proc before_open(/mob/living/user, force)

proc can_install_airlock_electronics(/mob/user)

proc can_install_card_reader(/mob/user)

proc can_pryout_card_reader(/mob/user)

proc can_unlock(/mob/living/user, /obj/item/card/id/player_id, /obj/item/card/id/registered_id)

proc can_unscrew_airlock_electronics(/mob/user)

proc check_if_shake()

proc end_door_animation()

proc get_door_transform(angle)

proc lock()

proc on_magic_unlock(/datum/source, /datum/action/cooldown/spell/aoe/knock/spell, /atom/caster)

proc play_closet_lock_sound()

proc populate_contents_immediate()

proc populate_with_random_maint_loot()

proc set_access(/list/accesses)

proc toggle(/mob/living/user)

proc tool_interact(/obj/item/weapon, /mob/living/user)

proc unlock()