Skip to content

Commit e376c15

Browse files
committed
update documentation
1 parent 8d58849 commit e376c15

3 files changed

Lines changed: 36 additions & 11 deletions

File tree

docs/Ldtk.html

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ <h4 class="name" id="data"><span class="type-signature"></span>data<span class="
242242

243243
<dt class="tag-source">Source:</dt>
244244
<dd class="tag-source"><ul class="dummy"><li>
245-
<a href="ldtk.js.html">ldtk.js</a>, <a href="ldtk.js.html#line128">line 128</a>
245+
<a href="ldtk.js.html">ldtk.js</a>, <a href="ldtk.js.html#line129">line 129</a>
246246
</li></ul></dd>
247247

248248

@@ -330,7 +330,7 @@ <h4 class="name" id="getEntities"><span class="type-signature"></span>getEntitie
330330

331331
<dt class="tag-source">Source:</dt>
332332
<dd class="tag-source"><ul class="dummy"><li>
333-
<a href="ldtk.js.html">ldtk.js</a>, <a href="ldtk.js.html#line150">line 150</a>
333+
<a href="ldtk.js.html">ldtk.js</a>, <a href="ldtk.js.html#line151">line 151</a>
334334
</li></ul></dd>
335335

336336

@@ -532,7 +532,7 @@ <h4 class="name" id="getEntitiesData"><span class="type-signature"></span>getEnt
532532

533533
<dt class="tag-source">Source:</dt>
534534
<dd class="tag-source"><ul class="dummy"><li>
535-
<a href="ldtk.js.html">ldtk.js</a>, <a href="ldtk.js.html#line190">line 190</a>
535+
<a href="ldtk.js.html">ldtk.js</a>, <a href="ldtk.js.html#line191">line 191</a>
536536
</li></ul></dd>
537537

538538

@@ -734,7 +734,7 @@ <h4 class="name" id="getGrid"><span class="type-signature"></span>getGrid<span c
734734

735735
<dt class="tag-source">Source:</dt>
736736
<dd class="tag-source"><ul class="dummy"><li>
737-
<a href="ldtk.js.html">ldtk.js</a>, <a href="ldtk.js.html#line221">line 221</a>
737+
<a href="ldtk.js.html">ldtk.js</a>, <a href="ldtk.js.html#line222">line 222</a>
738738
</li></ul></dd>
739739

740740

@@ -939,7 +939,7 @@ <h4 class="name" id="getGridData"><span class="type-signature"></span>getGridDat
939939

940940
<dt class="tag-source">Source:</dt>
941941
<dd class="tag-source"><ul class="dummy"><li>
942-
<a href="ldtk.js.html">ldtk.js</a>, <a href="ldtk.js.html#line266">line 266</a>
942+
<a href="ldtk.js.html">ldtk.js</a>, <a href="ldtk.js.html#line267">line 267</a>
943943
</li></ul></dd>
944944

945945

@@ -1573,7 +1573,7 @@ <h4 class="name" id=".TypeLdtk">TypeLdtk</h4>
15731573

15741574
<dt class="tag-source">Source:</dt>
15751575
<dd class="tag-source"><ul class="dummy"><li>
1576-
<a href="ldtk.js.html">ldtk.js</a>, <a href="ldtk.js.html#line107">line 107</a>
1576+
<a href="ldtk.js.html">ldtk.js</a>, <a href="ldtk.js.html#line108">line 108</a>
15771577
</li></ul></dd>
15781578

15791579

@@ -2254,6 +2254,30 @@ <h5 class="subsection-title">Properties:</h5>
22542254

22552255

22562256

2257+
<tr>
2258+
2259+
<td class="name"><code>TypeLdtkEntity.__grid</code></td>
2260+
2261+
2262+
<td class="type">
2263+
2264+
2265+
<span class="param-type">Array.&lt;number></span>
2266+
2267+
2268+
2269+
2270+
</td>
2271+
2272+
2273+
2274+
2275+
2276+
<td class="description last">The grid-based coordinates.</td>
2277+
</tr>
2278+
2279+
2280+
22572281
<tr>
22582282

22592283
<td class="name"><code>TypeLdtkEntity.fieldInstances</code></td>
@@ -2551,7 +2575,7 @@ <h4 class="name" id=".TypeLdtkLayer">TypeLdtkLayer</h4>
25512575

25522576
<dt class="tag-source">Source:</dt>
25532577
<dd class="tag-source"><ul class="dummy"><li>
2554-
<a href="ldtk.js.html">ldtk.js</a>, <a href="ldtk.js.html#line83">line 83</a>
2578+
<a href="ldtk.js.html">ldtk.js</a>, <a href="ldtk.js.html#line84">line 84</a>
25552579
</li></ul></dd>
25562580

25572581

@@ -2802,7 +2826,7 @@ <h4 class="name" id=".TypeLdtkLevel">TypeLdtkLevel</h4>
28022826

28032827
<dt class="tag-source">Source:</dt>
28042828
<dd class="tag-source"><ul class="dummy"><li>
2805-
<a href="ldtk.js.html">ldtk.js</a>, <a href="ldtk.js.html#line96">line 96</a>
2829+
<a href="ldtk.js.html">ldtk.js</a>, <a href="ldtk.js.html#line97">line 97</a>
28062830
</li></ul></dd>
28072831

28082832

@@ -3006,7 +3030,7 @@ <h5 class="h5-types">Type:</h5>
30063030
<br class="clear">
30073031

30083032
<footer>
3009-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Sun Feb 09 2025 00:10:09 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
3033+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Fri Apr 11 2025 07:07:42 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
30103034
</footer>
30113035

30123036
<script>prettyPrint();</script>

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ <h2>Quick Start</h2>
101101
<br class="clear">
102102

103103
<footer>
104-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Sun Feb 09 2025 00:10:09 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
104+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Fri Apr 11 2025 07:07:42 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
105105
</footer>
106106

107107
<script>prettyPrint();</script>

docs/ldtk.js.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ <h1 class="page-title">ldtk.js</h1>
121121
/**
122122
* @typedef {Object} TypeLdtkEntity A LDTK JSON data entity.
123123
* @property {string} TypeLdtkEntity.__identifier The identifier.
124+
* @property {Array&lt;number>} TypeLdtkEntity.__grid The grid-based coordinates.
124125
* @property {Array&lt;TypeLdtkEntityField>} TypeLdtkEntity.fieldInstances The custom fields.
125126
* @property {string} TypeLdtkEntity.iid The iid.
126127
* @property {Array&lt;number>} TypeLdtkEntity.px The position.
@@ -354,7 +355,7 @@ <h1 class="page-title">ldtk.js</h1>
354355
<br class="clear">
355356

356357
<footer>
357-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Sun Feb 09 2025 00:10:09 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
358+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Fri Apr 11 2025 07:07:42 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
358359
</footer>
359360

360361
<script>prettyPrint();</script>

0 commit comments

Comments
 (0)