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
aesthetic	If the weather has no purpose other than looks
area_type	Types of area to affect
barometer_predictable	Whether a barometer can predict when the weather will happen
desc	description of weather
end_duration	In deciseconds, 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
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_z_levels	The list of z-levels that this weather is actively affecting
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
perpetual	This causes the weather to only end if forced to
probability	Weight amongst other eligible weather. If zero, will never happen randomly.
protect_indoors	TRUE value protects areas with outdoors marked as false, regardless of area type
protected_areas	Areas that are protected and excluded from the affected areas.
stage	The stage of the weather, from 1-4
target_trait	The z-level trait to affect when run randomly or when not overridden.
telegraph_duration	In deciseconds, 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
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	In deciseconds, 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_message	Displayed in chat once the weather begins in earnest
weather_overlay	Area overlay while the weather is occuring
weather_sound	Looping sound while weather is occuring
Procs
can_weather_act	Returns TRUE if the living mob can be affected by the weather
end	Fully ends the weather
generate_overlay_cache	Returns a list of visual offset -> overlays to use
start	Starts the actual weather and effects from it
telegraph	Telegraphs the beginning of the weather on the impacted z levels
update_areas	Updates the overlays on impacted areas
weather_act	Affects the mob with whatever the weather does
wind_down	Weather enters the winding down phase, stops effects

Var Details

var
aesthetic
–

If the weather has no purpose other than looks

var
area_type
–

Types of area to affect

var
barometer_predictable
–

Whether a barometer can predict when the weather will happen

var
desc
–

description of weather

var
end_duration
–

In deciseconds, 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
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_z_levels
–

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

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

This causes the weather to only end if forced to

var
probability
–

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

var
protect_indoors
–

TRUE value protects areas with outdoors marked as false, regardless of area type

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

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

var
telegraph_duration
–

In deciseconds, 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
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
–

In deciseconds, 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_message
–

Displayed in chat once the weather begins in earnest

var
weather_overlay
–

Area overlay while the weather is occuring

var
weather_sound
–

Looping sound while weather is occuring

Proc Details

proc
can_weather_act
(/mob/living/mob_to_check)

Returns TRUE if the living mob 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
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
update_areas
()

Updates the overlays on impacted areas

proc
weather_act
(/mob/living/L)

Affects the mob 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 aesthetic –

var area_type –

var barometer_predictable –

var desc –

var end_duration –

var end_message –

var end_overlay –

var end_sound –

var immunity_type –

var impacted_areas – /list

var impacted_z_levels –

var name –

var next_hit_time –

var overlay_cache – /list

var overlay_layer –

var overlay_plane –

var perpetual –

var probability –

var protect_indoors –

var protected_areas – /list

var stage –

var target_trait –

var telegraph_duration –

var telegraph_message –

var telegraph_overlay –

var telegraph_sound –

var use_glow –

var weather_color –

var weather_duration –

var weather_duration_lower –

var weather_duration_upper –

var weather_message –

var weather_overlay –

var weather_sound –