@woosh/meep-engine 2.57.0 → 2.58.0

package/src/core/process/action/AsynchronousDelayAction.js

@@ -1,4 +1,4 @@
-import EntityBuilder from "../../../engine/ecs/EntityBuilder.js";
+import Entity from "../../../engine/ecs/Entity.js";
 import { SequenceBehavior } from "../../../engine/intelligence/behavior/composite/SequenceBehavior.js";
 import { BehaviorComponent } from "../../../engine/intelligence/behavior/ecs/BehaviorComponent.js";
 import { DieBehavior } from "../../../engine/intelligence/behavior/ecs/DieBehavior.js";
@@ -23,7 +23,7 @@ export class AsynchronousDelayAction extends AsynchronousAction {
         this.__ecd = ecd;
         this.__time = time;
 
-        this.__entity = new EntityBuilder();
+        this.__entity = new Entity();
 
         this.__entity.add(BehaviorComponent.fromOne(
             SequenceBehavior.from([

package/src/core/process/executor/profile/ConcurrentExecutorProfiler.js

@@ -1,6 +1,6 @@
-import { downloadAsFile } from "../../../binary/ByteArrayTools.js";
 import { Profile } from "./Profile.js";
 import { TraceEvent } from "./TraceEvent.js";
+import {downloadAsFile} from "../../../binary/downloadAsFile.js";
 
 export class ConcurrentExecutorProfiler {
     constructor() {

package/src/engine/EngineHarness.js

@@ -3,7 +3,7 @@ import { MouseEvents } from "./input/devices/events/MouseEvents.js";
 import { Transform } from "./ecs/transform/Transform.js";
 import TopDownCameraController from "./graphics/ecs/camera/topdown/TopDownCameraController.js";
 import { Camera } from "./graphics/ecs/camera/Camera.js";
-import EntityBuilder from "./ecs/EntityBuilder.js";
+import Entity from "./ecs/Entity.js";
 import { Light } from "./graphics/ecs/light/Light.js";
 import Vector3 from "../core/geom/Vector3.js";
 import Terrain from "./ecs/terrain/ecs/Terrain.js";
@@ -162,7 +162,7 @@ export class EngineHarness {
      * @param {number} [distanceMin]
      * @param {number} [distanceMax]
      * @param {number} [fieldOfView] in degrees
-     * @returns {EntityBuilder}
+     * @returns {Entity}
      */
     static buildCamera(
         {
@@ -212,7 +212,7 @@ export class EngineHarness {
         camera.clip_far = distanceMax;
         camera.fov.set(fieldOfView);
 
-        const entityBuilder = new EntityBuilder();
+        const entityBuilder = new Entity();
 
         entityBuilder
             .add(transform)
@@ -349,7 +349,7 @@ export class EngineHarness {
             -0.3334313787830773
         );
 
-        new EntityBuilder()
+        new Entity()
             .add(key)
             .add(transform)
             .add(Tag.fromJSON(["Light", "Key"]))
@@ -362,7 +362,7 @@ export class EngineHarness {
         fill.intensity.set(0.1);
 
 
-        new EntityBuilder()
+        new Entity()
             .add(fill)
             .add(new Transform())
             .add(Tag.fromJSON(["Light", "Ambient"]))
@@ -375,7 +375,7 @@ export class EngineHarness {
      * @param {Engine} engine
      * @param {number} [sensitivity]
      * @param {EntityComponentDataset} [ecd]
-     * @returns {EntityBuilder}
+     * @returns {Entity}
      */
     static async buildOrbitalCameraController({
                                                   cameraEntity,
@@ -469,7 +469,7 @@ export class EngineHarness {
         terrain.build(engine.assetManager);
 
 
-        const eb = new EntityBuilder();
+        const eb = new Entity();
 
         eb.add(new Transform())
         eb.add(terrain);

package/src/engine/EntityCreator.js

@@ -4,7 +4,7 @@
 import { Transform } from './ecs/transform/Transform.js';
 import { SoundEmitter } from './sound/ecs/emitter/SoundEmitter.js';
 import Timer from './ecs/components/Timer.js';
-import EntityBuilder from './ecs/EntityBuilder.js';
+import Entity from './ecs/Entity.js';
 import Vector3 from "../core/geom/Vector3.js";
 import { SoundEmitterChannels } from "./sound/ecs/emitter/SoundEmitterSystem.js";
 import { BehaviorComponent } from "./intelligence/behavior/ecs/BehaviorComponent.js";
@@ -22,7 +22,7 @@ import { SerializationMetadata } from "./ecs/components/SerializationMetadata.js
  * @param {boolean} [positioned]
  * @param {String|SoundEmitterChannels} [channel]
  * @param {number} [volume]
- * @returns {EntityBuilder}
+ * @returns {Entity}
  */
 function createSound(
     {
@@ -37,7 +37,7 @@ function createSound(
     }
 ) {
 
-    const builder = new EntityBuilder();
+    const builder = new Entity();
 
     let trackJSON;
 
@@ -77,10 +77,10 @@ function createSound(
  *
  * @param timeout
  * @param action
- * @returns {EntityBuilder}
+ * @returns {Entity}
  */
 export function createTimer({ timeout, action }) {
-    const builder = new EntityBuilder();
+    const builder = new Entity();
 
     function suicide() {
         builder.destroy();

package/src/engine/__module.js

@@ -14,6 +14,6 @@ export { EngineConfiguration } from "./EngineConfiguration.js";
 export { Light } from "./graphics/ecs/light/Light.js";
 export * from "./graphics/ecs/light/LightSystem.js";
 export { ForwardPlusRenderingPlugin } from "./graphics/render/forward_plus/plugin/ForwardPlusRenderingPlugin.js";
-export * from "./ecs/EntityBuilder.js";
+export * from "./ecs/Entity.js";
 
 export * from './intelligence/__module.js';

package/src/engine/achievements/AchievementManager.js

@@ -6,7 +6,7 @@ import ObservedBoolean from "../../core/model/ObservedBoolean.js";
 import { AchievementNotificationView } from "../../view/game/achievements/AchievementNotificationView.js";
 import ViewportPosition from "../ecs/gui/position/ViewportPosition.js";
 import Vector2 from "../../core/geom/Vector2.js";
-import EntityBuilder from "../ecs/EntityBuilder.js";
+import Entity from "../ecs/Entity.js";
 import GUIElement from "../ecs/gui/GUIElement.js";
 import AnimationTrack from "../animation/keyed2/AnimationTrack.js";
 import TransitionFunctions from "../animation/TransitionFunctions.js";
@@ -313,7 +313,7 @@ export class AchievementManager extends EnginePlugin {
         aExit.addKey(1, [1, 0, 1]);
         aExit.addTransition(0, SLOW_CUBIC);
 
-        const builder = new EntityBuilder();
+        const builder = new Entity();
 
         const sequenceBehavior = SequenceBehavior.from([
             new AnimationBehavior(new AnimationTrackPlayback(aEntry, (scale, alpha, v) => {

package/src/engine/animation/AnimationUtils.js

@@ -1,6 +1,6 @@
 import { SerializationMetadata } from "../ecs/components/SerializationMetadata.js";
 import Timer from "../ecs/components/Timer.js";
-import EntityBuilder from "../ecs/EntityBuilder.js";
+import Entity from "../ecs/Entity.js";
 import { whenAllEntitiesDestroyed, whenEntityDestroyed } from "../ecs/EntityBuilderUtils.js";
 import { Transform } from "../ecs/transform/Transform.js";
 import { removeComponentsExcept } from "../ecs/util/removeComponentsExcept.js";
@@ -41,7 +41,7 @@ export function stopTrailAndNotifyOnceFinished(entity, ecd) {
 
         trail.clearFlag(Trail2DFlags.Spawning);
 
-        new EntityBuilder()
+        new Entity()
             .add(BehaviorComponent.fromOne(SequenceBehavior.from([
                 DelayBehavior.fromJSON({ value: trail.maxAge }),
                 new ActionBehavior(resolve)
@@ -85,7 +85,7 @@ export function stopEmitterAndNotifyOnceFinished(entity, ecd) {
         //figure out how long the emitter should stay alive
         const maxLife = emitter.computeMaxEmittingParticleLife();
 
-        const entityBuilder = new EntityBuilder();
+        const entityBuilder = new Entity();
         //create a timer to remove emitter
         const timer = new Timer();
         timer.timeout = maxLife;
@@ -219,7 +219,7 @@ export function removeEntityWithEffect({ entity, ecd, emitter, soundEffect, time
         const t = new Transform();
         t.copy(transform);
 
-        const emitterBuilder = new EntityBuilder();
+        const emitterBuilder = new Entity();
         emitterBuilder.add(t).add(emitter);
         emitterBuilder.build(ecd);
 

package/src/engine/animation/behavior/animateProperty.js

@@ -1,7 +1,7 @@
 import {
     TransitionPropertyVectorXBehavior
 } from "../../../../../model/game/story/behaviors/generic/TransitionPropertyVectorXBehavior.js";
-import EntityBuilder from "../../ecs/EntityBuilder.js";
+import Entity from "../../ecs/Entity.js";
 import { BehaviorComponent } from "../../intelligence/behavior/ecs/BehaviorComponent.js";
 import { SequenceBehavior } from "../../intelligence/behavior/composite/SequenceBehavior.js";
 import { DieBehavior } from "../../intelligence/behavior/ecs/DieBehavior.js";
@@ -23,7 +23,7 @@ export async function animateProperty(ecd, entity, component, property, target,
 
     assert.ok(ecd.entityExists(entity), `entity ${entity} doesn't exist`);
 
-    const builder = new EntityBuilder()
+    const builder = new Entity()
         .add(SerializationMetadata.Transient)
         .add(BehaviorComponent.fromOne(SequenceBehavior.from([
             TransitionPropertyVectorXBehavior.from({

package/src/engine/animation/curve/draw/build_plot_entity_from_array.js

@@ -1,7 +1,7 @@
 import { CanvasView } from "../../../../view/elements/CanvasView.js";
 import { plot_data } from "./plot_data.js";
 import { draw_label } from "./draw_label.js";
-import EntityBuilder from "../../../ecs/EntityBuilder.js";
+import Entity from "../../../ecs/Entity.js";
 import ViewportPosition from "../../../ecs/gui/position/ViewportPosition.js";
 import GUIElement from "../../../ecs/gui/GUIElement.js";
 import Vector2 from "../../../../core/geom/Vector2.js";
@@ -15,7 +15,7 @@ import Vector2 from "../../../../core/geom/Vector2.js";
  * @param {number} [height]
  * @param {Vector2} [margin]
  * @param {string} [label]
- * @return {EntityBuilder}
+ * @return {Entity}
  */
 export function build_plot_entity_from_array({
                                                  data,
@@ -39,7 +39,7 @@ export function build_plot_entity_from_array({
         draw_label(ctx, label, 0, 0)
     }
 
-    return new EntityBuilder()
+    return new Entity()
         .add(ViewportPosition.fromJSON({
             offset: { x, y }
         }))

package/src/engine/animation/playAnimationTrack.js

@@ -1,12 +1,12 @@
 import Script from "../ecs/components/Script.js";
 import { SerializationMetadata } from "../ecs/components/SerializationMetadata.js";
-import EntityBuilder from "../ecs/EntityBuilder.js";
+import Entity from "../ecs/Entity.js";
 
 /**
  *
  * @param {AnimationTrackPlayback} track
  * @param {EntityComponentDataset} ecd
- * @returns {EntityBuilder}
+ * @returns {Entity}
  */
 export function playAnimationTrack(track, ecd) {
     const script = new Script();
@@ -15,7 +15,7 @@ export function playAnimationTrack(track, ecd) {
         track.advance(timeDelta);
     });
 
-    const entity = new EntityBuilder();
+    const entity = new Entity();
     entity.add(script);
     entity.add(SerializationMetadata.Transient);
 

package/src/engine/animation/playTrackRealTime.js

@@ -1,5 +1,5 @@
 import { SerializationMetadata } from "../ecs/components/SerializationMetadata.js";
-import EntityBuilder from "../ecs/EntityBuilder.js";
+import Entity from "../ecs/Entity.js";
 import { BehaviorComponent } from "../intelligence/behavior/ecs/BehaviorComponent.js";
 import { ClockChannelType } from "../intelligence/behavior/ecs/ClockChannelType.js";
 import { AnimationBehavior } from "./keyed2/behavior/AnimationBehavior.js";
@@ -9,11 +9,11 @@ import { AnimationBehavior } from "./keyed2/behavior/AnimationBehavior.js";
  * @param {AnimationTrackPlayback} track
  * @param {EntityComponentDataset} ecd
  *
- * @returns {EntityBuilder}
+ * @returns {Entity}
  */
 export function playTrackRealTime(track, ecd) {
 
-    const entity = new EntityBuilder();
+    const entity = new Entity();
 
     const behaviorComponent = BehaviorComponent.fromOne(new AnimationBehavior(track));
 

package/src/engine/animation/removeEntityWithMeshParticlesEffect.js

@@ -6,7 +6,7 @@ import { removeComponentsExcept } from "../ecs/util/removeComponentsExcept.js";
 import { ParticleEmitter } from "../graphics/particles/particular/engine/emitter/ParticleEmitter.js";
 import Trail2D from "../graphics/ecs/trail2d/Trail2D.js";
 import { Transform } from "../ecs/transform/Transform.js";
-import EntityBuilder from "../ecs/EntityBuilder.js";
+import Entity from "../ecs/Entity.js";
 import { stopEntityAndNotifyWhenStopped } from "./AnimatedActions.js";
 
 const lib = {
@@ -184,7 +184,7 @@ export function removeEntityWithMeshParticlesEffect(
     }
 
     //create particle emitter
-    const effectBuilder = new EntityBuilder();
+    const effectBuilder = new Entity();
     const effectEntity = effectBuilder
         .add(emitter)
         .add(originalTransform.clone())

package/src/engine/control/ControlContext.js

@@ -1,8 +1,8 @@
-import EntityBuilder from "../ecs/EntityBuilder.js";
+import Entity from "../ecs/Entity.js";
 import { ControlContextState } from "./ControlContextState.js";
 import { IllegalStateException } from "../../core/fsm/exceptions/IllegalStateException.js";
 import { SerializationMetadata } from "../ecs/components/SerializationMetadata.js";
-import { EntityBuilderFlags } from "../ecs/EntityBuilderFlags.js";
+import { EntityFlags } from "../ecs/EntityFlags.js";
 
 export class ControlContext {
     constructor() {
@@ -14,7 +14,7 @@ export class ControlContext {
 
         /**
          * @private
-         * @type {EntityBuilder[]}
+         * @type {Entity[]}
          */
         this.entities = [];
 
@@ -42,10 +42,10 @@ export class ControlContext {
 
     /**
      * Do not invoke "build" manually
-     * @returns {EntityBuilder}
+     * @returns {Entity}
      */
     makeEntity() {
-        const eb = new EntityBuilder();
+        const eb = new Entity();
 
         if (this.transientEntities) {
             eb.add(SerializationMetadata.Transient);
@@ -124,7 +124,7 @@ export class ControlContext {
         }
 
         for (const e of this.entities) {
-            if (e.getFlag(EntityBuilderFlags.Built)) {
+            if (e.getFlag(EntityFlags.Built)) {
                 throw new IllegalStateException(`Entity ${e.entity} is already built, this violates pre-condition of control context`);
             }
 
@@ -149,7 +149,7 @@ export class ControlContext {
         }
 
         for (const e of this.entities) {
-            if (!e.getFlag(EntityBuilderFlags.Built)) {
+            if (!e.getFlag(EntityFlags.Built)) {
                 //entity is not built, skip
                 continue;
             }

package/src/engine/ecs/{EntityBuilder.d.ts → Entity.d.ts}

@@ -4,10 +4,10 @@ interface Type<T> extends Function {
     new(...args: any[]): T;
 }
 
-export default class EntityBuilder {
+export default class Entity {
     public entity: number;
 
-    add<T>(component: T): EntityBuilder
+    add<T>(component: T): Entity
 
     removeComponent<T>(componentType: Type<T>): T | null
 
@@ -27,11 +27,11 @@ export default class EntityBuilder {
 
     sendEvent(eventName: string, event?: any): void
 
-    addEventListener(eventName: string, listener: (data?: any) => void, context?: any): EntityBuilder
+    addEventListener(eventName: string, listener: (data?: any) => void, context?: any): Entity
 
-    removeEventListener(eventName: string, listener: (data?: any) => void, context?: any): EntityBuilder
+    removeEventListener(eventName: string, listener: (data?: any) => void, context?: any): Entity
 
-    static readFromDataset(entity: number, dataset: EntityComponentDataset): EntityBuilder
+    static readFromDataset(entity: number, dataset: EntityComponentDataset): Entity
 
     getFlag(flag: number): boolean
 

package/src/engine/ecs/{EntityBuilder.js → Entity.js}

@@ -2,22 +2,22 @@ import Signal from "../../core/events/signal/Signal.js";
 import { assert } from "../../core/assert.js";
 import { EventType } from "./EntityManager.js";
 import { isDefined } from "../../core/process/matcher/Matchers.js";
-import { EntityBuilderFlags } from "./EntityBuilderFlags.js";
+import { EntityFlags } from "./EntityFlags.js";
 
 /**
  * Set of default flags
  * @type {number}
  */
 const DEFAULT_FLAGS =
-    EntityBuilderFlags.RegisterComponents
-    | EntityBuilderFlags.WatchDestruction
+    EntityFlags.RegisterComponents
+    | EntityFlags.WatchDestruction
 ;
 
 /**
  * Representation of an entity, helps build entities and keep track of them without having to access {@link EntityComponentDataset} directly
  * @class
  */
-class EntityBuilder {
+class Entity {
 
     /**
      * @type {number}
@@ -51,7 +51,7 @@ class EntityBuilder {
 
     /**
      *
-     * @type {EntityBuilderFlags|number}
+     * @type {EntityFlags|number}
      */
     flags = DEFAULT_FLAGS;
 
@@ -73,12 +73,12 @@ class EntityBuilder {
      * @private
      */
     __handleEntityDestroyed() {
-        this.clearFlag(EntityBuilderFlags.Built);
+        this.clearFlag(EntityFlags.Built);
     }
 
     /**
      *
-     * @param {number|EntityBuilderFlags} value
+     * @param {number|EntityFlags} value
      */
     setFlag(value) {
         this.flags |= value;
@@ -86,7 +86,7 @@ class EntityBuilder {
 
     /**
      *
-     * @param {number|EntityBuilderFlags} flag
+     * @param {number|EntityFlags} flag
      * @returns {boolean}
      */
     getFlag(flag) {
@@ -97,7 +97,7 @@ class EntityBuilder {
 
     /**
      *
-     * @param {number|EntityBuilderFlags} flag
+     * @param {number|EntityFlags} flag
      */
     clearFlag(flag) {
         this.flags &= ~flag;
@@ -108,7 +108,7 @@ class EntityBuilder {
      * @returns {boolean}
      */
     get isBuilt() {
-        return this.getFlag(EntityBuilderFlags.Built);
+        return this.getFlag(EntityFlags.Built);
     }
 
     /**
@@ -135,7 +135,7 @@ class EntityBuilder {
     /**
      * @template T
      * @param {T} componentInstance
-     * @returns {EntityBuilder}
+     * @returns {Entity}
      */
     add(componentInstance) {
         if (componentInstance === undefined) {
@@ -146,7 +146,7 @@ class EntityBuilder {
 
         this.element.push(componentInstance);
 
-        if (this.getFlag(EntityBuilderFlags.Built)) {
+        if (this.getFlag(EntityFlags.Built)) {
             //already built, add component to entity
             this.dataset.addComponentToEntity(this.entity, componentInstance);
         }
@@ -213,7 +213,7 @@ class EntityBuilder {
                 elements.splice(i, 1);
 
                 //see if entity is built
-                if (this.getFlag(EntityBuilderFlags.Built)) {
+                if (this.getFlag(EntityFlags.Built)) {
 
                     this.dataset.removeComponentFromEntity(this.entity, klass);
 
@@ -232,7 +232,7 @@ class EntityBuilder {
      * @param {*} [event]
      */
     sendEvent(eventName, event) {
-        if (this.getFlag(EntityBuilderFlags.Built)) {
+        if (this.getFlag(EntityFlags.Built)) {
             this.dataset.sendEvent(this.entity, eventName, event);
         } else {
             console.warn("Entity doesn't exist. Event " + eventName + ":" + event + " was not sent.")
@@ -265,10 +265,10 @@ class EntityBuilder {
      * @param {string} eventName
      * @param {function} listener
      * @param {*} [context]
-     * @returns {EntityBuilder}
+     * @returns {Entity}
      */
     addEventListener(eventName, listener, context) {
-        if (this.getFlag(EntityBuilderFlags.Built)) {
+        if (this.getFlag(EntityFlags.Built)) {
             this.dataset.addEntityEventListener(this.entity, eventName, listener, context);
         } else {
             this.deferredListeners.push({
@@ -285,10 +285,10 @@ class EntityBuilder {
      * @param {string} eventName
      * @param {function} listener
      * @param {*} [context]
-     * @returns {EntityBuilder}
+     * @returns {Entity}
      */
     removeEventListener(eventName, listener, context) {
-        if (this.getFlag(EntityBuilderFlags.Built)) {
+        if (this.getFlag(EntityFlags.Built)) {
             this.dataset.removeEntityEventListener(this.entity, eventName, listener, context);
         } else {
             const listeners = this.deferredListeners;
@@ -317,7 +317,7 @@ class EntityBuilder {
      * @returns {boolean}
      */
     destroy() {
-        if (this.getFlag(EntityBuilderFlags.Built)) {
+        if (this.getFlag(EntityFlags.Built)) {
 
             const dataset = this.dataset;
             const entity = this.entity;
@@ -331,7 +331,7 @@ class EntityBuilder {
 
             this.entity = void 0;
 
-            this.clearFlag(EntityBuilderFlags.Built);
+            this.clearFlag(EntityFlags.Built);
 
             return true;
         } else {
@@ -349,7 +349,7 @@ class EntityBuilder {
         assert.notNull(dataset, "dataset");
 
         if (
-            this.getFlag(EntityBuilderFlags.Built)
+            this.getFlag(EntityFlags.Built)
             && checkExistingComponents(this.entity, this.element, dataset)
         ) {
             //already built
@@ -374,7 +374,7 @@ class EntityBuilder {
         const element = this.element;
         const element_count = element.length;
 
-        if (this.getFlag(EntityBuilderFlags.RegisterComponents)) {
+        if (this.getFlag(EntityFlags.RegisterComponents)) {
             for (i = 0; i < element_count; i++) {
                 const component = element[i];
 
@@ -388,9 +388,9 @@ class EntityBuilder {
             dataset.addComponentToEntity(entity, component);
         }
 
-        this.setFlag(EntityBuilderFlags.Built);
+        this.setFlag(EntityFlags.Built);
 
-        if (this.getFlag(EntityBuilderFlags.WatchDestruction)) {
+        if (this.getFlag(EntityFlags.WatchDestruction)) {
             dataset.addEntityEventListener(entity, EventType.EntityRemoved, this.__handleEntityDestroyed, this);
         }
 
@@ -402,16 +402,16 @@ class EntityBuilder {
      *
      * @param {number} entity
      * @param {EntityComponentDataset} dataset
-     * @returns {EntityBuilder}
+     * @returns {Entity}
      */
     static readFromDataset(entity, dataset) {
-        const r = new EntityBuilder();
+        const r = new Entity();
 
         dataset.getAllComponents(entity)
             .filter(isDefined)
             .forEach(r.add, r);
 
-        r.setFlag(EntityBuilderFlags.Built);
+        r.setFlag(EntityFlags.Built);
         r.entity = entity;
         r.dataset = dataset;
 
@@ -423,7 +423,7 @@ class EntityBuilder {
  * @readonly
  * @type {boolean}
  */
-EntityBuilder.prototype.isEntityBuilder = true;
+Entity.prototype.isEntityBuilder = true;
 
 
 /**
@@ -452,4 +452,4 @@ function checkExistingComponents(entity, components, dataset) {
     return true;
 }
 
-export default EntityBuilder;
+export default Entity;