Goonstation 13 - Modules - TypesVar Details - Proc Details

area

A grouping of tiles into a logical space. The sworn enemy of mappers.

Vars

activeTRUE if a dude is here (DOES NOT APPLY TO THE "SPACE" AREA)
being_capturedIs the area currently being captured/tagged in gang mode
blockedset to TRUE to inhibit entrance into this area, may not work completely yet.
blocked_waypointif set and a blocked person makes their way into here via Bad Ways, they'll be teleported here instead of nullspace. use a path!
do_not_irradiate
filler_turfif set, replacewithspace in this area instead replaces with this turf type
gang_baseis this a gang's base (uncaptureable)?
gang_ownersgang that owns this area in gang mode
irradiatedspace blowouts use this, should always be 0
is_centcomfor escape checks
machinesLocal list of obj/machines found in the area
map_generatorThis datum, if set, allows terrain generation behavior to be ran on world/proc/init()
may_eat_here_in_restricted_zIf the area is on a restricted z leve, this controls if people can eat within it. (The reason for this might shock you!)
permaradsBlowouts don't set irradiated on this area back to zero.
populationList of all dudes who are here
sanctuaryset to TRUE to inhibit attacks in this area.
sound_environmentdefault environment for sounds - see sound datum vars documentation for the presets.
stormingfor Battle Royale gamemode
teleport_blockedCannot teleport into this area without some explicit set_loc thing. 1 for most things, 2 for definitely everything.
workplaceDo people work here?

Procs

EnteredGets called when a movable atom enters an area.
ExitedGets called when a movable atom exits an area.
clear_usagesets all current usage of power to 0
find_middleReturns the turf in the middle of the area. Returns null if none can be found.
firealertCauses a fire alert in the area if there is not one already set. Notifies AIs.
fireresetResets the fire alert in the area. Notifies AIs.
power_changeCalled when power status changes. Updates machinery and the icon of the area.
poweralertCauses a power alert in the area. Notifies AIs.
poweredDetermines is an area is powered or not.
updateiconUpdates the icon of the area. Mainly used for flashing it red or blue. See: old party lights
usageReturns the current usage of the specified channel
use_powerUses the specified ammount of power for the specified channel

Var Details

active

TRUE if a dude is here (DOES NOT APPLY TO THE "SPACE" AREA)

being_captured

Is the area currently being captured/tagged in gang mode

blocked

set to TRUE to inhibit entrance into this area, may not work completely yet.

blocked_waypoint

if set and a blocked person makes their way into here via Bad Ways, they'll be teleported here instead of nullspace. use a path!

do_not_irradiate

filler_turf

if set, replacewithspace in this area instead replaces with this turf type

gang_base

is this a gang's base (uncaptureable)?

gang_owners

gang that owns this area in gang mode

irradiated

space blowouts use this, should always be 0

is_centcom

for escape checks

machines

Local list of obj/machines found in the area

map_generator

This datum, if set, allows terrain generation behavior to be ran on world/proc/init()

may_eat_here_in_restricted_z

If the area is on a restricted z leve, this controls if people can eat within it. (The reason for this might shock you!)

permarads

Blowouts don't set irradiated on this area back to zero.

population

List of all dudes who are here

sanctuary

set to TRUE to inhibit attacks in this area.

sound_environment

default environment for sounds - see sound datum vars documentation for the presets.

storming

for Battle Royale gamemode

teleport_blocked

Cannot teleport into this area without some explicit set_loc thing. 1 for most things, 2 for definitely everything.

workplace

Do people work here?

Proc Details

Entered

Gets called when a movable atom enters an area.

Exited

Gets called when a movable atom exits an area.

clear_usage

sets all current usage of power to 0

find_middle

Returns the turf in the middle of the area. Returns null if none can be found.

firealert

Causes a fire alert in the area if there is not one already set. Notifies AIs.

firereset

Resets the fire alert in the area. Notifies AIs.

power_change

Called when power status changes. Updates machinery and the icon of the area.

poweralert

Causes a power alert in the area. Notifies AIs.

powered

Determines is an area is powered or not.

updateicon

Updates the icon of the area. Mainly used for flashing it red or blue. See: old party lights

usage

Returns the current usage of the specified channel

use_power

Uses the specified ammount of power for the specified channel