Skip to content

Commit

Permalink
Fixed doc
Browse files Browse the repository at this point in the history
  • Loading branch information
deepnight committed Jan 16, 2024
1 parent 19a348e commit e307356
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/JSON_DOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Value | Type | Description
-- | -- | --
`__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`)
`__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>
`__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>
`__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.5.3-green.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>
`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.
`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.
`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.
Expand Down

0 comments on commit e307356

Please sign in to comment.