river_spawner

A straightforward system for making "rivers", paths made up of a specific turf type that are generated in a random path on a z-level.

Vars
collected_turfs	To hold all the found turfs to convert to the lava type
ignore_bridges	Do we ignore building any bridges?
river_turf_type	The base type that makes up the river.
shoreline_turf_type	The turf used when a spread of the tile stops.
spread_prob	The initial probability that a river tile will spread to adjacent tiles.
spread_prob_loss	The amount reduced from spread_prob on every spread iteration to cause falloff.
target_z	The z-level to generate the river on. There is theoretically nothing stopping this from being used across z-levels, but we're keeping things simple.
warning	Does the lava generate a warning beforehand
whitelist_area_type	The area that the spawner is allowed to spread or detour to.
whitelist_turf_type	The type that the spawner is allowed to spread or detour to.
Procs
convert_turf	actually convert the turf
generate	Generate a river between the bounds specified by (`min_x`, `min_y`) and (`max_x`, `max_y`).
handle_change	handles changing the lava turfs, and if it should delay it and place warnings

Var Details

var
collected_turfs
– /list

To hold all the found turfs to convert to the lava type

var
ignore_bridges

Do we ignore building any bridges?

var
river_turf_type

The base type that makes up the river.

var
shoreline_turf_type

The turf used when a spread of the tile stops.

var
spread_prob

The initial probability that a river tile will spread to adjacent tiles.

var
spread_prob_loss

The amount reduced from spread_prob on every spread iteration to cause falloff.

var
target_z

The z-level to generate the river on. There is theoretically nothing stopping this from being used across z-levels, but we're keeping things simple.

var
warning

Does the lava generate a warning beforehand

var
whitelist_area_type

The area that the spawner is allowed to spread or detour to.

var
whitelist_turf_type

The type that the spawner is allowed to spread or detour to.

Proc Details

proc
convert_turf
(/turf/cur_turf, ignore_bridges)

actually convert the turf

proc
generate
(nodes, min_x, min_y, max_x, max_y, ignore_bridges, warning)

Generate a river between the bounds specified by (min_x, min_y) and (max_x, max_y).

nodes is the number of unique points in those bounds the river will connect to. Note that nodes says little about the resultant size of the river due to its ability to detour far away from the direct path between them. set ignore_bridges TRUE to not spawn any new bridges, and set warning to TRUE to allow for the new generations to have a telegraphed icon first

proc
handle_change
(warning, ignore_bridges)

handles changing the lava turfs, and if it should delay it and place warnings

river_spawner /datum/river_spawner

Vars

Procs

Var Details

var collected_turfs – /list

var ignore_bridges

var river_turf_type

var shoreline_turf_type

var spread_prob

var spread_prob_loss

var target_z

var warning

var whitelist_area_type

var whitelist_turf_type