Table of Contents

Class RainfallSettings

Namespace
DFA.Puddlecraft

The falling rain, spout water and drip-edge water: which particle prefabs and material draw them, and how the rain falls. The prefabs and material hold how it looks (sizes, colours); these settings decide where and how often it falls.

[Serializable]
public sealed class RainfallSettings
Inheritance
RainfallSettings

Properties

dripMaterial

Material for the water running off drip edges, or null to draw none.

public Material dripMaterial { get; set; }

Property Value

Material

dripPourRate

Drops per metre of edge per second at which a drip edge pours in threads instead of dripping (5 to 200).

public float dripPourRate { get; set; }

Property Value

float

dropRate

Drops per square metre per second near the camera at rain intensity 1 (0 to 150); beyond a third of the radius they thin out with distance.

public float dropRate { get; set; }

Property Value

float

fallSpeed

How fast drops fall, in metres per second (2 to 15).

public float fallSpeed { get; set; }

Property Value

float

fallbackDepth

How far below the camera drops with no ground under them fall before vanishing without a splash, in metres (0 or more).

public float fallbackDepth { get; set; }

Property Value

float

mistFrom

Rain intensity where mist starts to form (0 to 1); it builds up to full at intensity 1.

public float mistFrom { get; set; }

Property Value

float

mistRadius

Mist forms between 5 m and this distance from the camera, in metres (2 to 120).

public float mistRadius { get; set; }

Property Value

float

mistRate

Mist puffs per square metre per second in a downpour (0 to 0.5). The renderer feature's Medium and Low quality tiers make 60% and 40% of them.

public float mistRate { get; set; }

Property Value

float

radius

Drops land within this distance of the camera, in metres (4 to 120).

public float radius { get; set; }

Property Value

float

rainParticles

Particle prefab for the falling rain, splashes and mist, or null for no particle rain. Puddlecraft spawns it around the camera in Play mode, and around the Scene view camera in Edit mode with Preview in Scene View on.

public PuddlecraftRain rainParticles { get; set; }

Property Value

PuddlecraftRain

rings

Rings on standing water where drops land.

public bool rings { get; set; }

Property Value

bool

spawnHeight

Drops start this far above the camera, in metres (2 to 40).

public float spawnHeight { get; set; }

Property Value

float

splashRadius

Only raindrops and drip-edge drips landing within this distance of the camera (along the ground) splash, in metres (1 to 120).

public float splashRadius { get; set; }

Property Value

float

spoutEffects

Particle prefab for the water pouring from each rain spout, or null. A spout with its own Rain Spout Effects child uses that instead.

public RainSpoutEffects spoutEffects { get; set; }

Property Value

RainSpoutEffects

windSpeed

Sideways speed at full wind, in metres per second (0 to 15).

public float windSpeed { get; set; }

Property Value

float