@theatrejs/plugin-ldtk 1.0.1 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +2 -2
  2. package/package.json +2 -2
  3. package/sources/ldtk.js +50 -50
package/README.md CHANGED
@@ -13,11 +13,11 @@ npm install @theatrejs/plugin-ldtk --save
13
13
  ## Quick Start
14
14
 
15
15
  ```javascript
16
- import * as PLUGINLDTK from '@theatrejs/plugin-ldtk';
16
+ import * as PLUGIN_LDTK from '@theatrejs/plugin-ldtk';
17
17
 
18
18
  import ldtkData from './ldtk.json';
19
19
 
20
- const ldtk = new PLUGINLDTK.Ldtk(ldtkData);
20
+ const ldtk = new PLUGIN_LDTK.Ldtk(ldtkData);
21
21
 
22
22
  const entities = ldtk.getEntities({
23
23
  $level: 'Prototype',
package/package.json CHANGED
@@ -39,7 +39,7 @@
39
39
  "name": "@theatrejs/plugin-ldtk",
40
40
  "peerDependencies": {
41
41
 
42
- "@theatrejs/theatrejs": ">= 1.12.0"
42
+ "@theatrejs/theatrejs": ">= 1.14.0"
43
43
  },
44
44
  "repository": {
45
45
 
@@ -54,5 +54,5 @@
54
54
  "postversion": "node ./tools/custom/postversion.cjs"
55
55
  },
56
56
  "type": "module",
57
- "version": "1.0.1"
57
+ "version": "1.1.0"
58
58
  }
package/sources/ldtk.js CHANGED
@@ -11,103 +11,103 @@ import {Vector2} from '@theatrejs/theatrejs';
11
11
  class Ldtk {
12
12
 
13
13
  /**
14
- * @typedef {Object} typeentity A transformed LDTK JSON entity.
15
- * @property {string} typeentity.$identifier The identifier.
16
- * @property {Vector2} typeentity.$position The position.
17
- * @property {string} typeentity.$type The type.
14
+ * @typedef {Object} TypeEntity A transformed LDTK JSON entity.
15
+ * @property {string} TypeEntity.$identifier The identifier.
16
+ * @property {Vector2} TypeEntity.$position The position.
17
+ * @property {string} TypeEntity.$type The type.
18
18
  * @protected
19
19
  *
20
20
  * @memberof Ldtk
21
21
  */
22
22
 
23
23
  /**
24
- * @typedef {Object} typegrid A transformed LDTK JSON grid.
25
- * @property {Vector2} typegrid.$cell The size of each cell.
26
- * @property {Array<number>} typegrid.$data The flat data (one-dimensional).
27
- * @property {Map<number, string>} typegrid.$definitions The data definitions.
28
- * @property {number} typegrid.$height The number of cells on the y-axis.
29
- * @property {Vector2} typegrid.$position The position.
30
- * @property {number} typegrid.$width The number of cells on the x-axis.
24
+ * @typedef {Object} TypeGrid A transformed LDTK JSON grid.
25
+ * @property {Vector2} TypeGrid.$cell The size of each cell.
26
+ * @property {Array<number>} TypeGrid.$data The flat data (one-dimensional).
27
+ * @property {Map<number, string>} TypeGrid.$definitions The data definitions.
28
+ * @property {number} TypeGrid.$height The number of cells on the y-axis.
29
+ * @property {Vector2} TypeGrid.$position The position.
30
+ * @property {number} TypeGrid.$width The number of cells on the x-axis.
31
31
  * @protected
32
32
  *
33
33
  * @memberof Ldtk
34
34
  */
35
35
 
36
36
  /**
37
- * @typedef {Object} typeldtkdefinitionlayergridvalue A LDTK JSON data layer grid value definition.
38
- * @property {string} typeldtkdefinitionlayergridvalue.identifier The identifier.
39
- * @property {number} typeldtkdefinitionlayergridvalue.value The value.
37
+ * @typedef {Object} TypeLdtkDefinitionLayerGridValue A LDTK JSON data layer grid value definition.
38
+ * @property {string} TypeLdtkDefinitionLayerGridValue.identifier The identifier.
39
+ * @property {number} TypeLdtkDefinitionLayerGridValue.value The value.
40
40
  * @protected
41
41
  *
42
42
  * @memberof Ldtk
43
43
  */
44
44
 
45
45
  /**
46
- * @typedef {Object} typeldtkdefinitionlayer A LDTK JSON data layer definition.
47
- * @property {string} typeldtkdefinitionlayer.identifier The identifier.
48
- * @property {Array<typeldtkdefinitionlayergridvalue>} typeldtkdefinitionlayer.intGridValues The grid values.
46
+ * @typedef {Object} TypeLdtkDefinitionLayer A LDTK JSON data layer definition.
47
+ * @property {string} TypeLdtkDefinitionLayer.identifier The identifier.
48
+ * @property {Array<TypeLdtkDefinitionLayerGridValue>} TypeLdtkDefinitionLayer.intGridValues The grid values.
49
49
  * @protected
50
50
  *
51
51
  * @memberof Ldtk
52
52
  */
53
53
 
54
54
  /**
55
- * @typedef {Object} typeldtkdefinitions A LDTK JSON data definition.
56
- * @property {Array<typeldtkdefinitionlayer>} typeldtkdefinitionlayer.layers The layers' definitions.
55
+ * @typedef {Object} TypeLdtkDefinitions A LDTK JSON data definition.
56
+ * @property {Array<TypeLdtkDefinitionLayer>} TypeLdtkDefinitionLayer.layers The layers' definitions.
57
57
  * @protected
58
58
  *
59
59
  * @memberof Ldtk
60
60
  */
61
61
 
62
62
  /**
63
- * @typedef {Object} typeldtkentityfield A LDTK JSON data custom field.
64
- * @property {string} typeldtkentityfield.__identifier The identifier.
65
- * @property {string} typeldtkentityfield.__type The type.
66
- * @property {any} typeldtkentityfield.__value The value.
63
+ * @typedef {Object} TypeLdtkEntityField A LDTK JSON data custom field.
64
+ * @property {string} TypeLdtkEntityField.__identifier The identifier.
65
+ * @property {string} TypeLdtkEntityField.__type The type.
66
+ * @property {any} TypeLdtkEntityField.__value The value.
67
67
  * @protected
68
68
  *
69
69
  * @memberof Ldtk
70
70
  */
71
71
 
72
72
  /**
73
- * @typedef {Object} typeldtkentity A LDTK JSON data entity.
74
- * @property {string} typeldtkentity.__identifier The identifier.
75
- * @property {Array<typeldtkentityfield>} typeldtkentity.fieldInstances The custom fields.
76
- * @property {string} typeldtkentity.iid The iid.
77
- * @property {Array<number>} typeldtkentity.px The position.
73
+ * @typedef {Object} TypeLdtkEntity A LDTK JSON data entity.
74
+ * @property {string} TypeLdtkEntity.__identifier The identifier.
75
+ * @property {Array<TypeLdtkEntityField>} TypeLdtkEntity.fieldInstances The custom fields.
76
+ * @property {string} TypeLdtkEntity.iid The iid.
77
+ * @property {Array<number>} TypeLdtkEntity.px The position.
78
78
  * @protected
79
79
  *
80
80
  * @memberof Ldtk
81
81
  */
82
82
 
83
83
  /**
84
- * @typedef {Object} typeldtklayer A LDTK JSON data layer.
85
- * @property {number} typeldtklayer.__cHei The number of grid cells on the x-axis.
86
- * @property {number} typeldtklayer.__cWid The number of grid cells on the y-axis.
87
- * @property {number} typeldtklayer.__gridSize The size of each cell.
88
- * @property {string} typeldtklayer.__identifier The identifier.
89
- * @property {Array<typeldtkentity>} typeldtklayer.entityInstances The entities.
90
- * @property {Array<number>} typeldtklayer.intGridCsv The grid values.
84
+ * @typedef {Object} TypeLdtkLayer A LDTK JSON data layer.
85
+ * @property {number} TypeLdtkLayer.__cHei The number of grid cells on the x-axis.
86
+ * @property {number} TypeLdtkLayer.__cWid The number of grid cells on the y-axis.
87
+ * @property {number} TypeLdtkLayer.__gridSize The size of each cell.
88
+ * @property {string} TypeLdtkLayer.__identifier The identifier.
89
+ * @property {Array<TypeLdtkEntity>} TypeLdtkLayer.entityInstances The entities.
90
+ * @property {Array<number>} TypeLdtkLayer.intGridCsv The grid values.
91
91
  * @protected
92
92
  *
93
93
  * @memberof Ldtk
94
94
  */
95
95
 
96
96
  /**
97
- * @typedef {Object} typeldtklevel A LDTK JSON data level.
98
- * @property {string} typeldtklevel.identifier The identifier.
99
- * @property {Array<typeldtklayer>} typeldtklevel.layerInstances The layers.
100
- * @property {number} typeldtklevel.pxHei The height.
101
- * @property {number} typeldtklevel.pxWid The width.
97
+ * @typedef {Object} TypeLdtkLevel A LDTK JSON data level.
98
+ * @property {string} TypeLdtkLevel.identifier The identifier.
99
+ * @property {Array<TypeLdtkLayer>} TypeLdtkLevel.layerInstances The layers.
100
+ * @property {number} TypeLdtkLevel.pxHei The height.
101
+ * @property {number} TypeLdtkLevel.pxWid The width.
102
102
  * @protected
103
103
  *
104
104
  * @memberof Ldtk
105
105
  */
106
106
 
107
107
  /**
108
- * @typedef {Object} typeldtk A LDTK JSON data.
109
- * @property {typeldtkdefinitions} typeldtk.defs The definitions.
110
- * @property {Array<typeldtklevel>} typeldtk.levels The delevs.
108
+ * @typedef {Object} TypeLdtk A LDTK JSON data.
109
+ * @property {TypeLdtkDefinitions} TypeLdtk.defs The definitions.
110
+ * @property {Array<TypeLdtkLevel>} TypeLdtk.levels The delevs.
111
111
  * @protected
112
112
  *
113
113
  * @memberof Ldtk
@@ -115,14 +115,14 @@ class Ldtk {
115
115
 
116
116
  /**
117
117
  * Stores the LDTK JSON data.
118
- * @type {typeldtk}
118
+ * @type {TypeLdtk}
119
119
  * @private
120
120
  */
121
121
  $data;
122
122
 
123
123
  /**
124
124
  * Gets the LDTK JSON data.
125
- * @type {typeldtk}
125
+ * @type {TypeLdtk}
126
126
  * @public
127
127
  */
128
128
  get data() {
@@ -132,7 +132,7 @@ class Ldtk {
132
132
 
133
133
  /**
134
134
  * Creates a new LDTK module manager.
135
- * @param {typeldtk} $data The LDTK JSON data.
135
+ * @param {TypeLdtk} $data The LDTK JSON data.
136
136
  */
137
137
  constructor($data) {
138
138
 
@@ -144,7 +144,7 @@ class Ldtk {
144
144
  * @param {Object} $parameters The given parameters.
145
145
  * @param {string} $parameters.$layer The layer of the entities to get.
146
146
  * @param {string} $parameters.$level The level of the entities to get.
147
- * @returns {Array<typeentity>}
147
+ * @returns {Array<TypeEntity>}
148
148
  * @public
149
149
  */
150
150
  getEntities({$layer, $level}) {
@@ -184,7 +184,7 @@ class Ldtk {
184
184
  * @param {Object} $parameters The given parameters.
185
185
  * @param {string} $parameters.$layer The layer of the entities to get.
186
186
  * @param {string} $parameters.$level The level of the entities to get.
187
- * @returns {Array<typeldtkentity>}
187
+ * @returns {Array<TypeLdtkEntity>}
188
188
  * @public
189
189
  */
190
190
  getEntitiesData({$layer, $level}) {
@@ -215,7 +215,7 @@ class Ldtk {
215
215
  * @param {Object} $parameters The given parameters.
216
216
  * @param {string} $parameters.$layer The layer of the grid to get.
217
217
  * @param {string} $parameters.$level The level of the grid to get.
218
- * @returns {(typegrid | undefined)}
218
+ * @returns {(TypeGrid | undefined)}
219
219
  * @public
220
220
  */
221
221
  getGrid({$layer, $level}) {
@@ -260,7 +260,7 @@ class Ldtk {
260
260
  * @param {Object} $parameters The given parameters.
261
261
  * @param {string} $parameters.$layer The layer of the grid to get.
262
262
  * @param {string} $parameters.$level The level of the grid to get.
263
- * @returns {typeldtklayer}
263
+ * @returns {TypeLdtkLayer}
264
264
  * @public
265
265
  */
266
266
  getGridData({$layer, $level}) {