@woosh/meep-engine 2.126.11 → 2.126.14

package/package.json

@@ -5,7 +5,7 @@
   "description": "Pure JavaScript game engine. Fully featured and production ready.",
   "type": "module",
   "author": "Alexander Goldring",
-  "version": "2.126.11",
+  "version": "2.126.14",
   "main": "build/meep.module.js",
   "module": "build/meep.module.js",
   "exports": {

package/src/engine/ecs/components/SerializationMetadata.d.ts

@@ -1,9 +1,14 @@
+export type SerializationFlags = number;
 export namespace SerializationFlags {
     let Transient: number;
 }
+/**
+ * Stores settings for entity serialization
+ */
 export class SerializationMetadata {
     /**
-     *
+     * 32 bit bitfield.
+     * Use {@link setFlag}/{@link getFlag} etc. to read individual flag values
      * @type {number}
      */
     flags: number;
@@ -12,33 +17,25 @@ export class SerializationMetadata {
      * @param {number|SerializationFlags} flag
      * @returns {void}
      */
-    setFlag(flag: number | {
-        Transient: number;
-    }): void;
+    setFlag(flag: number | SerializationFlags): void;
     /**
      *
      * @param {number|SerializationFlags} flag
      * @returns {void}
      */
-    clearFlag(flag: number | {
-        Transient: number;
-    }): void;
+    clearFlag(flag: number | SerializationFlags): void;
     /**
      *
      * @param {number|SerializationFlags} flag
      * @param {boolean} value
      */
-    writeFlag(flag: number | {
-        Transient: number;
-    }, value: boolean): void;
+    writeFlag(flag: number | SerializationFlags, value: boolean): void;
     /**
      *
      * @param {number|SerializationFlags} flag
      * @returns {boolean}
      */
-    getFlag(flag: number | {
-        Transient: number;
-    }): boolean;
+    getFlag(flag: number | SerializationFlags): boolean;
     toJSON(): {
         flags: number;
     };

package/src/engine/ecs/components/SerializationMetadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SerializationMetadata.d.ts","sourceRoot":"","sources":["../../../../../src/engine/ecs/components/SerializationMetadata.js"],"names":[],"mappings":";;;AAIA;IAEI;;;OAGG;IACH,OAFU,MAAM,CAEN;IAEV;;;;OAIG;IACH,cAHW,MAAM;;KAAmB,GACvB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM;;KAAmB,GACvB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM;;KAAmB,SACzB,OAAO,QAQjB;IAED;;;;OAIG;IACH,cAHW,MAAM;;KAAmB,GACvB,OAAO,CAInB;IAED;;MAIC;IAED;;aAEC;CACJ"}
+{"version":3,"file":"SerializationMetadata.d.ts","sourceRoot":"","sources":["../../../../../src/engine/ecs/components/SerializationMetadata.js"],"names":[],"mappings":"iCAEU,MAAM;;;;AAShB;;GAEG;AACH;IAEI;;;;OAIG;IACH,OAFU,MAAM,CAEN;IAEV;;;;OAIG;IACH,cAHW,MAAM,GAAC,kBAAkB,GACvB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,kBAAkB,GACvB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,kBAAkB,SACzB,OAAO,QAQjB;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,kBAAkB,GACvB,OAAO,CAInB;IAED;;MAIC;IAED;;aAEC;CACJ"}

package/src/engine/ecs/components/SerializationMetadata.js

@@ -1,11 +1,22 @@
+/**
+ *
+ * @enum {number}
+ */
 export const SerializationFlags = {
+    /**
+     * When set, entity is considered non-permanent and should not be serialized
+     */
     Transient: 1
 };
 
+/**
+ * Stores settings for entity serialization
+ */
 export class SerializationMetadata {
 
     /**
-     *
+     * 32 bit bitfield.
+     * Use {@link setFlag}/{@link getFlag} etc. to read individual flag values
      * @type {number}
      */
     flags = 0;

package/src/engine/ecs/storage/BinaryBufferSerializer.d.ts

@@ -1,15 +1,18 @@
 export default BinaryBufferSerializer;
-declare class BinaryBufferSerializer {
+/**
+ * @template CTX
+ */
+declare class BinaryBufferSerializer<CTX> {
     /**
      *
      * @type {BinarySerializationRegistry}
      */
     registry: BinarySerializationRegistry;
     /**
-     *
-     * @type {Engine|null}
+     * Context to be supplied to individual serialization adapters
+     * @type {CTX|null}
      */
-    engine: Engine | null;
+    engine: CTX | null;
     /**
      *
      * @param {EntityComponentDataset} dataset

package/src/engine/ecs/storage/BinaryBufferSerializer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BinaryBufferSerializer.d.ts","sourceRoot":"","sources":["../../../../../src/engine/ecs/storage/BinaryBufferSerializer.js"],"names":[],"mappings":";AAmDA;IACI;;;OAGG;IACH,UAFU,2BAA2B,CAErB;IAEhB;;;OAGG;IACH,QAFU,MAAM,GAAC,IAAI,CAEP;IAEd;;;;OAIG;IACH,gBAFW,YAAY,WADZ,sBAAsB,QA6HhC;CACJ"}
+{"version":3,"file":"BinaryBufferSerializer.d.ts","sourceRoot":"","sources":["../../../../../src/engine/ecs/storage/BinaryBufferSerializer.js"],"names":[],"mappings":";AAmDA;;GAEG;AACH,qCAFa,GAAG;IAGZ;;;OAGG;IACH,UAFU,2BAA2B,CAErB;IAEhB;;;OAGG;IACH,QAFU,GAAG,GAAC,IAAI,CAEJ;IAEd;;;;OAIG;IACH,gBAFW,YAAY,WADZ,sBAAsB,QA+HhC;CACJ"}

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

@@ -16,7 +16,7 @@ function isComponentClassSerializable(componentClass) {
 }
 
 /**
- * Whether or not an entity should be serialized at all
+ * Whether an entity should be serialized at all
  * @param {number} entity
  * @param {EntityComponentDataset} dataset
  * @param {number} smComponentIndex
@@ -49,6 +49,9 @@ function isEntityTransient(entity, dataset, smComponentIndex, componentInstance)
     return isTransient;
 }
 
+/**
+ * @template CTX
+ */
 class BinaryBufferSerializer {
     /**
      *
@@ -57,8 +60,8 @@ class BinaryBufferSerializer {
     registry = null;
 
     /**
-     *
-     * @type {Engine|null}
+     * Context to be supplied to individual serialization adapters
+     * @type {CTX|null}
      */
     engine = null;
 
@@ -79,11 +82,13 @@ class BinaryBufferSerializer {
 
         const numSerializableTypes = serializableComponentTypes.length;
 
-        const typeCountAddress = buffer.position;
 
         const FORMAT_VERSION = 0;
 
         buffer.writeUint16(FORMAT_VERSION)
+
+        const typeCountAddress = buffer.position;
+
         buffer.writeUint16(numSerializableTypes);
 
         const collectionSerializer = new BinaryCollectionSerializer();
@@ -144,13 +149,13 @@ class BinaryBufferSerializer {
 
             dataset.traverseComponents(componentType, function (componentInstance, entity) {
                 if (isEntityTransient(entity, dataset, smComponentIndex, componentInstance)) {
-                    //skip
+                    // skip
                     return;
                 }
 
                 assert.ok(entity >= lastEntity, `entity[=${entity}] < lastEntity[=${lastEntity}]`);
 
-                //write only the entity step
+                // write only the entity step
                 const step = entity - lastEntity;
 
                 lastEntity = entity;
@@ -169,22 +174,22 @@ class BinaryBufferSerializer {
 
                 const currentPosition = buffer.position;
 
-                //print size of the component set
+                // print size of the component set
                 const componentsByteSize = currentPosition - positionComponentsStart;
                 console.log(`Component ${componentType.typeName} written. Count: ${numComponentsWritten}, Bytes: ${componentsByteSize}, Bytes/component: ${Math.ceil(componentsByteSize / numComponentsWritten)}. Time taken: ${((__end_time - __start_time) * 1000).toFixed(2)}ms`);
             } else {
-                //no elements written, lets re-wind to skip the type
+                // no elements written, lets re-wind to skip the type
                 buffer.position = positionComponentsStart;
             }
         }
 
-        //go back and patch actual number of written classes
+        // go back and patch actual number of written classes
         const p = buffer.position;
 
         buffer.position = typeCountAddress;
-        buffer.writeUint32(numTypesWritten);
+        buffer.writeUint16(numTypesWritten);
 
-        //restore position
+        // restore position
         buffer.position = p;
 
         console.timeEnd('serializing');