@theatrejs/plugin-ldtk 1.3.1 → 2.0.1

package/README.md

@@ -15,19 +15,12 @@ npm install @theatrejs/plugin-ldtk --save
 ```javascript
 import * as PLUGIN_LDTK from '@theatrejs/plugin-ldtk';
 
-import ldtkData from './ldtk.json';
+import ldtk from './ldtk.json';
 
-const ldtk = new PLUGIN_LDTK.Ldtk(ldtkData);
-
-const entities = ldtk.getEntities({
+const grid = ldtk.createGrid({
     $level: 'Prototype',
     $layer: 'actors'
 });
-
-const grid = ldtk.getGrid({
-    $level: 'Prototype',
-    $layer: 'grid'
-});
 ```
 
 ## [API](https://theatrejs.github.io/plugin-ldtk/index.html)

package/package.json

@@ -39,7 +39,7 @@
     "name": "@theatrejs/plugin-ldtk",
     "peerDependencies": {
 
-        "@theatrejs/theatrejs": ">= 1.20.0"
+        "@theatrejs/theatrejs": ">= 1.25.2"
     },
     "repository": {
 
@@ -54,5 +54,5 @@
         "postversion": "node ./tools/custom/postversion.cjs"
     },
     "type": "module",
-    "version": "1.3.1"
+    "version": "2.0.1"
 }

package/sources/index.js

@@ -1 +1,2 @@
 export {Ldtk} from './ldtk.js';
+export {LdtkEntity} from './ldtk-entity.js';

package/sources/ldtk-entity.js

@@ -0,0 +1,91 @@
+/**
+ * Creates LDTK entities.
+ *
+ * @example
+ *
+ * const entity = new LdtkEntity({$data, $identifier, $label});
+ */
+class LdtkEntity {
+
+    /**
+     * @typedef {Object} TypeLdtkEntityField A LDTK JSON data custom field.
+     * @property {string} TypeLdtkEntityField.__identifier The identifier.
+     * @property {string} TypeLdtkEntityField.__type The type.
+     * @property {any} TypeLdtkEntityField.__value The value.
+     * @protected
+     *
+     * @memberof LdtkEntity
+     */
+
+    /**
+     * Stores the LDTK JSON data custom fields.
+     * @type {Array<TypeLdtkEntityField>}
+     * @private
+     */
+    $data;
+
+    /**
+     * Stores the identifier.
+     * @type {string}
+     * @private
+     */
+    $identifier;
+
+    /**
+     * Stores the label.
+     * @type {string}
+     * @private
+     */
+    $label;
+
+    /**
+     * Gets the LDTK JSON data custom fields.
+     * @type {Array<TypeLdtkEntityField>}
+     * @public
+     */
+    get data() {
+
+        return this.$data;
+    }
+
+    /**
+     * Gets the identifier.
+     * @type {string}
+     * @public
+     */
+    get identifier() {
+
+        return this.$identifier;
+    }
+
+    /**
+     * Gets the label.
+     * @type {string}
+     * @public
+     */
+    get label() {
+
+        return this.$label;
+    }
+
+    /**
+     * Creates a new LDTK entity.
+     * @param {Object} $parameters The given parameters.
+     * @param {Array<TypeLdtkEntityField>} $parameters.$data The LDTK JSON data custom fields.
+     * @param {string} $parameters.$identifier The identifier of the entity to get.
+     * @param {string} $parameters.$label The label of the entity to get.
+     */
+    constructor({$data, $identifier, $label}) {
+
+        this.$data = $data;
+        this.$identifier = $identifier;
+        this.$label = $label;
+    }
+}
+
+export {
+
+    LdtkEntity
+};
+
+export default LdtkEntity;

package/sources/ldtk.js

@@ -1,4 +1,6 @@
-import {Vector2} from '@theatrejs/theatrejs';
+import {Grid, Vector2} from '@theatrejs/theatrejs';
+
+import {LdtkEntity} from './index.js';
 
 /**
  * Creates LDTK module managers.
@@ -6,28 +8,13 @@ import {Vector2} from '@theatrejs/theatrejs';
  * @example
  *
  * const ldtk = new Ldtk(data);
- * ldtk.getEntities({$level, $layer});
+ * ldtk.createGrid({$level, $layer});
  */
 class Ldtk {
 
     /**
-     * @typedef {Object} TypeEntity A transformed LDTK JSON entity.
-     * @property {string} TypeEntity.$identifier The identifier.
-     * @property {Vector2} TypeEntity.$position The position.
-     * @property {string} TypeEntity.$type The type.
-     * @protected
-     *
-     * @memberof Ldtk
-     */
-
-    /**
-     * @typedef {Object} TypeGrid A transformed LDTK JSON grid.
-     * @property {Vector2} TypeGrid.$cell The size of each cell.
-     * @property {Array<number>} TypeGrid.$data The flat data (one-dimensional).
-     * @property {Map<number, string>} TypeGrid.$definitions The data definitions.
-     * @property {number} TypeGrid.$height The number of cells on the y-axis.
-     * @property {Vector2} TypeGrid.$position The position.
-     * @property {number} TypeGrid.$width The number of cells on the x-axis.
+     * @typedef {Object} TypeLdtkDefinitionEntity A LDTK JSON data entity definition.
+     * @property {string} TypeLdtkDefinitionEntity.identifier The identifier.
      * @protected
      *
      * @memberof Ldtk
@@ -53,7 +40,8 @@ class Ldtk {
 
     /**
      * @typedef {Object} TypeLdtkDefinitions A LDTK JSON data definition.
-     * @property {Array<TypeLdtkDefinitionLayer>} TypeLdtkDefinitionLayer.layers The layers' definitions.
+     * @property {Array<TypeLdtkDefinitionEntity>} TypeLdtkDefinitions.entities The entities' definitions.
+     * @property {Array<TypeLdtkDefinitionLayer>} TypeLdtkDefinitions.layers The layers' definitions.
      * @protected
      *
      * @memberof Ldtk
@@ -141,61 +129,26 @@ class Ldtk {
     }
 
     /**
-     * Gets the entities from the given level on the given layer.
+     * Creates a grid of LDTK entities from the given level on the given layer.
      * @param {Object} $parameters The given parameters.
      * @param {string} $parameters.$layer The layer of the entities to get.
      * @param {string} $parameters.$level The level of the entities to get.
-     * @returns {Array<TypeEntity>}
+     * @returns {Grid<LdtkEntity>}
      * @public
      */
-    getEntities({$layer, $level}) {
+    createGrid({$layer, $level}) {
 
-        const level = this.$data.levels
-        .find(($current) => ($current.identifier === $level));
-
-        if (typeof level === 'undefined') {
-
-            return [];
-        }
-
-        const layer = level
-        .layerInstances.find(($current) => ($current.__identifier === $layer));
-
-        if (typeof layer === 'undefined') {
-
-            return [];
-        }
-
-        return layer
-        .entityInstances
-        .map(($entity) => ({
-
-            $identifier: $entity.iid,
-            $type: $entity.__identifier,
-            $position: new Vector2(
-
-                $entity.px[0] - (level.pxWid / 2),
-                - ($entity.px[1] - (level.pxHei / 2))
-            )
-        }));
-    }
-
-    /**
-     * Gets the LDTK JSON data entities from the given level on the given layer.
-     * @param {Object} $parameters The given parameters.
-     * @param {string} $parameters.$layer The layer of the entities to get.
-     * @param {string} $parameters.$level The level of the entities to get.
-     * @returns {Array<TypeLdtkEntity>}
-     * @public
-     */
-    getEntitiesData({$layer, $level}) {
+        /**
+         * @type {Grid<LdtkEntity>}
+         */
+        const grid = new Grid();
 
         const level = this.$data.levels
         .find(($current) => ($current.identifier === $level));
 
         if (typeof level === 'undefined') {
 
-            return [];
+            return grid;
         }
 
         const layer = level
@@ -203,86 +156,24 @@ class Ldtk {
 
         if (typeof layer === 'undefined') {
 
-            return [];
+            return grid;
         }
 
-        return layer
-        .entityInstances
-        .map(($entity) => (window.structuredClone($entity)));
-    }
+        layer.entityInstances.forEach(($entity) => {
 
-    /**
-     * Gets the grid from the given level on the given layer.
-     * @param {Object} $parameters The given parameters.
-     * @param {string} $parameters.$layer The layer of the grid to get.
-     * @param {string} $parameters.$level The level of the grid to get.
-     * @returns {(TypeGrid | undefined)}
-     * @public
-     */
-    getGrid({$layer, $level}) {
+            const [x, y] = $entity.__grid;
 
-        const level = this.$data.levels
-        .find(($current) => ($current.identifier === $level));
-
-        if (typeof level === 'undefined') {
-
-            return;
-        }
-
-        const layer = level
-        .layerInstances.find(($current) => ($current.__identifier === $layer));
-
-        if (typeof layer === 'undefined') {
-
-            return;
-        }
-
-        const definition = this.$data.defs.layers
-        .find(($current) => ($current.identifier === $layer));
-
-        if (typeof definition === 'undefined') {
-
-            return;
-        }
-
-        return {
-
-            $data: [...layer.intGridCsv],
-            $definitions: new Map(definition.intGridValues.map(($definition) => ([$definition.value, $definition.identifier]))),
-            $cell: new Vector2(layer.__gridSize, layer.__gridSize),
-            $width: layer.__cWid,
-            $height: layer.__cHei,
-            $position: new Vector2(level.pxWid / 2, level.pxHei / 2)
-        };
-    }
-
-    /**
-     * Gets the LDTK JSON data layer grid from the given level on the given layer.
-     * @param {Object} $parameters The given parameters.
-     * @param {string} $parameters.$layer The layer of the grid to get.
-     * @param {string} $parameters.$level The level of the grid to get.
-     * @returns {TypeLdtkLayer}
-     * @public
-     */
-    getGridData({$layer, $level}) {
-
-        const level = this.$data.levels
-        .find(($current) => ($current.identifier === $level));
+            const entity = new LdtkEntity({
 
-        if (typeof level === 'undefined') {
-
-            return;
-        }
+                $data: window.structuredClone($entity.fieldInstances),
+                $identifier: $entity.iid,
+                $label: $entity.__identifier
+            });
 
-        const layer = level
-        .layerInstances.find(($current) => ($current.__identifier === $layer));
-
-        if (typeof layer === 'undefined') {
-
-            return;
-        }
+            grid.set(new Vector2(x, y), entity);
+        });
 
-        return window.structuredClone(layer);
+        return grid;
     }
 }