@woosh/meep-engine 3.3.0 → 3.4.0

package/src/engine/ecs/util/hideEntityGracefully.js

@@ -1,208 +1,196 @@
-import {
-    TransitionPropertyVectorXBehavior
-} from "../../../../../model/game/story/behaviors/generic/TransitionPropertyVectorXBehavior.js";
-import { TweenVector1Behavior } from "../../../../../model/game/util/behavior/TweenVector1Behavior.js";
-import { TweenVector3Behavior } from "../../../../../model/game/util/behavior/TweenVector3Behavior.js";
-import { max2 } from "../../../core/math/max2.js";
-import { min2 } from "../../../core/math/min2.js";
-import { Light } from "../../graphics/ecs/light/Light.js";
-import { SGMesh, SGMeshFlags } from "../../graphics/ecs/mesh-v2/aggregate/SGMesh.js";
-import Trail2D from "../../graphics/ecs/trail2d/Trail2D.js";
-import { Trail2DFlags } from "../../graphics/ecs/trail2d/Trail2DFlags.js";
-import { ParticleEmitter } from "../../graphics/particles/particular/engine/emitter/ParticleEmitter.js";
-import { ParticleEmitterFlag } from "../../graphics/particles/particular/engine/emitter/ParticleEmitterFlag.js";
-import { SequenceBehavior } from "../../intelligence/behavior/composite/SequenceBehavior.js";
-import { BehaviorComponent } from "../../intelligence/behavior/ecs/BehaviorComponent.js";
-import { DieBehavior } from "../../intelligence/behavior/ecs/DieBehavior.js";
-import { DelayBehavior } from "../../intelligence/behavior/util/DelayBehavior.js";
-import { SoundEmitter } from "../../sound/ecs/emitter/SoundEmitter.js";
-import { Transform } from "../transform/Transform.js";
-
-/**
- * @readonly
- * @type {number}
- */
-const SHUTDOWN_GRACE_PERIOD = 60;
-
-/**
- *
- * @type {Map<Class|function, (component: T, entity?: Entity, createEntity?: function, createEntityContext?: *) => number>}
- */
-const component_shutdown = new Map();
-
-/**
- * @template T
- * @param {Class<T>} type
- * @param {(component: T, entity?: Entity, createEntity?: function, createEntityContext?: *) => number} method
- */
-function addShutdown(type, method) {
-    component_shutdown.set(type, method);
-}
-
-addShutdown(ParticleEmitter, emitter => {
-
-    //stop emission
-    emitter.clearFlag(ParticleEmitterFlag.Emitting);
-
-    //figure out how long the emitter should stay alive
-    const maxLife = emitter.computeMaxEmittingParticleLife(SHUTDOWN_GRACE_PERIOD);
-
-    return maxLife;
-});
-
-addShutdown(Trail2D, trail => {
-    trail.clearFlag(Trail2DFlags.Spawning);
-
-    return trail.maxAge;
-});
-
-addShutdown(SGMesh, (mesh, builder, createEntity, createEntityThisArg) => {
-
-    /**
-     *
-     * @type {Transform}
-     */
-    const transform = builder.getComponent(Transform);
-
-    let delay = 0;
-
-    if (mesh !== null && transform !== null) {
-
-        /*
-         Loaded only. The component this used to read carried an `InView` flag a CPU culling pass
-         wrote, and §4.5 retires that pass — nothing on either renderer can say whether an entity is
-         on screen now, so what is left is whether there is a model to shrink at all.
-        */
-        if (mesh.getFlag(SGMeshFlags.Loaded) && !transform.scale.isZero()) {
-            const scale = new TweenVector3Behavior();
-
-            scale.startValue.copy(transform.scale);
-            scale.targetValue.set(0, 0, 0);
-            scale.target = transform.scale;
-
-            scale.duration = 0.2;
-
-            delay = max2(scale.duration, delay);
-
-            const eb = createEntity.call(createEntityThisArg);
-
-            eb.add(BehaviorComponent.from(SequenceBehavior.from([
-                scale,
-                DieBehavior.create()
-            ])));
-
-        } else {
-            transform.scale.set(0, 0, 0);
-        }
-
-    }
-
-
-    return delay;
-});
-
-addShutdown(Light, (light, builder, createEntity, createEntityThisArg) => {
-
-
-    let delay = 0.2;
-
-
-    const eb = createEntity.call(createEntityThisArg);
-
-    eb.add(BehaviorComponent.from(SequenceBehavior.from([
-        TransitionPropertyVectorXBehavior.from({
-            component: 'Light',
-            path: 'intensity',
-            target: [0],
-            duration: delay,
-            entity: builder.id
-        }),
-        DieBehavior.create()
-    ])));
-
-    return delay;
-});
-
-addShutdown(SoundEmitter, (soundEmitter, builder, createEntity, createEntityThisArg) => {
-    let delay = 0;
-
-    if (soundEmitter.volume.getValue() > 0) {
-
-        const tracks = soundEmitter.tracks.asArray();
-
-        const n = tracks.length;
-
-
-        for (let i = 0; i < n; i++) {
-            const soundTrack = tracks[i];
-
-            if (soundTrack.volume > 0) {
-
-                const setVolume = new TweenVector1Behavior();
-
-                setVolume.startValue = soundEmitter.volume.getValue();
-                setVolume.targetValue = 0;
-
-                setVolume.target = soundEmitter.volume;
-
-                setVolume.duration = 2.7;
-
-                delay = SHUTDOWN_GRACE_PERIOD;
-
-                const eb = createEntity.call(createEntityThisArg);
-
-                eb.add(BehaviorComponent.from(SequenceBehavior.from([
-                    DelayBehavior.from(SHUTDOWN_GRACE_PERIOD - setVolume.duration),
-                    setVolume,
-                    DieBehavior.create()
-                ])));
-
-                break;
-            }
-        }
-    }
-
-    return delay;
-});
-
-/**
- *
- * @param {Entity} builder
- * @param {function():Entity} createEntity
- * @param {*} [createEntityThisArg]
- * @return {number} duration in seconds until the entity is completely hidden
- */
-export function hideEntityGracefully(builder, createEntity, createEntityThisArg) {
-    if (!builder.isBuilt) {
-        // already destroyed
-        return 0;
-    }
-
-    let delay = 0;
-
-    const components = builder.components;
-
-    const component_count = components.length;
-
-    for (let i = 0; i < component_count; i++) {
-        const component = components[i];
-
-        const shutdown_method = component_shutdown.get(Object.getPrototypeOf(component).constructor);
-
-        if (shutdown_method === undefined) {
-            continue;
-        }
-
-        const sd = shutdown_method(component, builder, createEntity, createEntityThisArg);
-
-        if (Number.isNaN(sd) || !Number.isFinite(sd)) {
-            continue;
-        }
-
-        delay = max2(sd, delay);
-    }
-
-    delay = min2(delay, SHUTDOWN_GRACE_PERIOD);
-
-    return delay;
-}
+import {
+    TransitionPropertyVectorXBehavior
+} from "../../../../../model/game/story/behaviors/generic/TransitionPropertyVectorXBehavior.js";
+import { TweenVector1Behavior } from "../../../../../model/game/util/behavior/TweenVector1Behavior.js";
+import { TweenVector3Behavior } from "../../../../../model/game/util/behavior/TweenVector3Behavior.js";
+import { max2 } from "../../../core/math/max2.js";
+import { min2 } from "../../../core/math/min2.js";
+import { Light } from "../../graphics/ecs/light/Light.js";
+import { SGMesh, SGMeshFlags } from "../../graphics/ecs/mesh-v2/aggregate/SGMesh.js";
+import Trail2D from "../../graphics/ecs/trail2d/Trail2D.js";
+import { Trail2DFlags } from "../../graphics/ecs/trail2d/Trail2DFlags.js";
+import { ParticleEmitter } from "../../graphics/particles/particular/engine/emitter/ParticleEmitter.js";
+import { ParticleEmitterFlag } from "../../graphics/particles/particular/engine/emitter/ParticleEmitterFlag.js";
+import { SequenceBehavior } from "../../intelligence/behavior/composite/SequenceBehavior.js";
+import { BehaviorComponent } from "../../intelligence/behavior/ecs/BehaviorComponent.js";
+import { DieBehavior } from "../../intelligence/behavior/ecs/DieBehavior.js";
+import { DelayBehavior } from "../../intelligence/behavior/util/DelayBehavior.js";
+import { AudioEmitter } from "../../sound/ecs/audio/AudioEmitter.js";
+import { Transform } from "../transform/Transform.js";
+
+/**
+ * @readonly
+ * @type {number}
+ */
+const SHUTDOWN_GRACE_PERIOD = 60;
+
+/**
+ *
+ * @type {Map<Class|function, (component: T, entity?: Entity, createEntity?: function, createEntityContext?: *) => number>}
+ */
+const component_shutdown = new Map();
+
+/**
+ * @template T
+ * @param {Class<T>} type
+ * @param {(component: T, entity?: Entity, createEntity?: function, createEntityContext?: *) => number} method
+ */
+function addShutdown(type, method) {
+    component_shutdown.set(type, method);
+}
+
+addShutdown(ParticleEmitter, emitter => {
+
+    //stop emission
+    emitter.clearFlag(ParticleEmitterFlag.Emitting);
+
+    //figure out how long the emitter should stay alive
+    const maxLife = emitter.computeMaxEmittingParticleLife(SHUTDOWN_GRACE_PERIOD);
+
+    return maxLife;
+});
+
+addShutdown(Trail2D, trail => {
+    trail.clearFlag(Trail2DFlags.Spawning);
+
+    return trail.maxAge;
+});
+
+addShutdown(SGMesh, (mesh, builder, createEntity, createEntityThisArg) => {
+
+    /**
+     *
+     * @type {Transform}
+     */
+    const transform = builder.getComponent(Transform);
+
+    let delay = 0;
+
+    if (mesh !== null && transform !== null) {
+
+        /*
+         Loaded only. The component this used to read carried an `InView` flag a CPU culling pass
+         wrote, and §4.5 retires that pass — nothing on either renderer can say whether an entity is
+         on screen now, so what is left is whether there is a model to shrink at all.
+        */
+        if (mesh.getFlag(SGMeshFlags.Loaded) && !transform.scale.isZero()) {
+            const scale = new TweenVector3Behavior();
+
+            scale.startValue.copy(transform.scale);
+            scale.targetValue.set(0, 0, 0);
+            scale.target = transform.scale;
+
+            scale.duration = 0.2;
+
+            delay = max2(scale.duration, delay);
+
+            const eb = createEntity.call(createEntityThisArg);
+
+            eb.add(BehaviorComponent.from(SequenceBehavior.from([
+                scale,
+                DieBehavior.create()
+            ])));
+
+        } else {
+            transform.scale.set(0, 0, 0);
+        }
+
+    }
+
+
+    return delay;
+});
+
+addShutdown(Light, (light, builder, createEntity, createEntityThisArg) => {
+
+
+    let delay = 0.2;
+
+
+    const eb = createEntity.call(createEntityThisArg);
+
+    eb.add(BehaviorComponent.from(SequenceBehavior.from([
+        TransitionPropertyVectorXBehavior.from({
+            component: 'Light',
+            path: 'intensity',
+            target: [0],
+            duration: delay,
+            entity: builder.id
+        }),
+        DieBehavior.create()
+    ])));
+
+    return delay;
+});
+
+addShutdown(AudioEmitter, (audioEmitter, builder, createEntity, createEntityThisArg) => {
+    // `autoplay` is the "is anything actually sounding" test: a non-autoplay emitter is inert —
+    // AudioEmitterSystem never played it — so there is nothing to fade out. A live `volume` write
+    // reaches the instance gain on both play routes, managed and direct, so tweening the component is
+    // all this has to do.
+    if (audioEmitter.volume.getValue() <= 0 || !audioEmitter.autoplay) {
+        return 0;
+    }
+
+    const setVolume = new TweenVector1Behavior();
+
+    setVolume.startValue = audioEmitter.volume.getValue();
+    setVolume.targetValue = 0;
+
+    setVolume.target = audioEmitter.volume;
+
+    // the sound keeps playing through the grace period and fades over its last 2.7 seconds
+    setVolume.duration = 2.7;
+
+    const eb = createEntity.call(createEntityThisArg);
+
+    eb.add(BehaviorComponent.from(SequenceBehavior.from([
+        DelayBehavior.from(SHUTDOWN_GRACE_PERIOD - setVolume.duration),
+        setVolume,
+        DieBehavior.create()
+    ])));
+
+    return SHUTDOWN_GRACE_PERIOD;
+});
+
+/**
+ *
+ * @param {Entity} builder
+ * @param {function():Entity} createEntity
+ * @param {*} [createEntityThisArg]
+ * @return {number} duration in seconds until the entity is completely hidden
+ */
+export function hideEntityGracefully(builder, createEntity, createEntityThisArg) {
+    if (!builder.isBuilt) {
+        // already destroyed
+        return 0;
+    }
+
+    let delay = 0;
+
+    const components = builder.components;
+
+    const component_count = components.length;
+
+    for (let i = 0; i < component_count; i++) {
+        const component = components[i];
+
+        const shutdown_method = component_shutdown.get(Object.getPrototypeOf(component).constructor);
+
+        if (shutdown_method === undefined) {
+            continue;
+        }
+
+        const sd = shutdown_method(component, builder, createEntity, createEntityThisArg);
+
+        if (Number.isNaN(sd) || !Number.isFinite(sd)) {
+            continue;
+        }
+
+        delay = max2(sd, delay);
+    }
+
+    delay = min2(delay, SHUTDOWN_GRACE_PERIOD);
+
+    return delay;
+}

package/src/engine/intelligence/behavior/primitive/ActionBehavior.d.ts

@@ -11,9 +11,11 @@
 export class ActionBehavior<CTX> extends Behavior<CTX> {
     /**
      * Constructor alias
+     * @param {(timeDelta: number, context: CTX) => void} action
+     * @param {*} [thisArg=this]
      * @returns {ActionBehavior}
      */
-    static from(func: any, thisArg: any): ActionBehavior<any>;
+    static from(action: (timeDelta: number, context: CTX) => void, thisArg?: any): ActionBehavior<any>;
     /**
      *
      * @param {(timeDelta: number, context: CTX) => void} action

package/src/engine/intelligence/behavior/primitive/ActionBehavior.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ActionBehavior.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/primitive/ActionBehavior.js"],"names":[],"mappings":"AAIA;;;;;;;;;GASG;AACH;IAqBI;;;OAGG;IACH,0DAEC;IA1BD;;;;OAIG;IACH,gCAHuB,MAAM,WAAW,GAAG,KAAK,IAAI,iBAgBnD;IARG,sBARmB,MAAM,WAAW,GAAG,KAAK,IAAI,CAQ1B;IAIlB,eAAqB;IAc7B,6BAeC;CACJ;yBA1DwB,gBAAgB"}
+{"version":3,"file":"ActionBehavior.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/primitive/ActionBehavior.js"],"names":[],"mappings":"AAIA;;;;;;;;;GASG;AACH;IAqBI;;;;;OAKG;IACH,gCAJuB,MAAM,mBAAmB,IAAI,sCAMnD;IA5BD;;;;OAIG;IACH,gCAHuB,MAAM,WAAW,GAAG,KAAK,IAAI,iBAgBnD;IARG,sBARmB,MAAM,WAAW,GAAG,KAAK,IAAI,CAQ1B;IAIlB,eAAqB;IAgB7B,6BAeC;CACJ;yBA5DwB,gBAAgB"}

package/src/engine/intelligence/behavior/primitive/ActionBehavior.js

@@ -35,10 +35,12 @@ export class ActionBehavior extends Behavior {
 
     /**
      * Constructor alias
+     * @param {(timeDelta: number, context: CTX) => void} action
+     * @param {*} [thisArg=this]
      * @returns {ActionBehavior}
      */
-    static from(func, thisArg) {
-        return new ActionBehavior(func, thisArg);
+    static from(action, thisArg) {
+        return new ActionBehavior(action, thisArg);
     }
 
     tick(timeDelta) {