atom

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

Vars
allow_weather	Do we allow weather?
always_unpowered	This gets overridden to 1 for space in area/Initialize().
area_limited_icon_smoothing	Boolean 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.
atmosalm	Whether there is an atmos alarm in this area
beauty	Beauty average per open turf in the area
beauty_threshold	If a room is too big it doesn't have beauty.
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
outdoors	For space, the asteroid, lavaland, etc. Used with blueprints 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
totalbeauty	All beauty in this area combined, only includes indoor area.
underground	Whether area is underground, important for weathers which shouldn't affect caves etc.
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
PlaceOnTopReact	A hook so areas can modify the incoming args (of what??)
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
clear_camera	Get rid of any dangling camera refs
clear_usage	Clear all power usage in area
close_and_lock_door	Close and lock a door passed into this proc
drop_location	Causes a runtime error
firealert	Generate an firealarm alert for this area
firereset	Reset the firealarm alert for this area
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
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_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_power	Add a power value amount to the stored used_x variables

Var Details

var
allow_weather
–

Do we allow weather?

var
always_unpowered
–

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

var
area_limited_icon_smoothing
–

Boolean 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
atmosalm
–

Whether there is an atmos alarm in 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
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
outdoors
–

For space, the asteroid, lavaland, etc. Used with blueprints 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
totalbeauty
–

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

var
underground
–

Whether area is underground, important for weathers which shouldn't affect caves etc.

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)

↑
Initialize
()

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

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

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
(isdangerous, /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
clear_camera
(/obj/machinery/camera/cam)

Get rid of any dangling camera refs

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

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

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

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

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

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? //good documentation

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

var always_unpowered –

var area_limited_icon_smoothing –

var areasize –

var atmosalm –

var beauty –

var beauty_threshold –

var max_ambience_cooldown –

var min_ambience_cooldown –

var mood_bonus –

var mood_message –

var outdoors –

var requires_power –

var sound_environment –

var totalbeauty –

var underground –

Proc Details

↑AllowDrop()

↑Destroy()

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

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

↑Initialize()

↑LateInitialize()

proc ModifyFiredoors(opening)

↑New()

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

proc addStaticPower(value, powerchannel)

proc atmosalert(isdangerous, /obj/source)

proc burglaralert(/obj/trigger)

proc clear_camera(/obj/machinery/camera/cam)

proc clear_usage()

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

↑drop_location()

proc firealert(/obj/source)

proc firereset(/obj/source)

proc power_change()

proc poweralert(state, /obj/source)

proc powered(chan)

process()

proc reg_in_areas_in_z()

proc set_fire_alarm_effect()

proc setup(a_name)

proc unset_fire_alarm_effects()

proc update_areasize()

proc update_beauty()

↑update_icon_state()

proc use_power(amount, chan)

area
/area
inherits /atom

var
allow_weather
–

var
always_unpowered
–

var
area_limited_icon_smoothing
–

var
areasize
–

var
atmosalm
–

var
beauty
–

var
beauty_threshold
–

var
max_ambience_cooldown
–

var
min_ambience_cooldown
–

var
mood_bonus
–

var
mood_message
–

var
outdoors
–

var
requires_power
–

var
sound_environment
–

var
totalbeauty
–

var
underground
–

↑
AllowDrop
()

↑
Destroy
()

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

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

↑
Initialize
()

↑
LateInitialize
()

proc
ModifyFiredoors
(opening)

↑
New
()

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

proc
addStaticPower
(value, powerchannel)

proc
atmosalert
(isdangerous, /obj/source)

proc
burglaralert
(/obj/trigger)

proc
clear_camera
(/obj/machinery/camera/cam)

proc
clear_usage
()

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

↑
drop_location
()

proc
firealert
(/obj/source)

proc
firereset
(/obj/source)

proc
power_change
()

proc
poweralert
(state, /obj/source)

proc
powered
(chan)

process
()

proc
reg_in_areas_in_z
()

proc
set_fire_alarm_effect
()

proc
setup
(a_name)

proc
unset_fire_alarm_effects
()

proc
update_areasize
()

proc
update_beauty
()

↑
update_icon_state
()

proc
use_power
(amount, chan)