@woosh/meep-engine 2.120.5 → 2.121.1

package/src/engine/ecs/EntityComponentDataset.js

@@ -678,6 +678,8 @@ export class EntityComponentDataset {
     }
 
     /**
+     * Does this dataset have a given component registered?
+     * Use {@link registerComponentType}/{@link unregisterComponentType} to alter registered set
      * @param {Class|Function} type
      * @return {boolean}
      */
@@ -719,11 +721,11 @@ export class EntityComponentDataset {
     /**
      * Attempt to add a component class to dataset registry
      * @param {Class|Function} type
-     * @returns {boolean} true if component successfully added, false otherwise
+     * @returns {boolean} true if component successfully added, false if component is already registered
      */
     registerComponentType(type) {
         if (this.isComponentTypeRegistered(type)) {
-            //already registered
+            // already registered
             return false;
         }
 
@@ -737,11 +739,11 @@ export class EntityComponentDataset {
     /**
      * Attempt to remove a component class from the registry
      * @param {Class} type
-     * @returns {boolean}
+     * @returns {boolean} true iff component is removed, false if it was not registered
      */
     unregisterComponentType(type) {
         if (this.isComponentTypeRegistered(type)) {
-            //not registered
+            // not registered
             return false;
         }
 
@@ -771,6 +773,7 @@ export class EntityComponentDataset {
 
         const new_generation_table = new Uint32Array(new_size);
 
+        // copy over old data
         new_generation_table.set(this.entityGeneration);
 
         this.entityGeneration = new_generation_table
@@ -783,6 +786,7 @@ export class EntityComponentDataset {
      */
     getEntityGeneration(entity_id) {
         assert.isNonNegativeInteger(entity_id, 'entity_id');
+        assert.ok(this.entityExists(entity_id),`Entity ${entity_id} does not exist`);
 
         return this.entityGeneration[entity_id];
     }
@@ -863,6 +867,8 @@ export class EntityComponentDataset {
      * @returns {boolean} true if entity was removed, false if it doesn't exist
      */
     removeEntity(entity_id) {
+        assert.isNonNegativeInteger(entity_id, 'entity_id');
+
         if (!this.entityExists(entity_id)) {
             // entity doesn't exist
             return false;
@@ -902,6 +908,7 @@ export class EntityComponentDataset {
 
     /**
      * Convenience method for removal of multiple entities
+     * Works the same as {@link removeEntity} but for multiple elements
      * @param {number[]} entityIndices
      */
     removeEntities(entityIndices) {
@@ -1030,10 +1037,10 @@ export class EntityComponentDataset {
      *
      * Associate a component with a particular entity
      * @template C
-     * @param {number} entityIndex
+     * @param {number} entity_id
      * @param {C} componentInstance
      */
-    addComponentToEntity(entityIndex, componentInstance) {
+    addComponentToEntity(entity_id, componentInstance) {
 
         assert.notNull(componentInstance, "componentInstance");
 
@@ -1053,7 +1060,7 @@ export class EntityComponentDataset {
             throw new Error(`Component class not found in this dataset for componentInstance ${stringifyComponent(componentInstance)}`);
         }
 
-        this.addComponentToEntityByIndex(entityIndex, componentTypeIndex, componentInstance);
+        this.addComponentToEntityByIndex(entity_id, componentTypeIndex, componentInstance);
     }
 
     /**

package/src/engine/ecs/EntityReference.d.ts

@@ -1,13 +1,13 @@
 /**
  * Uniquely identifies an entity by both its ID and generation.
- * Lets us distinguish between two entities with the same ID that were created at different times
+ * Lets us uniquely distinguish between two entities, even those with the same ID that were created at different times
  *
  * @example
  * // 1. Get your EntityComponentDataset to where you manager entities.
- * const ecd = ... ; //EntityComponentDataset
+ * const ecd = ... ; // EntityComponentDataset
  *
- * // 2. Create an entity (we'll get an ID). Or use an existing one.
- * const entityId = ecd.createEntity(); // Let's say this returns ID 1, generation 0
+ * // 2. Create an entity (we'll get an ID).
+ * const entityId = ecd.createEntity();
  *
  * // 3. Create an EntityReference and bind it to the entity.
  * const entityRef = EntityReference.bind(ecd, entityId);

package/src/engine/ecs/EntityReference.js

@@ -2,14 +2,14 @@ import { assert } from "../../core/assert.js";
 
 /**
  * Uniquely identifies an entity by both its ID and generation.
- * Lets us distinguish between two entities with the same ID that were created at different times
+ * Lets us uniquely distinguish between two entities, even those with the same ID that were created at different times
  *
  * @example
  * // 1. Get your EntityComponentDataset to where you manager entities.
- * const ecd = ... ; //EntityComponentDataset
+ * const ecd = ... ; // EntityComponentDataset
  *
- * // 2. Create an entity (we'll get an ID). Or use an existing one.
- * const entityId = ecd.createEntity(); // Let's say this returns ID 1, generation 0
+ * // 2. Create an entity (we'll get an ID).
+ * const entityId = ecd.createEntity();
  *
  * // 3. Create an EntityReference and bind it to the entity.
  * const entityRef = EntityReference.bind(ecd, entityId);

package/src/engine/ecs/dynamic_actions/DynamicActorSystem.js

@@ -264,7 +264,7 @@ export class DynamicActorSystem extends AbstractContextSystem {
         const behavior = rule.action.execute(entity, ecd, context, this);
 
         const entity_builder = new Entity()
-            .add(BehaviorComponent.fromOne(SequenceBehavior.from([
+            .add(BehaviorComponent.from(SequenceBehavior.from([
                 OverrideContextBehavior.from(
                     {
                         entity

package/src/engine/ecs/speaker/VoiceSystem.d.ts

@@ -9,7 +9,7 @@ export class VoiceSystem extends AbstractContextSystem<any> {
         font_size: number;
     });
     dependencies: (typeof Voice)[];
-    components_used: ResourceAccessSpecification<typeof BehaviorComponent>[];
+    components_used: (ResourceAccessSpecification<typeof GUIElement> | ResourceAccessSpecification<typeof Transform> | ResourceAccessSpecification<typeof ViewportPosition> | ResourceAccessSpecification<typeof HeadsUpDisplay> | ResourceAccessSpecification<typeof Attachment> | ResourceAccessSpecification<typeof SerializationMetadata> | ResourceAccessSpecification<typeof BehaviorComponent>)[];
     /**
      *
      * @type {Localization}
@@ -100,6 +100,12 @@ export class VoiceSystem extends AbstractContextSystem<any> {
 }
 import { AbstractContextSystem } from "../system/AbstractContextSystem.js";
 import { Voice } from "./Voice.js";
-import { BehaviorComponent } from "../../intelligence/behavior/ecs/BehaviorComponent.js";
+import GUIElement from "../gui/GUIElement.js";
 import { ResourceAccessSpecification } from "../../../core/model/ResourceAccessSpecification.js";
+import { Transform } from "../transform/Transform.js";
+import ViewportPosition from "../gui/position/ViewportPosition.js";
+import HeadsUpDisplay from "../gui/hud/HeadsUpDisplay.js";
+import { Attachment } from "../attachment/Attachment.js";
+import { SerializationMetadata } from "../components/SerializationMetadata.js";
+import { BehaviorComponent } from "../../intelligence/behavior/ecs/BehaviorComponent.js";
 //# sourceMappingURL=VoiceSystem.d.ts.map

package/src/engine/ecs/speaker/VoiceSystem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"VoiceSystem.d.ts","sourceRoot":"","sources":["../../../../../src/engine/ecs/speaker/VoiceSystem.js"],"names":[],"mappings":"AA2JA;IACI;;;;OAIG;IACH,oBAHW,MAAM;;;OA8FhB;IArFG,+BAA2B;IAE3B,yEAQC;IAGD;;;OAGG;IACH,aAFU,YAAY,CAEC;IAEvB;;;OAGG;IACH,KAFU,SAAS,CAEJ;IAEf;;;OAGG;IACH,OAFU,oBAAoB,CAEb;IAEjB;;;OAGG;IACH,MAFU,uBAAuB,CAEjB;IAEhB;;;OAGG;IACH,QAFU,MAAM,CAEI;IAEpB;;;;OAIG;IACH,iCAAyC;IAEzC;;;;OAIG;IACH,kBAAkC;IAIlC;;;;OAIG;IACH,eAAkB;IAElB;;;;OAIG;IACH,oBAAgC;IAEhC;;;OAGG;IACH,oBAAqC;IAErC;;;;OAIG;IACH,gBAAoB;IAGxB;;;OAGG;IACH,kBAFY,MAAM,CAIjB;IAED,0EAuBC;IAED;;;;;OAKG;IACH,uBAJW,MAAM,UACN,MAAM,SACN,KAAK,QAsBf;IAED;;;;;OAKG;IACH,wBAoBC;IAED;;;;;OAKG;IACH,gBAJW,MAAM,WACN,MAAM,SACN,KAAK,QAuHf;CACJ;sCAxbqC,oCAAoC;sBAIpD,YAAY;kCAlBA,sDAAsD;4CAR5C,oDAAoD"}
+{"version":3,"file":"VoiceSystem.d.ts","sourceRoot":"","sources":["../../../../../src/engine/ecs/speaker/VoiceSystem.js"],"names":[],"mappings":"AA2JA;IACI;;;;OAIG;IACH,oBAHW,MAAM;;;OA8FhB;IArFG,+BAA2B;IAE3B,qYAQC;IAGD;;;OAGG;IACH,aAFU,YAAY,CAEC;IAEvB;;;OAGG;IACH,KAFU,SAAS,CAEJ;IAEf;;;OAGG;IACH,OAFU,oBAAoB,CAEb;IAEjB;;;OAGG;IACH,MAFU,uBAAuB,CAEjB;IAEhB;;;OAGG;IACH,QAFU,MAAM,CAEI;IAEpB;;;;OAIG;IACH,iCAAyC;IAEzC;;;;OAIG;IACH,kBAAkC;IAIlC;;;;OAIG;IACH,eAAkB;IAElB;;;;OAIG;IACH,oBAAgC;IAEhC;;;OAGG;IACH,oBAAqC;IAErC;;;;OAIG;IACH,gBAAoB;IAGxB;;;OAGG;IACH,kBAFY,MAAM,CAIjB;IAED,0EAuBC;IAED;;;;;OAKG;IACH,uBAJW,MAAM,UACN,MAAM,SACN,KAAK,QAsBf;IAED;;;;;OAKG;IACH,wBAoBC;IAED;;;;;OAKG;IACH,gBAJW,MAAM,WACN,MAAM,SACN,KAAK,QAuHf;CACJ;sCAxbqC,oCAAoC;sBAIpD,YAAY;uBAPX,sBAAsB;4CAnBD,oDAAoD;0BAwBtE,2BAA2B;6BAHxB,qCAAqC;2BADvC,8BAA8B;2BAL9B,6BAA6B;sCAClB,wCAAwC;kCAR5C,sDAAsD"}

package/src/engine/ecs/speaker/VoiceSystem.js

@@ -423,7 +423,7 @@ export class VoiceSystem extends AbstractContextSystem {
                 immediate: true
             }))
             .add(SerializationMetadata.Transient)
-            .add(BehaviorComponent.fromOne(SequenceBehavior.from([
+            .add(BehaviorComponent.from(SequenceBehavior.from([
                 // play intro animation
                 new AnimationBehavior(new AnimationTrackPlayback(SPEECH_BUBBLE_ANIMATION_INTRO, bubble_animation_update_function, view)),
                 // wait for a certain amount of time

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

@@ -81,7 +81,7 @@ addShutdown(Mesh, (mesh, builder, createEntity, createEntityThisArg) => {
 
             const eb = createEntity.call(createEntityThisArg);
 
-            eb.add(BehaviorComponent.fromOne(SequenceBehavior.from([
+            eb.add(BehaviorComponent.from(SequenceBehavior.from([
                 scale,
                 DieBehavior.create()
             ])));
@@ -104,7 +104,7 @@ addShutdown(Light, (light, builder, createEntity, createEntityThisArg) => {
 
     const eb = createEntity.call(createEntityThisArg);
 
-    eb.add(BehaviorComponent.fromOne(SequenceBehavior.from([
+    eb.add(BehaviorComponent.from(SequenceBehavior.from([
         TransitionPropertyVectorXBehavior.from({
             component: 'Light',
             path: 'intensity',
@@ -146,7 +146,7 @@ addShutdown(SoundEmitter, (soundEmitter, builder, createEntity, createEntityThis
 
                 const eb = createEntity.call(createEntityThisArg);
 
-                eb.add(BehaviorComponent.fromOne(SequenceBehavior.from([
+                eb.add(BehaviorComponent.from(SequenceBehavior.from([
                     DelayBehavior.from(SHUTDOWN_GRACE_PERIOD - setVolume.duration),
                     setVolume,
                     DieBehavior.create()

package/src/engine/graphics/ecs/camera/filter/setup_filtered_camera_controller.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setup_filtered_camera_controller.d.ts","sourceRoot":"","sources":["../../../../../../../src/engine/graphics/ecs/camera/filter/setup_filtered_camera_controller.js"],"names":[],"mappings":"AAUA;;;;;;;GAOG;AACH,2FANW,uBAAuB,GAIrB;IAAC,UAAU,EAAC,uBAAuB,CAAC;IAAC,MAAM,EAAC,MAAM,CAAA;CAAC,CA6D/D;oCA5EmC,uCAAuC;mBACxD,2BAA2B"}
+{"version":3,"file":"setup_filtered_camera_controller.d.ts","sourceRoot":"","sources":["../../../../../../../src/engine/graphics/ecs/camera/filter/setup_filtered_camera_controller.js"],"names":[],"mappings":"AAUA;;;;;;;GAOG;AACH,2FANW,uBAAuB,GAIrB;IAAC,UAAU,EAAC,uBAAuB,CAAC;IAAC,MAAM,EAAC,MAAM,CAAA;CAAC,CA6D/D;oCArEmC,uCAAuC;mBAJxD,2BAA2B"}

package/src/engine/graphics/ecs/camera/filter/setup_filtered_camera_controller.js

@@ -1,12 +1,12 @@
 import { assert } from "../../../../../core/assert.js";
-import TopDownCameraController from "../topdown/TopDownCameraController.js";
+import { clamp01 } from "../../../../../core/math/clamp01.js";
+import { lerp } from "../../../../../core/math/lerp.js";
+import { SerializationMetadata } from "../../../../ecs/components/SerializationMetadata.js";
 import Entity from "../../../../ecs/Entity.js";
-import { BehaviorComponent } from "../../../../intelligence/behavior/ecs/BehaviorComponent.js";
 import { RepeatBehavior } from "../../../../intelligence/behavior/decorator/RepeatBehavior.js";
+import { BehaviorComponent } from "../../../../intelligence/behavior/ecs/BehaviorComponent.js";
 import { ActionBehavior } from "../../../../intelligence/behavior/primitive/ActionBehavior.js";
-import { SerializationMetadata } from "../../../../ecs/components/SerializationMetadata.js";
-import { clamp01 } from "../../../../../core/math/clamp01.js";
-import { lerp } from "../../../../../core/math/lerp.js";
+import TopDownCameraController from "../topdown/TopDownCameraController.js";
 
 /**
  *
@@ -36,7 +36,7 @@ export function setup_filtered_camera_controller({
     const entityBuilder = new Entity();
 
     entityBuilder
-        .add(BehaviorComponent.fromOne(
+        .add(BehaviorComponent.from(
             RepeatBehavior.from(
                 new ActionBehavior(time_delta => {
                     if (!remembered_value.equals(target)) {

package/src/engine/graphics/ecs/decal/v2/prototypeDecalSystem.js

@@ -372,7 +372,7 @@ function makeNormalTestDecal() {
         .add(ShadedGeometry.from(DEBUG_BOX, new LineBasicMaterial(), DrawMode.LineSegments))
         .add(transform)
         .add(decal)
-        .add(BehaviorComponent.fromOne(RotationBehavior.fromJSON({ speed: 1, axis: Vector3.left })))
+        .add(BehaviorComponent.from(RotationBehavior.fromJSON({ speed: 1, axis: Vector3.left })))
 
     return entity;
 }

package/src/engine/graphics/ecs/mesh-v2/aggregate/prototypeSGMesh.js

@@ -110,7 +110,7 @@ function make_grid(ecd, engine) {
             new Entity()
                 .add(mesh)
                 .add(transform)
-                .add(BehaviorComponent.fromOne(
+                .add(BehaviorComponent.from(
                     orbitingBehavior
                     // RepeatBehavior.from(
                     //     new ActionBehavior((t) => {

package/src/engine/graphics/ecs/mesh-v2/sample/prototypeShadedGeometry.js

@@ -43,7 +43,7 @@ function makeMovingShadedGeometry() {
     return new Entity()
         .add(new Transform())
         .add(sg)
-        .add(BehaviorComponent.fromOne(b));
+        .add(BehaviorComponent.from(b));
 }
 
 /**
@@ -126,7 +126,7 @@ async function main(engine) {
     let iterator = 0;
 
     new Entity()
-        .add(BehaviorComponent.fromOne(
+        .add(BehaviorComponent.from(
             RepeatBehavior.from(SequenceBehavior.from([
                 DelayBehavior.from(0.001),
                 RepeatBehavior.from(new ActionBehavior(() => {

package/src/engine/graphics/ecs/mesh-v2/sample/prototype_sg_raycast.js

@@ -50,7 +50,7 @@ function makeMovingShadedGeometry() {
     return new Entity()
         .add(new Transform())
         .add(sg)
-        .add(BehaviorComponent.fromOne(b));
+        .add(BehaviorComponent.from(b));
 }
 
 /**

package/src/engine/graphics/ecs/path/tube/prototypeAnimatedPathMask.js

@@ -371,7 +371,7 @@ function main(engine) {
 
     let time = 0;
     new Entity()
-        .add(BehaviorComponent.looping_function((delta) => {
+        .add(BehaviorComponent.loop((delta) => {
             time += delta * 0.01;
 
             const segment_count = 23;

package/src/engine/graphics/ecs/trail2d/prototypeTrail2D.js

@@ -38,7 +38,7 @@ async function main(engine) {
         entity.add(Transform.fromJSON({
             position: { x, y, z }
         }));
-        entity.add(BehaviorComponent.fromOne(OrbitingBehavior.from({
+        entity.add(BehaviorComponent.from(OrbitingBehavior.from({
             center: new Vector3(x,y,z),
             radius: 0.1-0.02
         })))

package/src/engine/graphics/impostors/octahedral/prototypeBaker.js

@@ -149,7 +149,7 @@ function make_spin(entity, speed = 1, axis = Vector3.up) {
         return;
     }
 
-    entity.add(BehaviorComponent.fromOne(RotationBehavior.fromJSON({
+    entity.add(BehaviorComponent.from(RotationBehavior.fromJSON({
         axis, speed
     })));
 }

package/src/engine/graphics/particles/particular/engine/utils/volume/prototypeParticleVolume.js

@@ -994,7 +994,7 @@ function make_box_editor(engine, transform = new Transform()) {
                 }
             }
         ]))
-        .add(BehaviorComponent.looping_function(() => {
+        .add(BehaviorComponent.loop(() => {
 
             threeUpdateTransform(controls);
 
@@ -1210,7 +1210,7 @@ async function make_demo_volume({
     v.attributes.color.lookup = lut;
 
     new Entity()
-        .add(BehaviorComponent.fromOne(RepeatBehavior.from(new ActionBehavior((time) => {
+        .add(BehaviorComponent.from(RepeatBehavior.from(new ActionBehavior((time) => {
             time_total += time;
 
             const _t = pingpong(time_total + period_offset, period);

package/src/engine/graphics/render/forward_plus/plugin/ptototypeFPPlugin.js

@@ -338,7 +338,7 @@ function setup_scene_0(engine, ecd) {
         b.offset.copy(transform.position);
 
         builder
-            .add(BehaviorComponent.fromOne(b))
+            .add(BehaviorComponent.from(b))
             .build(ecd);
     }
 
@@ -647,8 +647,8 @@ function setup_scene_3(engine, ecd) {
 
 
         builder
-            .add(BehaviorComponent.fromOne(b))
-            // .add(BehaviorComponent.looping_function(()=>{
+            .add(BehaviorComponent.from(b))
+            // .add(BehaviorComponent.loop(()=>{
             //
             // }))
             .build(ecd);
@@ -953,7 +953,7 @@ function setup_scene_2(engine, ecd) {
         b.offset.copy(transform.position);
 
         builder
-            .add(BehaviorComponent.fromOne(b))
+            .add(BehaviorComponent.from(b))
             .build(ecd);
     }
 

package/src/engine/graphics/sh3/path_tracer/make_one_vector3.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"make_one_vector3.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/sh3/path_tracer/make_one_vector3.js"],"names":[],"mappings":"AAAA,+GAEC;AACD,iIAMC"}
+{"version":3,"file":"make_one_vector3.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/sh3/path_tracer/make_one_vector3.js"],"names":[],"mappings":"AAAA,+GAEC;AACD,uDACY,QAAG,EAAE,eAAU,EAAE,cAAS,EAAE,qBAAgB,UAKvD"}

package/src/engine/graphics/sh3/path_tracer/make_sky_hosek.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"make_sky_hosek.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/sh3/path_tracer/make_sky_hosek.js"],"names":[],"mappings":"AAQA,2LAmCC"}
+{"version":3,"file":"make_sky_hosek.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/sh3/path_tracer/make_sky_hosek.js"],"names":[],"mappings":"AAQA,2GAaY,WAAM,EAAE,kBAAa,EAAE,cAAS,EAAE,qBAAgB,UAsB7D"}

package/src/engine/graphics/sh3/path_tracer/make_sky_rtiw.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"make_sky_rtiw.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/sh3/path_tracer/make_sky_rtiw.js"],"names":[],"mappings":"AAEA,4GAYC"}
+{"version":3,"file":"make_sky_rtiw.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/sh3/path_tracer/make_sky_rtiw.js"],"names":[],"mappings":"AAEA,kCAGY,QAAG,EAAE,eAAU,EAAE,cAAS,EAAE,qBAAgB,UASvD"}

package/src/engine/graphics/sh3/path_tracer/make_zero_vector3.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"make_zero_vector3.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/sh3/path_tracer/make_zero_vector3.js"],"names":[],"mappings":"AAAA,gHAMC"}
+{"version":3,"file":"make_zero_vector3.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/sh3/path_tracer/make_zero_vector3.js"],"names":[],"mappings":"AAAA,sCACY,QAAG,EAAE,eAAU,EAAE,cAAS,EAAE,qBAAgB,UAKvD"}

package/src/engine/input/devices/PointerDevice.js

@@ -344,7 +344,7 @@ export class PointerDevice {
 
     /**
      *
-     * @param {MouseEvent} event
+     * @param {PointerEvent} event
      */
     #eventHandlerGlobalPointerUp = (event) => {
         this.readPointerPositionFromEvent(this.position, event);

package/src/engine/intelligence/behavior/ecs/BehaviorComponent.d.ts

@@ -1,3 +1,79 @@
-export class BehaviorComponent {
-
-}
+/**
+ * ECS wrapper around a {@link Behavior} tree
+ */
+export class BehaviorComponent {
+    /**
+     * Executes input function every update cycle.
+     * Will run forever.
+     * @param {function(time_delta_seconds:number)} action function to loop over
+     * @param {*} [thisArg]
+     * @returns {BehaviorComponent}
+     */
+    static loop(action: any, thisArg?: any): BehaviorComponent;
+    /**
+     *
+     * @param {Behavior} b
+     * @returns {BehaviorComponent}
+     */
+    static from(b: Behavior): BehaviorComponent;
+    /**
+     * What clock should be used for ticking associated behavior
+     * @type {ClockChannelType|number}
+     */
+    clock: ClockChannelType | number;
+    /**
+     *
+     * @type {number}
+     */
+    flags: number;
+    /**
+     * Associated behavior tree
+     * @type {Behavior|null}
+     * @private
+     */
+    private __behavior;
+    /**
+     *
+     * @param {number|BehaviorComponentFlag} flag
+     * @returns {void}
+     */
+    setFlag(flag: number | BehaviorComponentFlag): void;
+    /**
+     *
+     * @param {number|BehaviorComponentFlag} flag
+     * @returns {void}
+     */
+    clearFlag(flag: number | BehaviorComponentFlag): void;
+    /**
+     *
+     * @param {number|BehaviorComponentFlag} flag
+     * @param {boolean} value
+     */
+    writeFlag(flag: number | BehaviorComponentFlag, value: boolean): void;
+    /**
+     *
+     * @param {number|BehaviorComponentFlag} flag
+     * @returns {boolean}
+     */
+    getFlag(flag: number | BehaviorComponentFlag): boolean;
+    /**
+     *
+     * @param {Behavior} v
+     */
+    set behavior(v: Behavior);
+    /**
+     *
+     * @returns {Behavior|null}
+     */
+    get behavior(): Behavior | null;
+}
+export namespace BehaviorComponent {
+    import fromOne = BehaviorComponent.from;
+    export { fromOne };
+    import looping_function = BehaviorComponent.loop;
+    export { looping_function };
+    export let serializable: boolean;
+    export let typeName: string;
+}
+import { ClockChannelType } from "./ClockChannelType.js";
+//# sourceMappingURL=BehaviorComponent.d.ts.map

package/src/engine/intelligence/behavior/ecs/BehaviorComponent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BehaviorComponent.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/ecs/BehaviorComponent.js"],"names":[],"mappings":"AAKA;IA6EI;;;;;OAKG;IACH,0CAHW,GAAC,GACC,iBAAiB,CAM7B;IAED;;;;OAIG;IACH,kBAHW,QAAQ,GACN,iBAAiB,CAa7B;IAvGD;;;OAGG;IACH,OAFU,gBAAgB,GAAC,MAAM,CAEG;IAEpC;;;OAGG;IACH,OAFU,MAAM,CAEN;IAEV;;;;OAIG;IACH,mBAAkB;IAElB;;;;OAIG;IACH,cAHW,MAAM,GAAC,qBAAqB,GAC1B,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,qBAAqB,GAC1B,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,qBAAqB,SAC5B,OAAO,QAQjB;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,qBAAqB,GAC1B,OAAO,CAInB;IAUD;;;OAGG;IACH,gBAFW,QAAQ,EAIlB;IAdD;;;OAGG;IACH,gBAFa,QAAQ,GAAC,IAAI,CAIzB;CAuCJ;;sBAIS,OAAO;kBAMP,MAAM;;iCAtHiB,uBAAuB"}
+{"version":3,"file":"BehaviorComponent.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/ecs/BehaviorComponent.js"],"names":[],"mappings":"AAKA;;GAEG;AACH;IA6EI;;;;;;OAMG;IACH,mCAHW,GAAC,GACC,iBAAiB,CAQ7B;IAED;;;;OAIG;IACH,eAHW,QAAQ,GACN,iBAAiB,CAa7B;IA1GD;;;OAGG;IACH,OAFU,gBAAgB,GAAC,MAAM,CAEG;IAEpC;;;OAGG;IACH,OAFU,MAAM,CAEN;IAEV;;;;OAIG;IACH,mBAAkB;IAElB;;;;OAIG;IACH,cAHW,MAAM,GAAC,qBAAqB,GAC1B,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,qBAAqB,GAC1B,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,qBAAqB,SAC5B,OAAO,QAQjB;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,qBAAqB,GAC1B,OAAO,CAInB;IAUD;;;OAGG;IACH,gBAFW,QAAQ,EAIlB;IAdD;;;OAGG;IACH,gBAFa,QAAQ,GAAC,IAAI,CAIzB;CA0CJ;;;;;;6BAcS,OAAO;yBAMP,MAAM;;iCAtIiB,uBAAuB"}

package/src/engine/intelligence/behavior/ecs/BehaviorComponent.js

@@ -3,6 +3,9 @@ import { RepeatBehavior } from "../decorator/RepeatBehavior.js";
 import { ActionBehavior } from "../primitive/ActionBehavior.js";
 import { ClockChannelType } from "./ClockChannelType.js";
 
+/**
+ * ECS wrapper around a {@link Behavior} tree
+ */
 export class BehaviorComponent {
 
     /**
@@ -18,7 +21,7 @@ export class BehaviorComponent {
     flags = 0;
 
     /**
-     *
+     * Associated behavior tree
      * @type {Behavior|null}
      * @private
      */
@@ -81,15 +84,18 @@ export class BehaviorComponent {
     }
 
     /**
-     * Executes input function every update cycle
-     * @param {function(time_delta_seconds:number)} f
+     * Executes input function every update cycle.
+     * Will run forever.
+     * @param {function(time_delta_seconds:number)} action function to loop over
      * @param {*} [thisArg]
      * @returns {BehaviorComponent}
      */
-    static looping_function(f, thisArg) {
-        return BehaviorComponent.fromOne(RepeatBehavior.from(
-            new ActionBehavior(f, thisArg)
-        ));
+    static loop(action, thisArg) {
+        return BehaviorComponent.from(
+            RepeatBehavior.from(
+                new ActionBehavior(action, thisArg)
+            )
+        );
     }
 
     /**
@@ -97,7 +103,7 @@ export class BehaviorComponent {
      * @param {Behavior} b
      * @returns {BehaviorComponent}
      */
-    static fromOne(b) {
+    static from(b) {
         assert.defined(b, 'behavior');
         assert.notNull(b, 'behavior');
         assert.equal(b.isBehavior, true, 'b.isBehavior !== true');
@@ -111,6 +117,16 @@ export class BehaviorComponent {
     }
 }
 
+/**
+ * @deprecated use {@link BehaviorComponent.from} instead
+ */
+BehaviorComponent.fromOne = BehaviorComponent.from;
+
+/**
+ * @deprecated use {@link BehaviorComponent.loop} instead
+ */
+BehaviorComponent.looping_function = BehaviorComponent.loop;
+
 /**
  * @readonly
  * @type {boolean}

package/src/engine/intelligence/behavior/ecs/BehaviorComponentSerializationAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BehaviorComponentSerializationAdapter.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/ecs/BehaviorComponentSerializationAdapter.js"],"names":[],"mappings":"AAKA;IAEI,gCAA0B;IAG1B;;;OAGG;IACH,eAFU,gCAAgC,CAErB;IAErB;;;;OAIG;IACH,mBAHW,cAAc,iBACd,gCAAgC,QAI1C;IAED;;;;OAIG;IACH,kBAHW,YAAY,SACZ,iBAAiB,QAc3B;IAED;;;;OAIG;IACH,oBAHW,YAAY,SACZ,iBAAiB,QA+B3B;CACJ;gDA/E+C,gEAAgE;kCAC9E,wBAAwB"}
+{"version":3,"file":"BehaviorComponentSerializationAdapter.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/intelligence/behavior/ecs/BehaviorComponentSerializationAdapter.js"],"names":[],"mappings":"AAKA;IAEI,gCAA0B;IAG1B;;;OAGG;IACH,eAFU,gCAAgC,CAErB;IAErB;;;;OAIG;IACH,mBAHW,cAAc,iBACd,gCAAgC,QAI1C;IAED;;;;OAIG;IACH,kBAHW,YAAY,SACZ,iBAAiB,QAc3B;IAED;;;;OAIG;IACH,oBAHW,YAAY,SACZ,iBAAiB,QA+B3B;CACJ;gDA/E+C,gEAAgE;kCAG9E,wBAAwB"}

package/src/engine/intelligence/behavior/ecs/BehaviorComponentSerializationAdapter.js

@@ -1,7 +1,7 @@
 import { BinaryClassSerializationAdapter } from "../../../ecs/storage/binary/BinaryClassSerializationAdapter.js";
-import { BehaviorComponent } from "./BehaviorComponent.js";
 import { SequenceBehavior } from "../composite/SequenceBehavior.js";
 import { SucceedingBehavior } from "../primitive/SucceedingBehavior.js";
+import { BehaviorComponent } from "./BehaviorComponent.js";
 
 export class BehaviorComponentSerializationAdapter extends BinaryClassSerializationAdapter {
 
@@ -74,7 +74,7 @@ export class BehaviorComponentSerializationAdapter extends BinaryClassSerializat
         } else if (behaviors.length === 1) {
             value.behavior = behaviors[0];
         } else {
-            value.behavior = SucceedingBehavior.from(0);
+            value.behavior = SucceedingBehavior.INSTANCE;
         }
     }
 }

package/src/engine/intelligence/behavior/ecs/BehaviorSystem.d.ts

@@ -1,7 +1,33 @@
-import {System} from "../../../ecs/System";
-import Engine from "../../../Engine";
-import {BehaviorComponent} from "./BehaviorComponent";
-
-export class BehaviorSystem extends System<BehaviorComponent> {
-    constructor(engine: Engine)
-}
+export class BehaviorSystem extends System<any, any, any, any, any> {
+    /**
+     *
+     * @param {Engine} engine
+     */
+    constructor(engine: Engine);
+    dependencies: (typeof BehaviorComponent)[];
+    systemClock: Clock;
+    /**
+     *
+     * @type {Engine}
+     */
+    engine: Engine;
+    startup(entityManager: any, readyCallback: any, errorCallback: any): void;
+    shutdown(entityManager: any, readyCallback: any, errorCallback: any): void;
+    /**
+     *
+     * @param {BehaviorComponent} component
+     * @param {number} entity
+     */
+    link(component: BehaviorComponent, entity: number): void;
+    /**
+     *
+     * @param {BehaviorComponent} component
+     * @param {number} entity
+     */
+    unlink(component: BehaviorComponent, entity: number): void;
+    update(timeDelta: any): void;
+}
+import { System } from "../../../ecs/System.js";
+import { BehaviorComponent } from "./BehaviorComponent.js";
+import Clock from "../../../Clock.js";
+//# sourceMappingURL=BehaviorSystem.d.ts.map

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

@@ -1,14 +1,15 @@
 /**
+ * Single-shot behavior that executes the given function and resolves {@link BehaviorStatus.SUCCESS}
  * @template CTX
  * @extends {Behavior<CTX>}
  */
 export class ActionBehavior<CTX> extends Behavior<CTX> {
     /**
      *
-     * @param {function(timeDelta:number, context:CTX)} func
+     * @param {function(timeDelta:number, context:CTX)} action
      * @param {*} [thisArg] defaults to behavior itself if not specified
      */
-    constructor(func: any, thisArg?: any);
+    constructor(action: any, thisArg?: any);
     __action: any;
     __context: any;
     tick(timeDelta: any): BehaviorStatus.Succeeded | BehaviorStatus.Failed;