atom

A grouping of tiles into a logical space, mostly used by map editors

Vars
active_alarms	Alarm type to count of sources. Not usable for ^ because we handle fires differently
active_firelocks	A list of firelocks currently active. Used by fire alarms when setting their icons.
air_scrubbers	List of all air scrubbers in the area
air_vents	List of all air vents in the area
airlock_wires	Wire assignment for airlocks in this area
alarm_manager	We use this just for fire alarms, because they're area based right now so one alarm going poof shouldn't prevent you from clearing your alarms listing. Fire alarms and fire locks will set and clear alarms.
always_unpowered	This gets overridden to 1 for space in area/.
ambient_buzz	The background droning loop that plays 24/7
ambient_buzz_vol	The volume of the ambient buzz
ambientsounds	A list of sounds to pick from every so often to play to clients.
area_has_base_lighting	Whether this area has a currently active base lighting, bool
area_limited_icon_smoothing	Typepath to limit the areas (subtypes included) that atoms in this area can smooth with. Used for shuttles.
areasize	Size of the area in open turfs, only calculated for indoors areas.
base_lighting_alpha	alpha 0-255 of lighting_effect and thus baselighting intensity
base_lighting_color	The colour of the light acting on this area
beauty	Beauty average per open turf in the area
beauty_threshold	If a room is too big it doesn't have beauty.
energy_usage	The energy usage of the area in the last machines SS tick.
fault_location	The source machinery for the area's fault status
fault_status	The current alarm fault status
fire	Do we have an active fire alarm?
fire_detect	A var for whether the area allows for detecting fires/etc. Disabled or enabled at a fire alarm, checked by fire locks.
firealarms	A list of all fire alarms in this area. Used by firelocks and burglar alarms to change icon state.
firedoors	A list of all fire locks in this area. Used by fire alarm panels when resetting fire locks or activating all in an area
forced_ambience	Does this area immediately play an ambience track upon enter?
lighting_effects	List of mutable appearances we underlay to show light In the form plane offset + 1 -> appearance to use
lights	List of all lights in our area
map_generator	This datum, if set, allows terrain generation behavior to be ran on Initialize()
max_ambience_cooldown	Used to decide what the maximum time between ambience is
min_ambience_cooldown	Used to decide what the minimum time between ambience is
mood_bonus	Bonus mood for being in this area
mood_message	Mood message for being here, only shows up if mood_bonus != 0
mood_trait	Does the mood bonus require a trait?
outdoors	For space, the asteroid, lavaland, etc. Used with blueprints or with weather to determine if we are adding a new area (vs editing a station room)
requires_power	Will objects this area be needing power?
sound_environment	Used to decide what kind of reverb the area makes sound have
static_lighting	Whether this area allows static lighting and thus loads the lighting objects
totalbeauty	All beauty in this area combined, only includes indoor area.
turfs_by_zlevel	List of all turfs currently inside this area as nested lists indexed by zlevel. Acts as a filtered version of area.contents For faster lookup (area.contents is actually a filtered loop over world) Semi fragile, but it prevents stupid so I think it's worth it
turfs_to_uncontain_by_zlevel	turfs_by_z_level can hold MASSIVE lists, so rather then adding/removing from it each time we have a problem turf We should instead store a list of turfs to REMOVE from it, then hook into a getter for it There is a risk of this and contained_turfs leaking, so a subsystem will run it down to 0 incrementally if it gets too large This uses the same nested list format as turfs_by_zlevel
Procs
AllowDrop	Causes a runtime error
Destroy	Destroy an area and clean it up
Entered	Call back when an atom enters an area
Exited	Called when an atom exits an area
LateInitialize	Sets machine power levels in the area
New	Called when an area loads
PlaceOnTopReact	A hook so areas can modify the incoming args (of what??)
RunTerrainGeneration	Generate turfs, including cool cave wall gen
RunTerrainPopulation	Populate the previously generated terrain with mobs and objects
addStaticPower	Add a static amount of power load to an area. The value is assumed as the watt.
burglaralert	Raise a burglar alert for this area
cannonize_contained_turfs	Ensures that the contained_turfs list properly represents the turfs actually inside us
cannonize_contained_turfs_by_zlevel	Ensures that the contained_turfs list properly represents the turfs actually inside us
clear_usage	Clear all non-static power usage in area
close_and_lock_door	Close and lock a door passed into this proc
create_area_lighting_objects	regenerates lighting objects for turfs in this area, primary use is VV changes
drop_location	Causes a runtime error
get_highest_zlevel	Returns the highest zlevel that this area contains turfs for
get_original_area_name	Returns the name of an area, with the original name if the area name has been changed.
get_turfs_by_zlevel	Returns a list with all turfs in this zlevel.
get_turfs_from_all_zlevels	Merges a list containing all of the turfs zlevel lists from get_zlevel_turf_lists inside one list. Use get_zlevel_turf_lists() or get_turfs_by_zlevel() unless you need all the turfs in one list to avoid generating large lists
get_zlevel_turf_lists	Returns a nested list of lists with all turfs split by zlevel. only zlevels with turfs are returned. The order of the list is not guaranteed.
has_contained_turfs	Returns TRUE if we have contained turfs, FALSE otherwise
on_joining_game	Called when a living mob that spawned here, joining the round, receives the player client.
play_ambience	Attempts to play an ambient sound to a mob, returning the cooldown in deciseconds
power_change	Called when the area power status changes
powered	Returns int 1 or 0 if the area has power for the given channel
reg_in_areas_in_z	Register this area as belonging to a z level
removeStaticPower	Remove a static amount of power load to an area. The value is assumed as the watt.
remove_area_lighting_objects	Removes lighting objects from turfs in this area if we have them, primary use is VV changes
set_fire_effect	Set the fire alarm visual affects in an area
setup	Setup an area (with the given name)
update_areasize	Set the area size of the area
update_beauty	Divides total beauty in the room by roomsize to allow us to get an average beauty per tile.
update_icon_state	Update the icon state of the area
use_energy	Add a power value amount to the stored used_x variables

Var Details

var
active_alarms
– /list

Alarm type to count of sources. Not usable for ^ because we handle fires differently

var
active_firelocks
– /list

A list of firelocks currently active. Used by fire alarms when setting their icons.

var
air_scrubbers
– /list/obj/machinery/atmospherics/components/unary/vent_scrubber

List of all air scrubbers in the area

var
air_vents
– /list/obj/machinery/atmospherics/components/unary/vent_pump

List of all air vents in the area

var
airlock_wires
–

Wire assignment for airlocks in this area

var
alarm_manager
– /datum/alarm_handler

We use this just for fire alarms, because they're area based right now so one alarm going poof shouldn't prevent you from clearing your alarms listing. Fire alarms and fire locks will set and clear alarms.

var
always_unpowered
–

This gets overridden to 1 for space in area/.

var
ambient_buzz
–

The background droning loop that plays 24/7

var
ambient_buzz_vol
–

The volume of the ambient buzz

var
ambientsounds
– /list

A list of sounds to pick from every so often to play to clients.

var
area_has_base_lighting
–

Whether this area has a currently active base lighting, bool

var
area_limited_icon_smoothing
– /area

Typepath to limit the areas (subtypes included) that atoms in this area can smooth with. Used for shuttles.

var
areasize
–

Size of the area in open turfs, only calculated for indoors areas.

var
base_lighting_alpha
–

alpha 0-255 of lighting_effect and thus baselighting intensity

var
base_lighting_color
–

The colour of the light acting on this area

var
beauty
–

Beauty average per open turf in the area

var
beauty_threshold
–

If a room is too big it doesn't have beauty.

var
energy_usage
– /list

The energy usage of the area in the last machines SS tick.

var
fault_location
–

The source machinery for the area's fault status

var
fault_status
–

The current alarm fault status

var
fire
–

Do we have an active fire alarm?

var
fire_detect
–

A var for whether the area allows for detecting fires/etc. Disabled or enabled at a fire alarm, checked by fire locks.

var
firealarms
– /list

A list of all fire alarms in this area. Used by firelocks and burglar alarms to change icon state.

var
firedoors
– /list

A list of all fire locks in this area. Used by fire alarm panels when resetting fire locks or activating all in an area

var
forced_ambience
–

Does this area immediately play an ambience track upon enter?

var
lighting_effects
– /list/mutable_appearance

List of mutable appearances we underlay to show light In the form plane offset + 1 -> appearance to use

var
lights
– /list

List of all lights in our area

var
map_generator
– /datum/map_generator

This datum, if set, allows terrain generation behavior to be ran on Initialize()

var
max_ambience_cooldown
–

Used to decide what the maximum time between ambience is

var
min_ambience_cooldown
–

Used to decide what the minimum time between ambience is

var
mood_bonus
–

Bonus mood for being in this area

var
mood_message
–

Mood message for being here, only shows up if mood_bonus != 0

var
mood_trait
–

Does the mood bonus require a trait?

var
outdoors
–

For space, the asteroid, lavaland, etc. Used with blueprints or with weather to determine if we are adding a new area (vs editing a station room)

var
requires_power
–

Will objects this area be needing power?

var
sound_environment
–

Used to decide what kind of reverb the area makes sound have

var
static_lighting
–

Whether this area allows static lighting and thus loads the lighting objects

var
totalbeauty
–

All beauty in this area combined, only includes indoor area.

var
turfs_by_zlevel
– /list/list/turf

List of all turfs currently inside this area as nested lists indexed by zlevel. Acts as a filtered version of area.contents For faster lookup (area.contents is actually a filtered loop over world) Semi fragile, but it prevents stupid so I think it's worth it

var
turfs_to_uncontain_by_zlevel
– /list/list/turf

turfs_by_z_level can hold MASSIVE lists, so rather then adding/removing from it each time we have a problem turf We should instead store a list of turfs to REMOVE from it, then hook into a getter for it There is a risk of this and contained_turfs leaking, so a subsystem will run it down to 0 incrementally if it gets too large This uses the same nested list format as turfs_by_zlevel

Proc Details

↑
AllowDrop
()

Causes a runtime error

↑
Destroy
()

Destroy an area and clean it up

Removes the area from GLOB.areas_by_type and also stops it processing on SSobj

This is despite the fact that no code appears to put it on SSobj, but who am I to argue with old coders

↑
Entered
(/atom/movable/arrived, /area/old_area)

Call back when an atom enters an area

Sends signals COMSIG_AREA_ENTERED and COMSIG_ENTER_AREA (to a list of atoms)

If the area has ambience, then it plays some ambience music to the ambience channel

↑
Exited
(/atom/movable/gone, direction)

Called when an atom exits an area

Sends signals COMSIG_AREA_EXITED and COMSIG_EXIT_AREA (to a list of atoms)

↑
LateInitialize
()

Sets machine power levels in the area

↑
New
()

Called when an area loads

Adds the item to the GLOB.areas_by_type list based on area type

proc
PlaceOnTopReact
(/list/new_baseturfs, /turf/fake_turf_type, flags)

A hook so areas can modify the incoming args (of what??)

proc
RunTerrainGeneration
()

Generate turfs, including cool cave wall gen

proc
RunTerrainPopulation
()

Populate the previously generated terrain with mobs and objects

proc
addStaticPower
(value, powerchannel)

Add a static amount of power load to an area. The value is assumed as the watt.

Possible channels *AREA_USAGE_STATIC_EQUIP *AREA_USAGE_STATIC_LIGHT *AREA_USAGE_STATIC_ENVIRON

proc
burglaralert
(/obj/trigger)

Raise a burglar alert for this area

Close and locks all doors in the area and alerts silicon mobs of a break in

Alarm auto resets after 600 ticks

proc
cannonize_contained_turfs
()

Ensures that the contained_turfs list properly represents the turfs actually inside us

proc
cannonize_contained_turfs_by_zlevel
(zlevel_to_clean, _autoclean)

Ensures that the contained_turfs list properly represents the turfs actually inside us

proc
clear_usage
()

Clear all non-static power usage in area

Clears all power used for the dynamic equipment, light and environment channels

proc
close_and_lock_door
(/obj/machinery/door/DOOR)

Close and lock a door passed into this proc

Does this need to exist on area? probably not

proc
create_area_lighting_objects
()

regenerates lighting objects for turfs in this area, primary use is VV changes

↑
drop_location
()

Causes a runtime error

proc
get_highest_zlevel
()

Returns the highest zlevel that this area contains turfs for

proc
get_original_area_name
()

Returns the name of an area, with the original name if the area name has been changed.

If an area has not been renamed, returns the area name. If it has been modified (by blueprints or other means) returns the current name, as well as the initial value, in the format of [Current Location Name (Original Name)]

proc
get_turfs_by_zlevel
(zlevel)

Returns a list with all turfs in this zlevel.

proc
get_turfs_from_all_zlevels
()

Merges a list containing all of the turfs zlevel lists from get_zlevel_turf_lists inside one list. Use get_zlevel_turf_lists() or get_turfs_by_zlevel() unless you need all the turfs in one list to avoid generating large lists

proc
get_zlevel_turf_lists
()

Returns a nested list of lists with all turfs split by zlevel. only zlevels with turfs are returned. The order of the list is not guaranteed.

proc
has_contained_turfs
()

Returns TRUE if we have contained turfs, FALSE otherwise

proc
on_joining_game
(/mob/living/boarder)

Called when a living mob that spawned here, joining the round, receives the player client.

proc
play_ambience
(/mob/M, /sound/override_sound, volume)

Attempts to play an ambient sound to a mob, returning the cooldown in deciseconds

proc
power_change
()

Called when the area power status changes

Updates the area icon, calls power change on all machinees in the area, and sends the COMSIG_AREA_POWER_CHANGE signal.

proc
powered
(chan)

Returns int 1 or 0 if the area has power for the given channel

evaluates a mixture of variables mappers can set, requires_power, always_unpowered and then per channel power_equip, power_light, power_environ

proc
reg_in_areas_in_z
()

Ensures the item is added to the SSmapping.areas_in_z list for this z

proc
removeStaticPower
(value, powerchannel)

Remove a static amount of power load to an area. The value is assumed as the watt.

Possible channels *AREA_USAGE_STATIC_EQUIP *AREA_USAGE_STATIC_LIGHT *AREA_USAGE_STATIC_ENVIRON

proc
remove_area_lighting_objects
()

Removes lighting objects from turfs in this area if we have them, primary use is VV changes

proc
set_fire_effect
(new_fire, fault_type, fault_source)

Set the fire alarm visual affects in an area

Allows interested parties (lights and fire alarms) to react

proc
setup
(a_name)

Setup an area (with the given name)

Sets the area name, sets all status var's to false and adds the area to the sorted area list

proc
update_areasize
()

Set the area size of the area

This is the number of open turfs in the area contents, or FALSE if the outdoors var is set

proc
update_beauty
()

Divides total beauty in the room by roomsize to allow us to get an average beauty per tile.

↑
update_icon_state
()

Update the icon state of the area

I'm not sure what the heck this does, something to do with weather being able to set icon states on areas?? where the heck would that even display?

proc
use_energy
(amount, chan)

Add a power value amount to the stored used_x variables

area /area inherits /atom

Vars

Procs

Var Details

var active_alarms – /list

var active_firelocks – /list

var air_scrubbers – /list/obj/machinery/atmospherics/components/unary/vent_scrubber

var air_vents – /list/obj/machinery/atmospherics/components/unary/vent_pump

var airlock_wires –

var alarm_manager – /datum/alarm_handler

var always_unpowered –

var ambient_buzz –

var ambient_buzz_vol –

var ambientsounds – /list

var area_has_base_lighting –

var area_limited_icon_smoothing – /area

var areasize –

var base_lighting_alpha –

var base_lighting_color –

var beauty –

var beauty_threshold –

var energy_usage – /list

var fault_location –

var fault_status –

var fire –

var fire_detect –

var firealarms – /list

var firedoors – /list

var forced_ambience –

var lighting_effects – /list/mutable_appearance

var lights – /list

var map_generator – /datum/map_generator

var max_ambience_cooldown –

var min_ambience_cooldown –

var mood_bonus –

var mood_message –

var mood_trait –

var outdoors –

var requires_power –

var sound_environment –

var static_lighting –

var totalbeauty –

var turfs_by_zlevel – /list/list/turf

var turfs_to_uncontain_by_zlevel – /list/list/turf

Proc Details

↑AllowDrop()

↑Destroy()

↑Entered(/atom/movable/arrived, /area/old_area)

↑Exited(/atom/movable/gone, direction)

↑LateInitialize()

↑New()

proc PlaceOnTopReact(/list/new_baseturfs, /turf/fake_turf_type, flags)

proc RunTerrainGeneration()

proc RunTerrainPopulation()

proc addStaticPower(value, powerchannel)

proc burglaralert(/obj/trigger)

proc cannonize_contained_turfs()

proc cannonize_contained_turfs_by_zlevel(zlevel_to_clean, _autoclean)

proc clear_usage()

proc close_and_lock_door(/obj/machinery/door/DOOR)

proc create_area_lighting_objects()

↑drop_location()

proc get_highest_zlevel()

proc get_original_area_name()

proc get_turfs_by_zlevel(zlevel)

proc get_turfs_from_all_zlevels()

proc get_zlevel_turf_lists()

proc has_contained_turfs()

proc on_joining_game(/mob/living/boarder)

proc play_ambience(/mob/M, /sound/override_sound, volume)

proc power_change()

proc powered(chan)

proc reg_in_areas_in_z()

proc removeStaticPower(value, powerchannel)

proc remove_area_lighting_objects()

proc set_fire_effect(new_fire, fault_type, fault_source)

proc setup(a_name)

proc update_areasize()

proc update_beauty()

↑update_icon_state()