weather

Causes weather to occur on a z level in certain area types

The effects of weather occur across an entire z-level. For instance, lavaland has periodic ash storms that scorch most unprotected creatures. Weather always occurs on different z levels at different times, regardless of weather type. Can have custom durations, targets, and can automatically protect indoor areas.

Vars
area_type	Types of area to affect
blacklist_weather_reagents	A list of reagents that are forbidden from being selected when there is no whitelist and the reagents are randomized
current_mobs	List of current mobs being processed by weather
currentpart	The current section our weather subsystem is processing
desc	description of weather
end_duration	How long the "wind-down" graphic will appear before vanishing entirely
end_message	Displayed once the weather is over
end_overlay	Area overlay while weather is ending
end_sound	Sound that plays while weather is ending
end_sound_vol	Volume of the sound that plays while weather is ending
immunity_type	Used by mobs (or movables containing mobs, such as enviro bags) to prevent them from being affected by the weather.
impacted_areas	Areas to be affected by the weather, calculated when the weather begins
impacted_areas_blend_modes	Areas affected by weather have their blend modes changed
impacted_areas_weighted	A weighted list of areas impacted by weather, where weights reflect the total turf count in each area.
impacted_z_levels	The list of z-levels that this weather is actively affecting
impacted_z_levels_weighted	A weighted list of z-levels impacted by weather, where weights reflect the total turf count on each level
name	name of weather
next_hit_time	For barometers to know when the next storm will hit
overlay_cache	List of all overlays to apply to our turfs
overlay_layer	Since it's above everything else, this is the layer used by default.
overlay_plane	Plane for the overlay
probability	Weight amongst other eligible weather. If zero, will never happen randomly.
protected_areas	Areas that are protected and excluded from the affected areas.
stage	The stage of the weather, from 1-4
subsystem_tasks	The list of allowed tasks our weather subsystem is allowed to process (determined by weather_flags)
target_trait	The z-level trait to affect when run randomly or when not overridden.
telegraph_duration	How long from the beginning of the telegraph until the weather begins
telegraph_message	The message displayed in chat to foreshadow the weather's beginning
telegraph_overlay	The overlay applied to all tiles on the z-level
telegraph_sound	The sound file played to everyone on an affected z-level
telegraph_sound_vol	Volume of the telegraph sound
thunder_color	Color to apply to thunder while weather is occuring
thunder_iteration	The weather thunder counter to keep track of how much thunder we have processed so far
thunder_turfs_per_tick	The calculated amount of turfs that get thunder effects processed each tick (this gets calculated do not manually set this var)
total_impacted_turfs	The total number of turfs impacted by weather across all z-levels and areas.
turf_iteration	The weather turf counter to keep track of how many turfs we have processed so far
turf_thunder_chance	The chance, per tick, a turf will have a thunder strike applied to it. This is a decimal value, 1.00 = 100%, 0.50 = 50%, etc. Recommend setting this really low near 0.001 (results in 1 in 1000 affected turfs having thunder strikes applied per tick)
turf_weather_chance	The chance, per tick, a turf will have weather effects applied to it. This is a decimal value, 1.00 = 100%, 0.50 = 50%, etc. Recommend setting this low near 0.01 (results in 1 in 100 affected turfs having weather reagents applied per tick)
use_glow	If this bit of weather should also draw an overlay that's uneffected by lighting onto the area Taken from weather_glow.dmi
weather_color	Color to apply to the area while weather is occuring
weather_duration	How long the weather lasts once it begins
weather_duration_lower	See above - this is the lowest possible duration
weather_duration_upper	See above - this is the highest possible duration
weather_flags	List of weather bitflags that determines effects (see \code__DEFINES\weather.dm)
weather_message	Displayed in chat once the weather begins in earnest
weather_overlay	Area overlay while the weather is occuring
weather_reagent	The selected reagent that will be rained down
weather_reagent_holder	The actual atom that holds our reagents that is held in nullspace
weather_sound	The sound played to everyone on an affected z-level when weather is occuring (does not loop)
weather_temperature	The temperature of our weather that is applied to weather reagents and mobs using adjust_bodytemperature()
weather_turfs_per_tick	The calculated amount of turfs that get weather effects processed each tick (this gets calculated do not manually set this var)
whitelist_weather_reagents	A list (supports regular, nested, and weighted) of possible reagents that will rain down from the sky. Only one of these will be selected to be used as the reagent
Procs
can_weather_act_mob	Returns TRUE if the living mob can be affected by the weather
can_weather_act_turf	Returns TRUE if the turf can be affected by the weather
end	Fully ends the weather
generate_overlay_cache	Returns a list of visual offset -> overlays to use
pick_turf	Selects a turf impacted by weather, if available, otherwise returns null
start	Starts the actual weather and effects from it
telegraph	Telegraphs the beginning of the weather on the impacted z levels
thunder_act_turf	Affects the turf with thunder
update_areas	Updates the overlays on impacted areas
weather_act_mob	Affects the mob with whatever the weather does
weather_act_turf	Affects the turf with whatever the weather does
wind_down	Weather enters the winding down phase, stops effects

Var Details

var
area_type
–

Types of area to affect

var
blacklist_weather_reagents
– /list

A list of reagents that are forbidden from being selected when there is no whitelist and the reagents are randomized

var
current_mobs
– /list

List of current mobs being processed by weather

var
currentpart
–

The current section our weather subsystem is processing

var
desc
–

description of weather

var
end_duration
–

How long the "wind-down" graphic will appear before vanishing entirely

var
end_message
–

Displayed once the weather is over

var
end_overlay
–

Area overlay while weather is ending

var
end_sound
–

Sound that plays while weather is ending

var
end_sound_vol
–

Volume of the sound that plays while weather is ending

var
immunity_type
–

Used by mobs (or movables containing mobs, such as enviro bags) to prevent them from being affected by the weather.

var
impacted_areas
– /list

Areas to be affected by the weather, calculated when the weather begins

var
impacted_areas_blend_modes
– /list

Areas affected by weather have their blend modes changed

var
impacted_areas_weighted
– /list

A weighted list of areas impacted by weather, where weights reflect the total turf count in each area.

var
impacted_z_levels
–

The list of z-levels that this weather is actively affecting

var
impacted_z_levels_weighted
– /list

A weighted list of z-levels impacted by weather, where weights reflect the total turf count on each level

var
name
–

name of weather

var
next_hit_time
–

For barometers to know when the next storm will hit

var
overlay_cache
– /list

List of all overlays to apply to our turfs

var
overlay_layer
–

Since it's above everything else, this is the layer used by default.

var
overlay_plane
–

Plane for the overlay

var
probability
–

Weight amongst other eligible weather. If zero, will never happen randomly.

var
protected_areas
– /list

Areas that are protected and excluded from the affected areas.

var
stage
–

The stage of the weather, from 1-4

var
subsystem_tasks
– /list

The list of allowed tasks our weather subsystem is allowed to process (determined by weather_flags)

var
target_trait
–

The z-level trait to affect when run randomly or when not overridden.

var
telegraph_duration
–

How long from the beginning of the telegraph until the weather begins

var
telegraph_message
–

The message displayed in chat to foreshadow the weather's beginning

var
telegraph_overlay
–

The overlay applied to all tiles on the z-level

var
telegraph_sound
–

The sound file played to everyone on an affected z-level

var
telegraph_sound_vol
–

Volume of the telegraph sound

var
thunder_color
–

Color to apply to thunder while weather is occuring

var
thunder_iteration
–

The weather thunder counter to keep track of how much thunder we have processed so far

var
thunder_turfs_per_tick
–

The calculated amount of turfs that get thunder effects processed each tick (this gets calculated do not manually set this var)

var
total_impacted_turfs
–

The total number of turfs impacted by weather across all z-levels and areas.

var
turf_iteration
–

The weather turf counter to keep track of how many turfs we have processed so far

var
turf_thunder_chance
–

The chance, per tick, a turf will have a thunder strike applied to it. This is a decimal value, 1.00 = 100%, 0.50 = 50%, etc. Recommend setting this really low near 0.001 (results in 1 in 1000 affected turfs having thunder strikes applied per tick)

var
turf_weather_chance
–

The chance, per tick, a turf will have weather effects applied to it. This is a decimal value, 1.00 = 100%, 0.50 = 50%, etc. Recommend setting this low near 0.01 (results in 1 in 100 affected turfs having weather reagents applied per tick)

var
use_glow
–

If this bit of weather should also draw an overlay that's uneffected by lighting onto the area Taken from weather_glow.dmi

var
weather_color
–

Color to apply to the area while weather is occuring

var
weather_duration
–

How long the weather lasts once it begins

var
weather_duration_lower
–

See above - this is the lowest possible duration

var
weather_duration_upper
–

See above - this is the highest possible duration

var
weather_flags
–

List of weather bitflags that determines effects (see \code__DEFINES\weather.dm)

var
weather_message
–

Displayed in chat once the weather begins in earnest

var
weather_overlay
–

Area overlay while the weather is occuring

var
weather_reagent
– /datum/reagent

The selected reagent that will be rained down

var
weather_reagent_holder
– /obj/effect/abstract

The actual atom that holds our reagents that is held in nullspace

var
weather_sound
–

The sound played to everyone on an affected z-level when weather is occuring (does not loop)

var
weather_temperature
–

The temperature of our weather that is applied to weather reagents and mobs using adjust_bodytemperature()

var
weather_turfs_per_tick
–

The calculated amount of turfs that get weather effects processed each tick (this gets calculated do not manually set this var)

var
whitelist_weather_reagents
– /list

A list (supports regular, nested, and weighted) of possible reagents that will rain down from the sky. Only one of these will be selected to be used as the reagent

Proc Details

proc
can_weather_act_mob
(/mob/living/mob_to_check)

Returns TRUE if the living mob can be affected by the weather

proc
can_weather_act_turf
(/turf/valid_weather_turf)

Returns TRUE if the turf can be affected by the weather

proc
end
()

Fully ends the weather

Effects no longer occur and area overlays are removed Removes weather from processing completely

proc
generate_overlay_cache
()

Returns a list of visual offset -> overlays to use

proc
pick_turf
()

Selects a turf impacted by weather, if available, otherwise returns null

proc
start
()

Starts the actual weather and effects from it

Updates area overlays and sends sounds and messages to mobs to notify them Begins dealing effects from weather to mobs in the area

proc
telegraph
()

Telegraphs the beginning of the weather on the impacted z levels

Sends sounds and details to mobs in the area Calculates duration and hit areas, and makes a callback for the actual weather to start

proc
thunder_act_turf
(/turf/open/weather_turf)

Affects the turf with thunder

proc
update_areas
()

Updates the overlays on impacted areas

proc
weather_act_mob
(/mob/living/living)

Affects the mob with whatever the weather does

proc
weather_act_turf
(/turf/open/weather_turf)

Affects the turf with whatever the weather does

proc
wind_down
()

Weather enters the winding down phase, stops effects

Updates areas to be in the winding down phase Sends sounds and messages to mobs to notify them

weather /datum/weather

Vars

Procs

Var Details

var area_type –

var blacklist_weather_reagents – /list

var current_mobs – /list

var currentpart –

var desc –

var end_duration –

var end_message –

var end_overlay –

var end_sound –

var end_sound_vol –

var immunity_type –

var impacted_areas – /list

var impacted_areas_blend_modes – /list

var impacted_areas_weighted – /list

var impacted_z_levels –

var impacted_z_levels_weighted – /list

var name –

var next_hit_time –

var overlay_cache – /list

var overlay_layer –

var overlay_plane –

var probability –

var protected_areas – /list

var stage –

var subsystem_tasks – /list

var target_trait –

var telegraph_duration –

var telegraph_message –

var telegraph_overlay –

var telegraph_sound –

var telegraph_sound_vol –

var thunder_color –

var thunder_iteration –

var thunder_turfs_per_tick –

var total_impacted_turfs –

var turf_iteration –

var turf_thunder_chance –

var turf_weather_chance –

var use_glow –

var weather_color –

var weather_duration –

var weather_duration_lower –

var weather_duration_upper –

var weather_flags –

var weather_message –

var weather_overlay –

var weather_reagent – /datum/reagent

var weather_reagent_holder – /obj/effect/abstract

var weather_sound –

var weather_temperature –

var weather_turfs_per_tick –

var whitelist_weather_reagents – /list