@woosh/meep-engine 2.84.4 → 2.84.6

package/build/meep.module.js

@@ -61269,7 +61269,7 @@ class List {
         this.data.push(el);
         const oldLength = this.length;
 
-        this.length++;
+        this.length = oldLength + 1;
 
         this.on.added.send2(el, oldLength);
         return this;
@@ -72502,6 +72502,7 @@ class Entity {
      * @returns {*|null}
      */
     removeComponent(klass) {
+
         const elements = this.components;
         const n = elements.length;
 
@@ -72627,6 +72628,7 @@ class Entity {
             dataset.removeEntity(entity);
 
             this.id = -1;
+            this.generation = -1;
 
             this.clearFlag(EntityFlags.Built);
 
@@ -72652,6 +72654,7 @@ class Entity {
         }
 
         const entity = this.id = dataset.createEntity();
+        this.generation = dataset.getEntityGeneration(entity);
         this.dataset = dataset;
 
         let i;
@@ -72709,6 +72712,7 @@ class Entity {
         r.setFlag(EntityFlags.Built);
         r.id = entity;
         r.dataset = dataset;
+        r.generation = dataset.getEntityGeneration(entity);
 
         return r;
     }
@@ -84050,7 +84054,13 @@ class AssetDescription {
     toString() {
         return `{ type: '${this.type}', path: '${this.path}' }`;
     }
-}
+}
+
+/**
+ * @readonly
+ * @type {boolean}
+ */
+AssetDescription.prototype.isAssetDescription = true;
 
 /**
  * @enum {number}
@@ -92360,6 +92370,15 @@ class EntityComponentDataset {
      * @type {BitSet}
      */
     entityOccupancy = new BitSet();
+
+    /**
+     * For each entity ID records generation when entity was created
+     * Values are invalid for unused entity IDs
+     * @private
+     * @type {Uint32Array}
+     */
+    entityGeneration = new Uint32Array(0);
+
     /**
      * @private
      * @type {BitSet}
@@ -92411,7 +92430,7 @@ class EntityComponentDataset {
 
     /**
      * @readonly
-     * @type {Signal}
+     * @type {Signal<number>}
      */
     onEntityCreated = new Signal();
 
@@ -92961,38 +92980,79 @@ class EntityComponentDataset {
 
     /**
      *
-     * @returns {number} entityIndex
+     * @param {number} min_size
      */
-    createEntity() {
-        const entityIndex = this.entityOccupancy.nextClearBit(0);
-        this.entityOccupancy.set(entityIndex, true);
+    enlargeGenerationTable(min_size) {
+        const old_generation_table_size = this.entityGeneration.length;
 
-        this.entityCount++;
+        const new_size = max3(
+            min_size,
+            Math.ceil(old_generation_table_size * 1.2),
+            old_generation_table_size + 16
+        );
 
-        this.onEntityCreated.send1(entityIndex);
+        const new_generation_table = new Uint32Array(new_size);
 
-        this.generation++;
+        new_generation_table.set(this.entityGeneration);
 
-        return entityIndex;
+        this.entityGeneration = new_generation_table;
     }
 
     /**
-     *
-     * @param {number} entityIndex
-     * @throws {Error} if entity index is already in use
+     * Produces generation ID for a given entity
+     * @param {number} entity_id
+     * @returns {number}
+     */
+    getEntityGeneration(entity_id) {
+        return this.entityGeneration[entity_id];
+    }
+
+    /**
+     * @private
+     * @param {number} entity_id
      */
-    createEntitySpecific(entityIndex) {
-        if (this.entityExists(entityIndex)) {
-            throw new Error(`EntityId ${entityIndex} is already in use`);
+    createEntityUnsafe(entity_id) {
+        this.entityOccupancy.set(entity_id, true);
+
+        // record entity generation
+        if (this.entityGeneration.length <= entity_id) {
+            // needs to be resized
+            this.enlargeGenerationTable(entity_id + 1);
         }
 
-        this.entityOccupancy.set(entityIndex, true);
+        const current_generation = this.generation;
+        this.generation = current_generation + 1;
+
+        this.entityGeneration[entity_id] = current_generation;
 
         this.entityCount++;
 
-        this.onEntityCreated.send1(entityIndex);
+        this.onEntityCreated.send1(entity_id);
+    }
+
+    /**
+     *
+     * @returns {number} entityIndex
+     */
+    createEntity() {
+        const entity_id = this.entityOccupancy.nextClearBit(0);
 
-        this.generation++;
+        this.createEntityUnsafe(entity_id);
+
+        return entity_id;
+    }
+
+    /**
+     *
+     * @param {number} entity_id
+     * @throws {Error} if entity index is already in use
+     */
+    createEntitySpecific(entity_id) {
+        if (this.entityExists(entity_id)) {
+            throw new Error(`EntityId ${entity_id} is already in use`);
+        }
+
+        this.createEntityUnsafe(entity_id);
     }
 
     /**
@@ -93117,7 +93177,7 @@ class EntityComponentDataset {
         const componentClass = this.componentTypeMap[componentIndex];
 
         //dispatch event to components
-        this.sendEvent(entityIndex, EventType.ComponentRemoved, {klass: componentClass, instance: componentInstance});
+        this.sendEvent(entityIndex, EventType.ComponentRemoved, { klass: componentClass, instance: componentInstance });
     }
 
     /**
@@ -93218,7 +93278,7 @@ class EntityComponentDataset {
         const componentClass = this.componentTypeMap[componentIndex];
 
         //dispatch event to components
-        this.sendEvent(entityIndex, EventType.ComponentAdded, {klass: componentClass, instance: componentInstance});
+        this.sendEvent(entityIndex, EventType.ComponentAdded, { klass: componentClass, instance: componentInstance });
     }
 
     /**
@@ -96024,40 +96084,38 @@ LinearValue.prototype.fromJSON = function (json) {
 
 /**
  *
- * @param {number} x
- * @param {string} [separator=',']
+ * @param {string} string
+ * @param {string} trailing_sequence
  * @returns {string}
  */
-function number_format_by_thousands(x, separator = ',') {
+function string_strip_trailing(string, trailing_sequence) {
+    const trailing_sequence_length = trailing_sequence.length;
 
-    return x.toString().replace(/\B(?=(\d{3})+(?!\d))/g, separator);
+    if (trailing_sequence_length <= 0) {
+        // special case to avoid infinite looping
+        return string;
+    }
+
+    let end_index = string.length;
+
+    while (string.substring(end_index - trailing_sequence_length, end_index) === trailing_sequence) {
+        end_index -= trailing_sequence_length;
+    }
+
+    return string.substring(0, end_index);
 }
 
 /**
  *
- * @param {string} value
- * @returns {number}
+ * @param {number} x
+ * @param {string} [separator=',']
+ * @returns {string}
  */
-function countDecimals(value) {
-    if (value % 1 === 0) {
-        //whole number
-        return 0;
-    }
-    const s = value.toString();
-    const index = s.indexOf('.');
-
-    if (index === -1) {
-        return 0;
-    }
-
-    //find last 0
-    let endIndex = s.length - 1;
-    for (; endIndex > index && s.charAt(endIndex) === "0"; endIndex--) {
-
-    }
-    return endIndex - index;
-}
+function number_format_by_thousands(x, separator = ',') {
 
+    return x.toString().replace(/\B(?=(\d{3})+(?!\d))/g, separator);
+}
+
 /**
  *
  * @param {number} value
@@ -96068,10 +96126,12 @@ function number_pretty_print(value) {
     const MAX_DECIMALS = 2;
 
     const fraction = value % 1;
-    if (fraction !== 0 && Math.abs(value) < 100) {
-        const decimals = countDecimals(value.toFixed(MAX_DECIMALS));
-        const decimalsToPrint = Math.min(decimals, MAX_DECIMALS);
-        return value.toFixed(decimalsToPrint);
+
+    const would_produce_decimals = fraction * Math.pow(10, MAX_DECIMALS) > 0;
+
+    if (would_produce_decimals && Math.abs(value) < 100) {
+        const truncated = value.toFixed(MAX_DECIMALS);
+        return string_strip_trailing(truncated, "0");
     } else {
         //no fraction
         return number_format_by_thousands(value - fraction, ",");

package/package.json

@@ -5,7 +5,7 @@
   "description": "Fully featured ECS game engine written in JavaScript",
   "type": "module",
   "author": "Alexander Goldring",
-  "version": "2.84.4",
+  "version": "2.84.6",
   "main": "build/meep.module.js",
   "module": "build/meep.module.js",
   "exports": {

package/src/core/collection/list/List.js

@@ -99,7 +99,7 @@ class List {
         this.data.push(el);
         const oldLength = this.length;
 
-        this.length++;
+        this.length = oldLength + 1;
 
         this.on.added.send2(el, oldLength);
         return this;

package/src/core/primitives/numbers/number_count_decimals.js

@@ -0,0 +1,30 @@
+import { assert } from "../../assert.js";
+
+/**
+ *
+ * @param {number} value
+ * @returns {number}
+ */
+export function number_count_decimals(value) {
+    assert.isNumber(value, 'value');
+
+    if (value % 1 === 0) {
+        //whole number
+        return 0;
+    }
+
+    const s = value.toString();
+    const index = s.indexOf('.');
+
+    if (index === -1) {
+        return 0;
+    }
+
+    //find last 0
+    let endIndex = s.length - 1;
+    for (; endIndex > index && s.charAt(endIndex) === "0"; endIndex--) {
+
+    }
+
+    return endIndex - index;
+}

package/src/core/primitives/numbers/number_pretty_print.js

@@ -1,31 +1,7 @@
 import { assert } from "../../assert.js";
+import { string_strip_trailing } from "../strings/string_strip_trailing.js";
 import { number_format_by_thousands } from "./number_format_by_thousands.js";
 
-/**
- *
- * @param {string} value
- * @returns {number}
- */
-function countDecimals(value) {
-    if (value % 1 === 0) {
-        //whole number
-        return 0;
-    }
-    const s = value.toString();
-    const index = s.indexOf('.');
-
-    if (index === -1) {
-        return 0;
-    }
-
-    //find last 0
-    let endIndex = s.length - 1;
-    for (; endIndex > index && s.charAt(endIndex) === "0"; endIndex--) {
-
-    }
-    return endIndex - index;
-}
-
 /**
  *
  * @param {number} value
@@ -37,10 +13,12 @@ export function number_pretty_print(value) {
     const MAX_DECIMALS = 2;
 
     const fraction = value % 1;
-    if (fraction !== 0 && Math.abs(value) < 100) {
-        const decimals = countDecimals(value.toFixed(MAX_DECIMALS));
-        const decimalsToPrint = Math.min(decimals, MAX_DECIMALS);
-        return value.toFixed(decimalsToPrint);
+
+    const would_produce_decimals = fraction * Math.pow(10, MAX_DECIMALS) > 0;
+
+    if (would_produce_decimals && Math.abs(value) < 100) {
+        const truncated = value.toFixed(MAX_DECIMALS);
+        return string_strip_trailing(truncated, "0");
     } else {
         //no fraction
         return number_format_by_thousands(value - fraction, ",");

package/src/core/primitives/strings/string_format_camel_to_kebab.js

@@ -7,3 +7,5 @@
 export function string_format_camel_to_kebab(string) {
     return string.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
 }
+
+

package/src/core/primitives/strings/string_strip_trailing.js

@@ -0,0 +1,22 @@
+/**
+ *
+ * @param {string} string
+ * @param {string} trailing_sequence
+ * @returns {string}
+ */
+export function string_strip_trailing(string, trailing_sequence) {
+    const trailing_sequence_length = trailing_sequence.length;
+
+    if (trailing_sequence_length <= 0) {
+        // special case to avoid infinite looping
+        return string;
+    }
+
+    let end_index = string.length;
+
+    while (string.substring(end_index - trailing_sequence_length, end_index) === trailing_sequence) {
+        end_index -= trailing_sequence_length;
+    }
+
+    return string.substring(0, end_index);
+}

package/src/core/primitives/strings/string_strip_trailing.spec.js

@@ -0,0 +1,27 @@
+import { string_strip_trailing } from "./string_strip_trailing.js";
+
+test("strip empty from empty", () => {
+    expect(
+        string_strip_trailing("", "")
+    ).toBe("");
+});
+
+test("strip repeating 2 character sequence", () => {
+
+    expect(
+        string_strip_trailing("Cabab", "ab")
+    ).toBe("C");
+
+});
+
+test("mistakes", () => {
+
+    expect(
+        string_strip_trailing("food", "o")
+    ).toBe("food");
+
+    expect(
+        string_strip_trailing("food", "f")
+    ).toBe("food");
+
+});

package/src/engine/asset/AssetDescription.js

@@ -49,3 +49,9 @@ export class AssetDescription {
         return `{ type: '${this.type}', path: '${this.path}' }`;
     }
 }
+
+/**
+ * @readonly
+ * @type {boolean}
+ */
+AssetDescription.prototype.isAssetDescription = true;

package/src/engine/ecs/Entity.js

@@ -205,6 +205,8 @@ class Entity {
      * @returns {*|null}
      */
     removeComponent(klass) {
+        assert.defined(klass, 'klass');
+
         const elements = this.components;
         const n = elements.length;
 
@@ -332,6 +334,7 @@ class Entity {
             dataset.removeEntity(entity);
 
             this.id = -1;
+            this.generation = -1;
 
             this.clearFlag(EntityFlags.Built);
 
@@ -359,6 +362,7 @@ class Entity {
         }
 
         const entity = this.id = dataset.createEntity();
+        this.generation = dataset.getEntityGeneration(entity);
         this.dataset = dataset;
 
         let i;
@@ -416,6 +420,7 @@ class Entity {
         r.setFlag(EntityFlags.Built);
         r.id = entity;
         r.dataset = dataset;
+        r.generation = dataset.getEntityGeneration(entity);
 
         return r;
     }

package/src/engine/ecs/EntityComponentDataset.js

@@ -1,13 +1,14 @@
-import {BitSet} from "../../core/binary/BitSet.js";
-import {assert} from "../../core/assert.js";
+import { assert } from "../../core/assert.js";
+import { BitSet } from "../../core/binary/BitSet.js";
+import { array_shrink_to_size } from "../../core/collection/array/array_shrink_to_size.js";
+import { arraySetDiff } from "../../core/collection/array/arraySetDiff.js";
 import Signal, {
     findSignalHandlerIndexByHandle,
     findSignalHandlerIndexByHandleAndContext
 } from "../../core/events/signal/Signal.js";
-import {EventType} from "./EntityManager.js";
-import {SignalHandler} from "../../core/events/signal/SignalHandler.js";
-import {arraySetDiff} from "../../core/collection/array/arraySetDiff.js";
-import {array_shrink_to_size} from "../../core/collection/array/array_shrink_to_size.js";
+import { SignalHandler } from "../../core/events/signal/SignalHandler.js";
+import { max3 } from "../../core/math/max3.js";
+import { EventType } from "./EntityManager.js";
 
 /**
  *
@@ -116,6 +117,15 @@ export class EntityComponentDataset {
      * @type {BitSet}
      */
     entityOccupancy = new BitSet();
+
+    /**
+     * For each entity ID records generation when entity was created
+     * Values are invalid for unused entity IDs
+     * @private
+     * @type {Uint32Array}
+     */
+    entityGeneration = new Uint32Array(0);
+
     /**
      * @private
      * @type {BitSet}
@@ -167,7 +177,7 @@ export class EntityComponentDataset {
 
     /**
      * @readonly
-     * @type {Signal}
+     * @type {Signal<number>}
      */
     onEntityCreated = new Signal();
 
@@ -448,6 +458,7 @@ export class EntityComponentDataset {
      */
     setComponentTypeMap(map) {
         assert.defined(map, "map");
+        assert.isArray(map, 'map');
 
         const newComponentTypeCount = map.length;
 
@@ -726,38 +737,79 @@ export class EntityComponentDataset {
 
     /**
      *
-     * @returns {number} entityIndex
+     * @param {number} min_size
      */
-    createEntity() {
-        const entityIndex = this.entityOccupancy.nextClearBit(0);
-        this.entityOccupancy.set(entityIndex, true);
+    enlargeGenerationTable(min_size) {
+        const old_generation_table_size = this.entityGeneration.length;
 
-        this.entityCount++;
+        const new_size = max3(
+            min_size,
+            Math.ceil(old_generation_table_size * 1.2),
+            old_generation_table_size + 16
+        );
 
-        this.onEntityCreated.send1(entityIndex);
+        const new_generation_table = new Uint32Array(new_size);
 
-        this.generation++;
+        new_generation_table.set(this.entityGeneration);
 
-        return entityIndex;
+        this.entityGeneration = new_generation_table
     }
 
     /**
-     *
-     * @param {number} entityIndex
-     * @throws {Error} if entity index is already in use
+     * Produces generation ID for a given entity
+     * @param {number} entity_id
+     * @returns {number}
+     */
+    getEntityGeneration(entity_id) {
+        return this.entityGeneration[entity_id];
+    }
+
+    /**
+     * @private
+     * @param {number} entity_id
      */
-    createEntitySpecific(entityIndex) {
-        if (this.entityExists(entityIndex)) {
-            throw new Error(`EntityId ${entityIndex} is already in use`);
+    createEntityUnsafe(entity_id) {
+        this.entityOccupancy.set(entity_id, true);
+
+        // record entity generation
+        if (this.entityGeneration.length <= entity_id) {
+            // needs to be resized
+            this.enlargeGenerationTable(entity_id + 1);
         }
 
-        this.entityOccupancy.set(entityIndex, true);
+        const current_generation = this.generation;
+        this.generation = current_generation + 1;
+
+        this.entityGeneration[entity_id] = current_generation;
 
         this.entityCount++;
 
-        this.onEntityCreated.send1(entityIndex);
+        this.onEntityCreated.send1(entity_id);
+    }
+
+    /**
+     *
+     * @returns {number} entityIndex
+     */
+    createEntity() {
+        const entity_id = this.entityOccupancy.nextClearBit(0);
+
+        this.createEntityUnsafe(entity_id);
+
+        return entity_id;
+    }
+
+    /**
+     *
+     * @param {number} entity_id
+     * @throws {Error} if entity index is already in use
+     */
+    createEntitySpecific(entity_id) {
+        if (this.entityExists(entity_id)) {
+            throw new Error(`EntityId ${entity_id} is already in use`);
+        }
 
-        this.generation++;
+        this.createEntityUnsafe(entity_id);
     }
 
     /**
@@ -887,7 +939,7 @@ export class EntityComponentDataset {
         const componentClass = this.componentTypeMap[componentIndex];
 
         //dispatch event to components
-        this.sendEvent(entityIndex, EventType.ComponentRemoved, {klass: componentClass, instance: componentInstance});
+        this.sendEvent(entityIndex, EventType.ComponentRemoved, { klass: componentClass, instance: componentInstance });
     }
 
     /**
@@ -999,7 +1051,7 @@ export class EntityComponentDataset {
         const componentClass = this.componentTypeMap[componentIndex];
 
         //dispatch event to components
-        this.sendEvent(entityIndex, EventType.ComponentAdded, {klass: componentClass, instance: componentInstance});
+        this.sendEvent(entityIndex, EventType.ComponentAdded, { klass: componentClass, instance: componentInstance });
     }
 
     /**

package/src/engine/ecs/storage/BinaryBufferDeSerializer.js

@@ -1,4 +1,5 @@
 import { assert } from "../../../core/assert.js";
+import { number_pretty_print } from "../../../core/primitives/numbers/number_pretty_print.js";
 import Task from "../../../core/process/task/Task.js";
 import { TaskSignal } from "../../../core/process/task/TaskSignal.js";
 import { emptyTask } from "../../../core/process/task/util/emptyTask.js";
@@ -24,6 +25,7 @@ class BinaryBufferDeSerializer {
         assert.notEqual(engine, undefined, 'engine is undefined');
         assert.notEqual(dataset, undefined, 'dataset is undefined');
 
+        const entity_count_before = dataset.entityCount;
 
         const version = buffer.readUint16();
         const numSerializedTypes = buffer.readUint16();
@@ -37,7 +39,12 @@ class BinaryBufferDeSerializer {
         }
 
         task.on.completed.add(function () {
-            console.log(`Binary Buffer De-Serialization took ${task.getExecutedCpuTime()}ms`);
+            const entity_count_after = dataset.entityCount;
+
+            const execution_time = task.getExecutedCpuTime();
+            const entity_count = entity_count_after - entity_count_before;
+
+            console.log(`Binary Buffer De-Serialization took ${number_pretty_print(execution_time)}ms. ${entity_count} Entities`);
         });
 
         return task;