API Reference
The scripting API of Puddlecraft: the public types and members you can use from your own code.
| Namespace | Assembly | What's in it |
|---|---|---|
| DFA.Puddlecraft | DFA.Puddlecraft |
Runtime components, assets and settings, and the gameplay and audio API. |
| DFA.PuddlecraftEditor | DFA.Puddlecraft.Editor |
Scripted setup for editor scripts, build scripts and CI. Editor only. |
Where to start
- PuddlecraftController and its RainState: drive the weather.
- PuddleQuery: how wet the ground is, and whether a point is under water.
- PuddlecraftRipples and PuddleRippleEmitter: push ripples into water.
- PuddlecraftTracks: leave wet footprints and tyre tracks on dry ground.
- PuddlecraftEvents: react to drips landing.
- CoverVolume: how sheltered a point is, and open or shut a window or door.
- PuddlecraftWind and PuddlecraftAudio: read the wind, and how exposed the listener is to the rain.
- PuddlecraftSetup: set up scenes from code.
The Scripting page walks through these with examples.