byond - Modules - TypesVar Details - Proc Details

Unknown

Vars

allow_constructionwhether or not you can build things like barricades in this area
ambience_exteriorDefault sound to play as ambience for clients entering the area
area_has_base_lightingWhether this area has a currently active base lighting, bool
base_lighting_alphaalpha 0-255 of lighting_effect and thus baselighting intensity
base_lighting_colorThe colour of the light acting on this area
block_game_interactionIf this area is outside the game's normal interactivity and should be excluded from things like EOR reports and crew monitors. Doesn't need to be set for areas/Z levels that are marked as admin-only
current_resin_countHow much destroyable resin currently exists in this area
flags_areaBitfield of special area features
is_landing_zoneprimarily used to prevent mortars from hitting this location
is_resin_allowedcan xenos weed, place resin holes or dig tunnels at said areas
lighting_effectThe mutable appearance we underlay to show light
linked_lzWhich, if any, LZ this area belongs to. If an area belongs to an LZ, if that LZ is designated as the primary LZ, all weeds will be destroyed and further weed placement disabled
openable_turf_countHow many potentially open turfs can exist in this area
resin_construction_allowedAllow construction of resin walls, and other special
sound_environmentDefault sound environment to use for the area, as list or int BYOND preset: http://www.byond.com/docs/ref/#/sound/var/environment
static_lightingWhether this area allows static lighting and thus loads the lighting objects
unoviable_timerHow long this area should be un-oviable

Procs

afterShuttleMoveCalled on areas after everything has been moved
beforeShuttleMoveCalled on areas before anything has been moved returns the new move_mode (based on the old)
get_sound_ambienceReturns the correct ambience sound track for a client in this area
handle_ovi_timerFrom roundstart, sets a timer to make an area oviable.
onShuttleMoveCalled on areas to move their turf between areas
purge_weedsPurges existing weeds, and prevents future weeds from being placed.

Var Details

allow_construction

whether or not you can build things like barricades in this area

ambience_exterior

Default sound to play as ambience for clients entering the area

area_has_base_lighting

Whether this area has a currently active base lighting, bool

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

block_game_interaction

If this area is outside the game's normal interactivity and should be excluded from things like EOR reports and crew monitors. Doesn't need to be set for areas/Z levels that are marked as admin-only

current_resin_count

How much destroyable resin currently exists in this area

flags_area

Bitfield of special area features

is_landing_zone

primarily used to prevent mortars from hitting this location

is_resin_allowed

can xenos weed, place resin holes or dig tunnels at said areas

lighting_effect

The mutable appearance we underlay to show light

linked_lz

Which, if any, LZ this area belongs to. If an area belongs to an LZ, if that LZ is designated as the primary LZ, all weeds will be destroyed and further weed placement disabled

openable_turf_count

How many potentially open turfs can exist in this area

resin_construction_allowed

Allow construction of resin walls, and other special

sound_environment

Default sound environment to use for the area, as list or int BYOND preset: http://www.byond.com/docs/ref/#/sound/var/environment

static_lighting

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

unoviable_timer

How long this area should be un-oviable

Proc Details

afterShuttleMove

Called on areas after everything has been moved

beforeShuttleMove

Called on areas before anything has been moved returns the new move_mode (based on the old)

get_sound_ambience

Returns the correct ambience sound track for a client in this area

handle_ovi_timer

From roundstart, sets a timer to make an area oviable.

onShuttleMove

Called on areas to move their turf between areas

purge_weeds

Purges existing weeds, and prevents future weeds from being placed.