Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
deepnight committed Oct 13, 2023
1 parent 3748df0 commit a6560d3
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/JSON_DOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Value | Type | Description
`iid`<br/> ![Generic badge](https://img.shields.io/badge/Added_1.2.0-gray.svg) | String | Unique project identifier
`jsonVersion` | String | File format version
`levels` | Array&nbsp;of&nbsp;[Level](#ldtk-LevelJson) | All levels. The order of this array is only relevant in `LinearHorizontal` and `linearVertical` world layouts (see `worldLayout` value).<br/> Otherwise, you should refer to the `worldX`,`worldY` coordinates of each Level.
`toc`<br/> ![Generic badge](https://img.shields.io/badge/Added_1.2.4-gray.svg) | Array&nbsp;of&nbsp;Object | All instances of entities that have their `exportToToc` flag enabled are listed in this array.<br/> This array contains objects with the following fields:<br/> <ul class='subFields'><li>**`identifier`** **(String**)</li><li>**`instancesData`** **(Array of Object**) ![Generic badge](https://img.shields.io/badge/Added_1.5.0-green.svg) <ul class='subFields'><li>**`fields`** **(Array of Untyped**) : *An object containing the values of all entity fields with the `exportToToc` option enabled. This object typing depends on actual field value types.*</li><li>**`heiPx`** **(Int**)</li><li>**`iids`** **([Reference to an Entity instance](#ldtk-EntityReferenceInfos)**) : *IID information of this instance*</li><li>**`widPx`** **(Int**)</li><li>**`worldX`** **(Int**)</li><li>**`worldY`** **(Int**)</li></ul></li><li>**`instances`** **(Array of [Reference to an Entity instance](#ldtk-EntityReferenceInfos)**) : ***WARNING**: this deprecated value will be *removed* completely on version 1.7.0+* ** *Replaced by: `instancesData`*</li></ul>
`toc`<br/> ![Generic badge](https://img.shields.io/badge/Added_1.2.4-gray.svg) | Array&nbsp;of&nbsp;Object | All instances of entities that have their `exportToToc` flag enabled are listed in this array.<br/> This array contains objects with the following fields:<br/> <ul class='subFields'><li>**`identifier`** **(String**)</li><li>**`instancesData`** **(Array of Object**) ![Generic badge](https://img.shields.io/badge/Added_1.5.0-green.svg) <ul class='subFields'><li>**`fields`** **(Untyped**) : *An object containing the values of all entity fields with the `exportToToc` option enabled. This object typing depends on actual field value types.*</li><li>**`heiPx`** **(Int**)</li><li>**`iids`** **([Reference to an Entity instance](#ldtk-EntityReferenceInfos)**) : *IID information of this instance*</li><li>**`widPx`** **(Int**)</li><li>**`worldX`** **(Int**)</li><li>**`worldY`** **(Int**)</li></ul></li><li>**`instances`** **(Array of [Reference to an Entity instance](#ldtk-EntityReferenceInfos)**) : ***WARNING**: this deprecated value will be *removed* completely on version 1.7.0+* ** *Replaced by: `instancesData`*</li></ul>
`worldGridHeight`<br/><sup class="only">Only *'GridVania' layouts*</sup><br/> ![Generic badge](https://img.shields.io/badge/Changed_1.0.0-gray.svg) | Int&nbsp;*(can&nbsp;be&nbsp;`null`)* | **WARNING**: this field will move to the `worlds` array after the "multi-worlds" update. It will then be `null`. You can enable the Multi-worlds advanced project option to enable the change immediately.<br/><br/> Height of the world grid in pixels.
`worldGridWidth`<br/><sup class="only">Only *'GridVania' layouts*</sup><br/> ![Generic badge](https://img.shields.io/badge/Changed_1.0.0-gray.svg) | Int&nbsp;*(can&nbsp;be&nbsp;`null`)* | **WARNING**: this field will move to the `worlds` array after the "multi-worlds" update. It will then be `null`. You can enable the Multi-worlds advanced project option to enable the change immediately.<br/><br/> Width of the world grid in pixels.
`worldLayout`<br/> ![Generic badge](https://img.shields.io/badge/Changed_1.0.0-gray.svg) | Enum&nbsp;*(can&nbsp;be&nbsp;`null`)* | **WARNING**: this field will move to the `worlds` array after the "multi-worlds" update. It will then be `null`. You can enable the Multi-worlds advanced project option to enable the change immediately.<br/><br/> An enum that describes how levels are organized in this project (ie. linearly or in a 2D space).<br/> Possible values: &lt;`null`&gt;, `Free`, `GridVania`, `LinearHorizontal`, `LinearVertical`
Expand Down
6 changes: 1 addition & 5 deletions docs/JSON_SCHEMA.json
Original file line number Diff line number Diff line change
Expand Up @@ -1762,11 +1762,7 @@
]
},
"fields": {
"description": "An object containing the values of all entity fields with the `exportToToc` option enabled. This object typing depends on actual field value types.",
"items" : {},
"type": [
"array"
]
"description": "An object containing the values of all entity fields with the `exportToToc` option enabled. This object typing depends on actual field value types."
},
"iids": {
"description": "IID information of this instance",
Expand Down
6 changes: 1 addition & 5 deletions docs/MINIMAL_JSON_SCHEMA.json
Original file line number Diff line number Diff line change
Expand Up @@ -871,11 +871,7 @@
]
},
"fields": {
"description": "An object containing the values of all entity fields with the `exportToToc` option enabled. This object typing depends on actual field value types.",
"items" : {},
"type": [
"array"
]
"description": "An object containing the values of all entity fields with the `exportToToc` option enabled. This object typing depends on actual field value types."
},
"iids": {
"description": "IID information of this instance",
Expand Down

0 comments on commit a6560d3

Please # to comment.