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
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
always_unpowered	This gets overridden to 1 for space in area/Initialize(mapload).
areasize	Size of the area in open turfs, only calculated for indoors areas.
beauty	Beauty average per open turf in the area
beauty_threshold	If a room is too big it doesn't have beauty.
clockwork_warp_allowed	whether servants can warp into this area from Reebe
clockwork_warp_fail	Message to display when the clockwork warp fails
considered_hull_exterior	Considered space for hull shielding
dirt_buildup_allowed	Dirty flooring allowed
fire	Do we have an active fire alarm?
flora_allowed	If flora are allowed to spawn in this area randomly through tunnel generation
hidden	Hides area from player Teleport function.
map_generator	This datum, if set, allows terrain generation behavior to be ran on Initialize()
map_name	CIT SPECIFIC VARS Set in New(); preserves the name set by the map maker, even if renamed by the Blueprints.
megafauna_spawn_allowed	If megafauna can be spawned by natural random generation
minimap_color	Color on minimaps, if it's null (which is default) it makes one at random.
mob_spawn_allowed	if mobs can be spawned by natural random generation
mood_bonus	Bonus mood for being in this area
mood_message	Mood message for being here, only shows up if mood_bonus != 0
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)
parallax_move_angle	Parallax move dir - degrees clockwise from north
parallax_move_speed	Parallax move speed - 0 to disable
parallax_moving	Parallax moving?
persistent_debris_allowed	Persistent debris alowed
requires_power	Will objects this area be needing power?
safe	Is the area teleport-safe: no space / radiation / aggresive mobs / other dangers
sound_environment	Used to decide what kind of reverb the area makes sound have
sub_areas	These two vars allow for multiple unique areas to be linked to a master area and share some functionalities such as APC powernet nodes, fire alarms etc, without sacrificing their own flags, statuses, variables and more snowflakes. Friendly reminder: no map edited areas.
totalbeauty	All beauty in this area combined, only includes indoor area.
triggered_firealarms	How many fire alarm sources do we have?
tunnel_allowed	If mining tunnel generation is allowed in this area
valid_malf_hack	malf ais can hack this
Procs
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
Initialize	Initalize this area
LateInitialize	Sets machine power levels in the area
ModifyFiredoors	Try to close all the firedoors in the area
New	Called when an area loads
reg_in_areas_in_z	Register this area as belonging to a z level
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

Var Details

var
active_alarms
– /list

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

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

var
always_unpowered
–

This gets overridden to 1 for space in area/Initialize(mapload).

var
areasize
–

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

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

whether servants can warp into this area from Reebe

var
clockwork_warp_fail
–

Message to display when the clockwork warp fails

var
considered_hull_exterior
–

Considered space for hull shielding

var
dirt_buildup_allowed
–

Dirty flooring allowed

var
fire
–

Do we have an active fire alarm?

var
flora_allowed
–

If flora are allowed to spawn in this area randomly through tunnel generation

var
hidden
–

Hides area from player Teleport function.

var
map_generator
– /datum/map_generator

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

var
map_name
–

CIT SPECIFIC VARS Set in New(); preserves the name set by the map maker, even if renamed by the Blueprints.

var
megafauna_spawn_allowed
–

If megafauna can be spawned by natural random generation

var
minimap_color
–

Color on minimaps, if it's null (which is default) it makes one at random.

var
mob_spawn_allowed
–

if mobs can be spawned by natural random generation

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

Parallax move dir - degrees clockwise from north

var
parallax_move_speed
–

Parallax move speed - 0 to disable

var
parallax_moving
–

Parallax moving?

var
persistent_debris_allowed
–

Persistent debris alowed

var
requires_power
–

Will objects this area be needing power?

var
safe
–

Is the area teleport-safe: no space / radiation / aggresive mobs / other dangers

var
sound_environment
–

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

var
sub_areas
– /list/area

These two vars allow for multiple unique areas to be linked to a master area and share some functionalities such as APC powernet nodes, fire alarms etc, without sacrificing their own flags, statuses, variables and more snowflakes. Friendly reminder: no map edited areas.

var
totalbeauty
–

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

var
triggered_firealarms
–

How many fire alarm sources do we have?

var
tunnel_allowed
–

If mining tunnel generation is allowed in this area

var
valid_malf_hack
–

malf ais can hack this

Proc Details

↑
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/M, /atom/OldLoc)

Call back when an atom enters an area

Sends signals COMSIG_AREA_ENTERED and COMSIG_ENTER_AREA (to the atom)

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

Exited
(/atom/movable/M)

Called when an atom exits an area

Sends signals COMSIG_AREA_EXITED and COMSIG_EXIT_AREA (to the atom)

↑
Initialize
(mapload)

Initalize this area

intializes the dynamic area lighting and also registers the area with the z level via reg_in_areas_in_z

returns INITIALIZE_HINT_LATELOAD

↑
LateInitialize
()

Sets machine power levels in the area

proc
ModifyFiredoors
(opening)

Try to close all the firedoors in the area

↑
New
()

Called when an area loads

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

proc
reg_in_areas_in_z
()

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

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

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

area /area inherits /atom

Vars

Procs

Var Details

var active_alarms – /list

var alarm_manager – /datum/alarm_handler

var always_unpowered –

var areasize –

var beauty –

var beauty_threshold –

var clockwork_warp_allowed –

var clockwork_warp_fail –

var considered_hull_exterior –

var dirt_buildup_allowed –

var fire –

var flora_allowed –

var hidden –

var map_generator – /datum/map_generator

var map_name –

var megafauna_spawn_allowed –

var minimap_color –

var mob_spawn_allowed –

var mood_bonus –

var mood_message –

var outdoors –

var parallax_move_angle –

var parallax_move_speed –

var parallax_moving –

var persistent_debris_allowed –

var requires_power –

var safe –

var sound_environment –

var sub_areas – /list/area

var totalbeauty –

var triggered_firealarms –

var tunnel_allowed –

var valid_malf_hack –