@woosh/meep-engine 2.119.94 → 2.119.96

package/package.json

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

package/src/core/model/node-graph/util/convert_node_graph_to_dot_string.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Creates a Graphviz diagram from a node graph
+ * @param {NodeGraph} graph
+ * @returns {string}
+ */
+export function convert_node_graph_to_dot_string({ graph }: NodeGraph): string;
+//# sourceMappingURL=convert_node_graph_to_dot_string.d.ts.map

package/src/core/model/node-graph/util/convert_node_graph_to_dot_string.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert_node_graph_to_dot_string.d.ts","sourceRoot":"","sources":["../../../../../../src/core/model/node-graph/util/convert_node_graph_to_dot_string.js"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,4DAHW,SAAS,GACP,MAAM,CA6DlB"}

package/src/core/model/node-graph/util/convert_node_graph_to_dot_string.js

@@ -0,0 +1,67 @@
+import LineBuilder from "../../../codegen/LineBuilder.js";
+
+/**
+ * Creates a Graphviz diagram from a node graph
+ * @param {NodeGraph} graph
+ * @returns {string}
+ */
+export function convert_node_graph_to_dot_string({graph}){
+    // see https://stackoverflow.com/questions/7922960/block-diagram-layout-with-dot-graphviz
+
+    const lb = new LineBuilder();
+
+    lb.add('digraph G {');
+    lb.indent();
+
+    lb.add('graph [rankdir = LR];')
+    lb.add('node[shape=record];')
+
+    function nodeId(index) {
+        return `n${index}`;
+    }
+
+    /**
+     *
+     * @param index
+     * @returns {string}
+     */
+    function portId(index){
+        return `p${index}`;
+    }
+
+    /**
+     *
+     * @param {NodeInstancePortReference[]} endpoints
+     * @returns {string}
+     */
+    function portBlock(endpoints){
+        return `{${endpoints.map(e => `<${portId(e.port.id)}>${e.port.name}`).join("|")}}`;
+    }
+
+    // populate nodes
+    const nodes = graph.getNodes();
+    for (let i = 0; i < nodes.length; i++) {
+        const node = nodes[i];
+
+        const inputs = portBlock(node.inEndpoints);
+        const outputs = portBlock(node.outEndpoints);
+
+        lb.add(`${nodeId(node.id)}[label="${inputs}|${node.desciption.name}/${node.id}|${outputs}"];`)
+    }
+
+    // populate connections
+    const connections = graph.getConnections();
+    for (let i = 0; i < connections.length; i++) {
+        const connection = connections[i];
+
+        const source = connection.source;
+        const target = connection.target;
+        lb.add(`${nodeId(source.instance.id)}:${portId(source.port.id)} -> ${nodeId(source.instance.id)}:${portId(source.port.id)};`);
+    }
+
+    lb.dedent();
+    lb.add('}');
+
+
+    return lb.build();
+}

package/src/engine/Engine.js

@@ -48,6 +48,38 @@ class Engine {
 
     viewStack = new ViewStack();
 
+    /**
+     *
+     * Static database
+     * Can contain tables of structured data that the application often works with.
+     * Engine startup will load all tables ensuring that data is ready once startup finishes
+     * Use sparingly, this is not suitable for very large amounts of data as all the data will be in memory and deserialization will stall engine startup
+     * Example: inventory item table, monster table
+     * @readonly
+     * @type {StaticKnowledgeDatabase}
+     */
+    staticKnowledge = new StaticKnowledgeDatabase();
+
+    /**
+     * @readonly
+     * @type {EnginePluginManager}
+     */
+    plugins = new EnginePluginManager();
+
+    /**
+     * Main simulation ticker
+     * @readonly
+     * @type {Ticker}
+     */
+    ticker = new Ticker();
+
+    /**
+     * Default executor, enables time-sharing concurrency
+     * @readonly
+     * @type {ConcurrentExecutor}
+     */
+    executor = new ConcurrentExecutor(1, 10);
+
     /**
      *
      * @param {EnginePlatform} platform
@@ -71,18 +103,8 @@ class Engine {
          */
         this.platform = platform;
 
-        /**
-         *
-         * @type {StaticKnowledgeDatabase}
-         */
-        this.staticKnowledge = new StaticKnowledgeDatabase();
         this.staticKnowledge.validation_enabled = debug;
 
-        /**
-         *
-         * @type {EnginePluginManager}
-         */
-        this.plugins = new EnginePluginManager();
 
         /**
          *
@@ -90,11 +112,6 @@ class Engine {
          */
         this.performance = new MetricCollection();
 
-        /**
-         *
-         * @type {ConcurrentExecutor}
-         */
-        this.executor = new ConcurrentExecutor(1, 10);
 
         this.__using_external_entity_manager = entityManager !== undefined;
 
@@ -106,11 +123,6 @@ class Engine {
             this.entityManager = new EntityManager();
         }
 
-        /**
-         *
-         * @type {Ticker}
-         */
-        this.ticker = new Ticker();
 
         /**
          *

package/src/engine/EngineConfiguration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EngineConfiguration.d.ts","sourceRoot":"","sources":["../../../src/engine/EngineConfiguration.js"],"names":[],"mappings":"AAGA;IAEI;;;OAGG;IACH,gBAAa;IAEb;;;OAGG;IACH,gBAAa;IAEb;;;OAGG;IACH,kBAAe;IAEf;;;OAGG;IACH,SAFU,GAAG,CAAC,MAAM,EAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAElB;IAEpB;;;;OAIG;IACH,gBAHW,MAAM,GACJ,OAAO,CAInB;IAED;;;;OAIG;IACH,UAJa,CAAC,QACH,MAAM,UACN,WAAW,CAAC,CAAC,CAAC,WAUxB;IAED;;;;OAIG;IACH,aAJa,CAAC,QACH,MAAM,GACJ,WAAW,CAAC,CAAC,CAAC,CAU1B;IAED;;;;OAIG;IACH,kBAHW,KAAK,CAAC,YAAY,CAAC,GACjB,OAAO,CAQnB;IAED;;;;OAIG;IACH,kBAHW,MAAM,GACJ,OAAO,CAUnB;IAED;;OAEG;IACH,2BAFW,MAAM,QAOhB;IAED;;;;OAIG;IACH,oBAHW,kCAAkC,GAChC,OAAO,CASnB;IAED;;;OAGG;IACH,cAFW,MAAM,iBAqDhB;CACJ"}
+{"version":3,"file":"EngineConfiguration.d.ts","sourceRoot":"","sources":["../../../src/engine/EngineConfiguration.js"],"names":[],"mappings":"AAGA;IAEI;;;OAGG;IACH,gBAAa;IAEb;;;OAGG;IACH,gBAAa;IAEb;;;;;;;;;OASG;IACH,2BAAe;IAEf;;;OAGG;IACH,SAFU,GAAG,CAAC,MAAM,EAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAElB;IAEpB;;;;OAIG;IACH,gBAHW,MAAM,GACJ,OAAO,CAInB;IAED;;;;OAIG;IACH,UAJa,CAAC,QACH,MAAM,UACN,WAAW,CAAC,CAAC,CAAC,WAUxB;IAED;;;;OAIG;IACH,aAJa,CAAC,QACH,MAAM,GACJ,WAAW,CAAC,CAAC,CAAC,CAU1B;IAED;;;;OAIG;IACH,kBAHW,KAAK,CAAC,YAAY,CAAC,GACjB,OAAO,CAQnB;IAED;;;;OAIG;IACH,kBAHW,MAAM,GACJ,OAAO,CAUnB;IAED;;OAEG;IACH,2BAFW,MAAM,QAOhB;IAED;;;;OAIG;IACH,oBAHW,kCAAkC,GAChC,OAAO,CASnB;IAED;;;OAGG;IACH,cAFW,MAAM,iBAqDhB;CACJ"}

package/src/engine/EngineConfiguration.js

@@ -16,7 +16,13 @@ export class EngineConfiguration {
     plugins = [];
 
     /**
+     * Static database
+     * Can contain tables of structured data that the application often works with.
+     * Engine startup will load all tables ensuring that data is ready once startup finishes
+     * Use sparingly, this is not suitable for very large amounts of data as all the data will be in memory and deserialization will stall engine startup
+     * Example: inventory item table, monster table
      * @private
+     * @readonly
      * @type {StaticKnowledgeDataTableDescriptor[]}
      */
     knowledge = [];

package/src/engine/reference/v2/Reference.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Reference.d.ts","sourceRoot":"","sources":["../../../../../src/engine/reference/v2/Reference.js"],"names":[],"mappings":"AAEA;;GAEG;AACH,uBAFa,CAAC;IA0BV,qBAEC;IAED;;;OAGG;IACH,kBAFa,MAAM,CAAC,IAAI,EAAC,CAAC,CAAC,CAI1B;IAED;;;OAGG;IACH,YAFW,CAAC,QAcX;IAED;;;OAGG;IACH,YAFa,CAAC,CAIb;IAED;;;OAGG;IACH,gBAcC;;CACJ;;cAKS,QAAQ,gBAAW;;mBA3FV,uCAAuC"}
+{"version":3,"file":"Reference.d.ts","sourceRoot":"","sources":["../../../../../src/engine/reference/v2/Reference.js"],"names":[],"mappings":"AAEA;;;;;;;;;GASG;AACH,uBAFa,CAAC;IA0BV,qBAEC;IAED;;;OAGG;IACH,kBAFa,MAAM,CAAC,IAAI,EAAC,CAAC,CAAC,CAI1B;IAED;;;OAGG;IACH,YAFW,CAAC,QAcX;IAED;;;OAGG;IACH,YAFa,CAAC,CAIb;IAED;;;OAGG;IACH,gBAcC;;CACJ;;cAKS,QAAQ,gBAAW;;mBAlGV,uCAAuC"}

package/src/engine/reference/v2/Reference.js

@@ -1,6 +1,13 @@
 import Signal from "../../../core/events/signal/Signal.js";
 
 /**
+ * Value container, allows reference counting through {@link #onReleased} signal
+ * Intended for usage with reference-managing systems
+ * @example
+ *      const ref: Reference<Texture> = texture_system.get(some_id);
+ *      // do work with texture
+ *      ref.release(); // we're done with the resource, texture_system will be notified
+ *      // now ref.getValue() === null, reference is no longer valid
  * @template T
  */
 export class Reference {
@@ -21,7 +28,7 @@ export class Reference {
 
 
     /**
-     *
+     * Whether a value is bound or not. Will be true if value is != null
      * @type {boolean}
      * @private
      */