atom

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

Vars
airlock_wires	Wire assignment for airlocks in this area
ambient_buzz	Ambient buzz of the station, plays repeatedly, also IC
ambient_buzz_vol	The volume of the ambient buzz
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.
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
daylight_multiplier	Daylight brightness
delta_light	a simple check to determine whether the lights in an area should go red during delta alert
fire	If true, that means one of any fire alarms in the area is active
hidden	Hides area from player Teleport function.
lighting_colour_bulb	The color of the light bulb's light in this area
lighting_colour_tube	The color of the light tubes' light in this area
lighting_effects	List of mutable appearances we underlay to show light In the form plane offset + 1 -> appearance to use
lights_always_start_on	Whether the lights in this area aren't turned off when it's empty at roundstart
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
safe	Is the area teleport-safe: no space / radiation / aggresive mobs / other dangers
show_on_sensors	If false, then this area will show up as gibberish on suit sensors.
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
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
unique	If false, loading multiple maps with this area type will create multiple instances.
uses_daylight	Whether to cycle brightness based on time of day
xenobiology_compatible	Can the Xenobio management console transverse this area by default?
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
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
addStaticPower	Add a static amount of power load to an area
atmosalert	Generate an atmospheric alert for this area
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 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
firealert	Generate an firealarm alert for this area
firereset	Reset the firealarm alert for this area
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.
place_on_topReact	A hook so areas can modify the incoming args (of what??)
power_change	Called when the area power status changes
poweralert	Generate a power alert for this area
powered	Returns int 1 or 0 if the area has power for the given channel
process	If 100 ticks has elapsed, toggle all the firedoors closed again
reg_in_areas_in_z	Register this area as belonging to a z level
remove_area_lighting_objects	Removes lighting objects from turfs in this area if we have them, primary use is VV changes
set_fire_alarm_effect	Trigger the fire alarm visual affects in an area
setup	Setup an area (with the given name)
unset_fire_alarm_effects	unset the fire alarm visual affects in an area
update_areasize	Set the area size of the area
update_icon_state	Update the icon state of the area
usage	Return the usage of power per channel
use_power	Add a power value amount to the stored used_x variables

Var Details

var
airlock_wires
–

Wire assignment for airlocks in this area

var
ambient_buzz
–

Ambient buzz of the station, plays repeatedly, also IC

var
ambient_buzz_vol
–

The volume of the ambient buzz

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

Daylight brightness

var
delta_light
–

a simple check to determine whether the lights in an area should go red during delta alert

var
fire
–

If true, that means one of any fire alarms in the area is active

var
hidden
–

Hides area from player Teleport function.

var
lighting_colour_bulb
–

The color of the light bulb's light in this area

var
lighting_colour_tube
–

The color of the light tubes' light in this area

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

Whether the lights in this area aren't turned off when it's empty at roundstart

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

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

var
show_on_sensors
–

If false, then this area will show up as gibberish on suit sensors.

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

var
unique
–

If false, loading multiple maps with this area type will create multiple instances.

var
uses_daylight
–

Whether to cycle brightness based on time of day

var
xenobiology_compatible
–

Can the Xenobio management console transverse this area by default?

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/M)

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
addStaticPower
(value, powerchannel)

Add a static amount of power load to an area

Possible channels *AREA_USAGE_STATIC_EQUIP *AREA_USAGE_STATIC_LIGHT *AREA_USAGE_STATIC_ENVIRON

proc
atmosalert
(danger_level, /obj/source)

Generate an atmospheric alert for this area

Sends to all ai players, alert consoles, drones and alarm monitor programs in the world

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 power usage in area

Clears all power used for 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
firealert
(/obj/source)

Generate an firealarm alert for this area

Sends to all ai players, alert consoles, drones and alarm monitor programs in the world

Also starts the area processing on SSobj

proc
firereset
(/obj/source, alert_only)

Reset the firealarm alert for this area

resets the alert sent to all ai players, alert consoles, drones and alarm monitor programs in the world

Also cycles the icons of all firealarms and deregisters the area from processing on SSOBJ

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
place_on_topReact
(/list/new_baseturfs, /turf/fake_turf_type, flags)

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

proc
power_change
()

Called when the area power status changes

Updates the area icon and calls power change on all machinees in the area

proc
poweralert
(state, /obj/source)

Generate a power alert for this area

Sends to all ai players, alert consoles, drones and alarm monitor programs in the world

proc
powered
(chan)

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

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

↑
process
()

If 100 ticks has elapsed, toggle all the firedoors closed again

proc
reg_in_areas_in_z
()

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

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_alarm_effect
(delta_alert)

Trigger the fire alarm visual affects in an area

Updates the fire light on fire alarms in the area and sets all lights to emergency mode

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
unset_fire_alarm_effects
(delta_alert)

unset the fire alarm visual affects in an area

Updates the fire light on fire alarms in the area and sets all lights to emergency mode

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

↑
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?

proc
usage
(chan)

Return the usage of power per channel

proc
use_power
(amount, chan)

Add a power value amount to the stored used_x variables

area /area inherits /atom

Vars

Procs

Var Details

var airlock_wires –

var ambient_buzz –

var ambient_buzz_vol –

var area_has_base_lighting –

var area_limited_icon_smoothing – /area

var base_lighting_alpha –

var base_lighting_color –

var daylight_multiplier –

var delta_light –

var fire –

var hidden –

var lighting_colour_bulb –

var lighting_colour_tube –

var lighting_effects – /list/mutable_appearance

var lights_always_start_on –

var map_generator – /datum/map_generator

var max_ambience_cooldown –

var min_ambience_cooldown –

var mood_bonus –

var mood_message –

var safe –

var show_on_sensors –

var sound_environment –

var static_lighting –

var turfs_by_zlevel – /list/list/turf

var turfs_to_uncontain_by_zlevel – /list/list/turf

var unique –

var uses_daylight –

var xenobiology_compatible –

Proc Details

↑AllowDrop()

↑Destroy()

↑Entered(/atom/movable/M)

↑Exited(/atom/movable/M)

↑Initialize(mapload)

↑LateInitialize()

proc ModifyFiredoors(opening)

↑New()

proc addStaticPower(value, powerchannel)

proc atmosalert(danger_level, /obj/source)

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 firealert(/obj/source)

proc firereset(/obj/source, alert_only)

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 place_on_topReact(/list/new_baseturfs, /turf/fake_turf_type, flags)

proc power_change()

proc poweralert(state, /obj/source)

proc powered(chan)

↑process()

proc reg_in_areas_in_z()

proc remove_area_lighting_objects()

proc set_fire_alarm_effect(delta_alert)

proc setup(a_name)

proc unset_fire_alarm_effects(delta_alert)

proc update_areasize()

↑update_icon_state()

proc usage(chan)

proc use_power(amount, chan)

area
/area
inherits /atom

var
airlock_wires
–

var
ambient_buzz
–

var
ambient_buzz_vol
–

var
area_has_base_lighting
–

var
area_limited_icon_smoothing
– /area

var
base_lighting_alpha
–

var
base_lighting_color
–

var
daylight_multiplier
–

var
delta_light
–

var
fire
–

var
hidden
–

var
lighting_colour_bulb
–

var
lighting_colour_tube
–

var
lighting_effects
– /list/mutable_appearance

var
lights_always_start_on
–

var
map_generator
– /datum/map_generator

var
max_ambience_cooldown
–

var
min_ambience_cooldown
–

var
mood_bonus
–

var
mood_message
–

var
safe
–

var
show_on_sensors
–

var
sound_environment
–

var
static_lighting
–

var
turfs_by_zlevel
– /list/list/turf

var
turfs_to_uncontain_by_zlevel
– /list/list/turf

var
unique
–

var
uses_daylight
–

var
xenobiology_compatible
–

↑
AllowDrop
()

↑
Destroy
()

↑
Entered
(/atom/movable/M)

↑
Exited
(/atom/movable/M)

↑
Initialize
(mapload)

↑
LateInitialize
()

proc
ModifyFiredoors
(opening)

↑
New
()

proc
addStaticPower
(value, powerchannel)

proc
atmosalert
(danger_level, /obj/source)

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
firealert
(/obj/source)

proc
firereset
(/obj/source, alert_only)

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
place_on_topReact
(/list/new_baseturfs, /turf/fake_turf_type, flags)

proc
power_change
()

proc
poweralert
(state, /obj/source)

proc
powered
(chan)

↑
process
()

proc
reg_in_areas_in_z
()

proc
remove_area_lighting_objects
()

proc
set_fire_alarm_effect
(delta_alert)

proc
setup
(a_name)

proc
unset_fire_alarm_effects
(delta_alert)

proc
update_areasize
()

↑
update_icon_state
()

proc
usage
(chan)

proc
use_power
(amount, chan)