@adatechnology/game-fluids-three 0.2.3 → 0.3.0

package/dist/index.d.ts

@@ -124,6 +124,8 @@ declare class FilmGrid {
     setView(camera: Vec3, forward: Vec3, time: number): void;
     /** Steps the film one frame and refreshes the texture cells that may have changed. Returns the rectangle to upload, or null. */
     update(dt: number, dryingSeconds: number): CellRect | null;
+    /** Clears the cells less than `maxDryness` dry and sends the rectangle that held them up with the next update. Returns how many it cleared. */
+    wash(maxDryness?: number): number;
     private takePending;
     /** The mean dryness of the cells that are wet (1 when nothing is). */
     dryness(): number;
@@ -182,6 +184,8 @@ interface FilmManagerOptions {
     /** Colour of the surface under the film (default the page's grey). */
     base?: number;
     maxGrids?: number;
+    /** The liquids rain washes while fresh (`wash`). Default `blood` and `old_blood`. */
+    washable?: readonly string[];
     /** Metres from the player past which a grid is not simulated and is baked. */
     range?: number;
     /** Milliseconds of film simulation per frame; the grids left out wait for the next frame. */
@@ -246,6 +250,7 @@ declare class FilmManager {
     private readonly staging;
     private readonly now;
     private rain;
+    private drying;
     private time;
     private bakedCount;
     private last;
@@ -256,7 +261,13 @@ declare class FilmManager {
     list(): readonly FilmGrid[];
     setWeather(weather: {
         rain: number;
+        drying?: number;
     }): void;
+    /**
+     * Rain washes the fresh stain away (the visor's `ZG.wipe` with mode "chuva"): in the grids of the washable liquids (default blood and old blood), the
+     * cells that are less than `maxDryness` dry (default 0.5) are cleared. Returns how many cells it cleared.
+     */
+    wash(maxDryness?: number): number;
     /** Throws a drop of a liquid: it lands in the grid under it (made on the spot) and leaves the impact splash. Null when it is out of range or has no surface. */
     launch(request: FilmLaunch): FilmGrid | null;
     /** A drip: a bead swells at `point`, detaches and falls every `every` seconds on average. Replaces the grid's drip. */
@@ -362,7 +373,10 @@ interface FilmBridge {
     /** Weather of the film (the Phase 6 hook): while it rains the film does not dry and spreads 1.5 times faster. */
     setWeather(weather: {
         rain: number;
+        drying?: number;
     }): void;
+    /** Rain washes the fresh film of the washable liquids (less than half dry, or `maxDryness`). Returns the cells it cleared. */
+    wash(maxDryness?: number): number;
     /** Streams of the world that feed the film right now. */
     readonly leaks: number;
     /** Feeds the leaks: call it each frame with the frame's seconds, before or after `manager.update`. */