Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
deepnight committed Sep 22, 2023
1 parent b462252 commit e1ff333
Show file tree
Hide file tree
Showing 3 changed files with 27 additions 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 @@ -224,7 +224,7 @@ Value | Type | Description
`pxOffsetY`<br/> ![Generic badge](https://img.shields.io/badge/Added_0.5.0-gray.svg) | Int | Y offset of the layer, in pixels (IMPORTANT: this should be added to the `LayerInstance` optional offset)
`tilesetDefUid`<br/><sup class="only">Only *Tile layers, Auto-layers*</sup><br/> ![Generic badge](https://img.shields.io/badge/Changed_1.0.0-gray.svg) | Int&nbsp;*(can&nbsp;be&nbsp;`null`)* | Reference to the default Tileset UID being used by this layer definition.<br/> **WARNING**: some layer *instances* might use a different tileset. So most of the time, you should probably use the `__tilesetDefUid` value found in layer instances.<br/> Note: since version 1.0.0, the old `autoTilesetDefUid` was removed and merged into this value.
`uid` | Int | Unique Int identifier
`autoRuleGroups`<br/><sup class="only">Only *Auto-layers*</sup><br/><sup class="internal">*Only used by editor*</sup> | Array&nbsp;of&nbsp;Object | Contains all the auto-layer rule definitions.<br/> This array contains objects with the following fields:<br/> <ul class='subFields'><li>**`active`** **(Bool**)</li><li>~~collapsed~~ **(Bool**) *This field was removed in 1.0.0 and should no longer be used.*</li><li>**`color`** **(String *(can be `null`)***) ![Generic badge](https://img.shields.io/badge/Added_1.3.5-gray.svg) </li><li>**`isOptional`** **(Bool**) ![Generic badge](https://img.shields.io/badge/Added_0.9.0-gray.svg) </li><li>**`name`** **(String**)</li><li>**`rules`** **(Array of [Auto-layer rule definition](#ldtk-AutoRuleDef)**)</li><li>**`uid`** **(Int**)</li><li>**`usesWizard`** **(Bool**) ![Generic badge](https://img.shields.io/badge/Added_1.1.4-gray.svg) </li></ul>
`autoRuleGroups`<br/><sup class="only">Only *Auto-layers*</sup><br/><sup class="internal">*Only used by editor*</sup> | Array&nbsp;of&nbsp;Object | Contains all the auto-layer rule definitions.<br/> This array contains objects with the following fields:<br/> <ul class='subFields'><li>**`active`** **(Bool**)</li><li>~~collapsed~~ **(Bool**) *This field was removed in 1.0.0 and should no longer be used.*</li><li>**`color`** **(String *(can be `null`)***) ![Generic badge](https://img.shields.io/badge/Added_1.3.5-gray.svg) </li><li>**`icon`** **([Tileset rectangle](#ldtk-TilesetRect) *(can be `null`)***) ![Generic badge](https://img.shields.io/badge/Added_1.3.5-gray.svg) </li><li>**`isOptional`** **(Bool**) ![Generic badge](https://img.shields.io/badge/Added_0.9.0-gray.svg) </li><li>**`name`** **(String**)</li><li>**`rules`** **(Array of [Auto-layer rule definition](#ldtk-AutoRuleDef)**)</li><li>**`uid`** **(Int**)</li><li>**`usesWizard`** **(Bool**) ![Generic badge](https://img.shields.io/badge/Added_1.1.4-gray.svg) </li></ul>
`canSelectWhenInactive`<br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_1.1.4-gray.svg) | Bool | Allow editor selections when the layer is not currently active.
`doc`<br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_1.2.5-gray.svg) | String&nbsp;*(can&nbsp;be&nbsp;`null`)* | User defined documentation for this element to provide help/tips to level designers.
`excludedTags`<br/><sup class="only">Only *Entity layer*</sup><br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_0.8.0-gray.svg) | Array&nbsp;of&nbsp;String | An array of tags to forbid some Entities in this layer
Expand Down
13 changes: 13 additions & 0 deletions docs/JSON_SCHEMA.json
Original file line number Diff line number Diff line change
Expand Up @@ -1593,6 +1593,19 @@
"boolean"
]
},
"icon": {
"description": "",
"oneOf": [
{
"type": [
"null"
]
},
{
"$ref": "#/otherTypes/TilesetRect"
}
]
},
"usesWizard": {
"description": "",
"type": [
Expand Down
13 changes: 13 additions & 0 deletions docs/MINIMAL_JSON_SCHEMA.json
Original file line number Diff line number Diff line change
Expand Up @@ -727,6 +727,19 @@
"boolean"
]
},
"icon": {
"description": "",
"oneOf": [
{
"type": [
"null"
]
},
{
"$ref": "#/otherTypes/TilesetRect"
}
]
},
"usesWizard": {
"description": "",
"type": [
Expand Down

0 comments on commit e1ff333

Please # to comment.