atom

Vars
all_fire_doors	Keeps a lit of adjacent firelocks, used for alarms/ZAS
area_flavor	string used to determine specific icon variants when structures are used in an area
area_has_base_lighting	Whether this area has a currently active base lighting, bool
area_limited_icon_smoothing	Boolean to limit the areas (subtypes included) that atoms in this area can smooth with. Used for shuttles.
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
cameras	Cameras in this area
ceiling	the material the ceiling is made of. Used for debris from airstrikes and orbital beacons in ceiling_debris()
fake_zlevel	Used in designating the "level" of maps pretending to be multi-z one Z
lighting_effects	List of mutable appearances we underlay to show light In the form plane offset + 1 -> appearance to use
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
outside	Is this area considered inside or outside
static_lighting	Whether this area allows static lighting and thus loads the lighting objects
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
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
get_apc	Returns the first APC it finds in an area
get_apc_list	Returns a list of APCs in this area
get_highest_zlevel	Returns the highest zlevel that this area contains turfs for
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
reg_in_areas_in_z	Register this area as belonging to a z level

Var Details

var
all_fire_doors
– /list

Keeps a lit of adjacent firelocks, used for alarms/ZAS

var
area_flavor
–

string used to determine specific icon variants when structures are used in an area

var
area_has_base_lighting
–

Whether this area has a currently active base lighting, bool

var
area_limited_icon_smoothing
–

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

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
cameras
– /list

Cameras in this area

var
ceiling
–

the material the ceiling is made of. Used for debris from airstrikes and orbital beacons in ceiling_debris()

var
fake_zlevel
–

Used in designating the "level" of maps pretending to be multi-z one Z

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
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
outside
–

Is this area considered inside or outside

var
static_lighting
–

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

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

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
get_apc
()

Returns the first APC it finds in an area

proc
get_apc_list
()

Returns a list of APCs in this area

proc
get_highest_zlevel
()

Returns the highest zlevel that this area contains turfs for

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
reg_in_areas_in_z
()

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

area /area inherits /atom

Vars

Procs

Var Details

var all_fire_doors – /list

var area_flavor –

var area_has_base_lighting –

var area_limited_icon_smoothing –

var base_lighting_alpha –

var base_lighting_color –

var cameras – /list

var ceiling –

var fake_zlevel –

var lighting_effects – /list/mutable_appearance

var max_ambience_cooldown –

var min_ambience_cooldown –

var outside –

var static_lighting –

var turfs_by_zlevel – /list/list/turf

var turfs_to_uncontain_by_zlevel – /list/list/turf