Skip to content

Commit c10f264

Browse files
deepnightdeepnight
committed
Docs
1 parent 0ce2135 commit c10f264

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

‎docs/JSON_DOC.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# LDtk Json structure (version 1.5.2)
1+
# LDtk Json structure (version 1.5.3)
22

33

44
<a id="ldtk-ProjectJson" name="ldtk-ProjectJson"></a>
@@ -79,7 +79,7 @@ Value | Type | Description
7979
-- | -- | --
8080
`__bgColor`<br/> ![Generic badge](https://img.shields.io/badge/Added_0.6.0-gray.svg) | String<br/><small class="color"> *Hex color "#rrggbb"* </small> | Background color of the level (same as `bgColor`, except the default value is automatically used here if its value is `null`)
8181
`__bgPos`<br/><sup class="only">Only *If background image exists*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_0.7.0-gray.svg) | Object&nbsp;*(can&nbsp;be&nbsp;`null`)* | Position informations of the background image, if there is one.<br/> This object contains the following fields:<br/> <ul class='subFields'><li>**`cropRect`** **(Array of Float**) : *An array of 4 float values describing the cropped sub-rectangle of the displayed background image. This cropping happens when original is larger than the level bounds. Array format: `[ cropX, cropY, cropWidth, cropHeight ]`*</li><li>**`scale`** **(Array of Float**) : *An array containing the `[scaleX,scaleY]` values of the **cropped** background image, depending on `bgPos` option.*</li><li>**`topLeftPx`** **(Array of Int**) : *An array containing the `[x,y]` pixel coordinates of the top-left corner of the **cropped** background image, depending on `bgPos` option.*</li></ul>
82-
`__neighbours`<br/> ![Generic badge](https://img.shields.io/badge/Added_0.6.0-gray.svg) ![Generic badge](https://img.shields.io/badge/Changed_1.4.0-gray.svg) | Array&nbsp;of&nbsp;Object | An array listing all other levels touching this one on the world map. Since 1.4.0, this includes levels that overlap in the same world layer, or in nearby world layers.<br/> Only relevant for world layouts where level spatial positioning is manual (ie. GridVania, Free). For Horizontal and Vertical layouts, this array is always empty.<br/> This array contains objects with the following fields:<br/> <ul class='subFields'><li>**`dir`** **(String**) ![Generic badge](https://img.shields.io/badge/Changed_1.4.0-gray.svg) : *A single lowercase character tipping on the level location (`n`orth, `s`outh, `w`est, `e`ast).<br/> Since 1.4.0, this character value can also be `<` (neighbour depth is lower), `>` (neighbour depth is greater) or `o` (levels overlap and share the same world depth).*</li><li>**`levelIid`** **(String**) ![Generic badge](https://img.shields.io/badge/Added_1.0.0-gray.svg) : *Neighbour Instance Identifier*</li><li>**`levelUid`** **(Int *(can be `null`)***) ![Generic badge](https://img.shields.io/badge/Removed_1.2.0-gray.svg) : ***WARNING**: this deprecated value is no longer exported since version 1.2.0* ** *Replaced by: `levelIid`*</li></ul>
82+
`__neighbours`<br/> ![Generic badge](https://img.shields.io/badge/Added_0.6.0-gray.svg) ![Generic badge](https://img.shields.io/badge/Changed_1.4.0-gray.svg) | Array&nbsp;of&nbsp;Object | An array listing all other levels touching this one on the world map. Since 1.4.0, this includes levels that overlap in the same world layer, or in nearby world layers.<br/> Only relevant for world layouts where level spatial positioning is manual (ie. GridVania, Free). For Horizontal and Vertical layouts, this array is always empty.<br/> This array contains objects with the following fields:<br/> <ul class='subFields'><li>**`dir`** **(String**) ![Generic badge](https://img.shields.io/badge/Changed_1.4.0-gray.svg) : *A lowercase string tipping on the level location (`n`orth, `s`outh, `w`est, `e`ast).<br/> Since 1.4.0, this value can also be `<` (neighbour depth is lower), `>` (neighbour depth is greater) or `o` (levels overlap and share the same world depth).<br/> Since 1.5.3, this value can also be `nw`,`ne`,`sw` or `se` for levels only touching corners.*</li><li>**`levelIid`** **(String**) ![Generic badge](https://img.shields.io/badge/Added_1.0.0-gray.svg) : *Neighbour Instance Identifier*</li><li>**`levelUid`** **(Int *(can be `null`)***) ![Generic badge](https://img.shields.io/badge/Removed_1.2.0-gray.svg) : ***WARNING**: this deprecated value is no longer exported since version 1.2.0* ** *Replaced by: `levelIid`*</li></ul>
8383
`bgRelPath`<br/> ![Generic badge](https://img.shields.io/badge/Added_0.7.0-gray.svg) | String&nbsp;*(can&nbsp;be&nbsp;`null`)* | The *optional* relative path to the level background image.
8484
`externalRelPath`<br/> ![Generic badge](https://img.shields.io/badge/Added_0.7.0-gray.svg) | String&nbsp;*(can&nbsp;be&nbsp;`null`)* | This value is not null if the project option "*Save levels separately*" is enabled. In this case, this **relative** path points to the level Json file.
8585
`fieldInstances`<br/> ![Generic badge](https://img.shields.io/badge/Changed_0.8.0-gray.svg) | Array&nbsp;of&nbsp;[Field&nbsp;instance](#ldtk-FieldInstanceJson) | An array containing this level custom field values.

‎docs/JSON_SCHEMA.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"description": "This file is a JSON schema of files created by LDtk level editor (https://ldtk.io).",
3-
"title": "LDtk 1.5.2 JSON schema",
3+
"title": "LDtk 1.5.3 JSON schema",
44
"$schema": "https://json-schema.org/draft-07/schema#",
55
"$ref": "#/LdtkJsonRoot",
6-
"version": "1.5.2",
6+
"version": "1.5.3",
77
"LdtkJsonRoot": {
88
"description": "This is the root of any Project JSON file. It contains: - the project settings, - an array of levels, - a group of definitions (that can probably be safely ignored for most users).",
99
"title": "LDtk Json root",
@@ -1836,7 +1836,7 @@
18361836
]
18371837
},
18381838
"dir": {
1839-
"description": "A single lowercase character tipping on the level location (`n`orth, `s`outh, `w`est, `e`ast).<br/> Since 1.4.0, this character value can also be `<` (neighbour depth is lower), `>` (neighbour depth is greater) or `o` (levels overlap and share the same world depth).",
1839+
"description": "A lowercase string tipping on the level location (`n`orth, `s`outh, `w`est, `e`ast).<br/> Since 1.4.0, this value can also be `<` (neighbour depth is lower), `>` (neighbour depth is greater) or `o` (levels overlap and share the same world depth).<br/> Since 1.5.3, this value can also be `nw`,`ne`,`sw` or `se` for levels only touching corners.",
18401840
"type": [
18411841
"string"
18421842
]

‎docs/MINIMAL_JSON_SCHEMA.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"description": "This file is a JSON schema of files created by LDtk level editor (https://ldtk.io).",
3-
"title": "LDtk 1.5.2 JSON schema",
3+
"title": "LDtk 1.5.3 JSON schema",
44
"$schema": "https://json-schema.org/draft-07/schema#",
55
"$ref": "#/LdtkJsonRoot",
6-
"version": "1.5.2",
6+
"version": "1.5.3",
77
"LdtkJsonRoot": {
88
"description": "This is the root of any Project JSON file. It contains: - the project settings, - an array of levels, - a group of definitions (that can probably be safely ignored for most users).",
99
"title": "LDtk Json root",
@@ -917,7 +917,7 @@
917917
]
918918
},
919919
"dir": {
920-
"description": "A single lowercase character tipping on the level location (`n`orth, `s`outh, `w`est, `e`ast).<br/> Since 1.4.0, this character value can also be `<` (neighbour depth is lower), `>` (neighbour depth is greater) or `o` (levels overlap and share the same world depth).",
920+
"description": "A lowercase string tipping on the level location (`n`orth, `s`outh, `w`est, `e`ast).<br/> Since 1.4.0, this value can also be `<` (neighbour depth is lower), `>` (neighbour depth is greater) or `o` (levels overlap and share the same world depth).<br/> Since 1.5.3, this value can also be `nw`,`ne`,`sw` or `se` for levels only touching corners.",
921921
"type": [
922922
"string"
923923
]

‎docs/version.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.5.2
1+
1.5.3

0 commit comments

Comments
 (0)