Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
deepnight committed Jun 27, 2023
1 parent d99eaaa commit 581e4b9
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/JSON_DOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,8 @@ Value | Type | Description
`__smartColor`<br/> ![Generic badge](https://img.shields.io/badge/Added_1.0.0-gray.svg) | String | The entity "smart" color, guessed from either Entity definition, or one its field instances.
`__tags`<br/> ![Generic badge](https://img.shields.io/badge/Added_1.0.0-gray.svg) | Array&nbsp;of&nbsp;String | Array of tags defined in this Entity definition
`__tile`<br/> ![Generic badge](https://img.shields.io/badge/Added_0.4.0-gray.svg) ![Generic badge](https://img.shields.io/badge/Changed_1.0.0-gray.svg) | [Tileset&nbsp;rectangle](#ldtk-TilesetRect)&nbsp;*(can&nbsp;be&nbsp;`null`)* | Optional TilesetRect used to display this entity (it could either be the default Entity tile, or some tile provided by a field value, like an Enum).
`__worldX`<br/> ![Generic badge](https://img.shields.io/badge/Added_1.3.4-green.svg) | Int | X world coordinate in pixels
`__worldY`<br/> ![Generic badge](https://img.shields.io/badge/Added_1.3.4-green.svg) | Int | Y world coordinate in pixels
`defUid` | Int | Reference of the **Entity definition** UID
`fieldInstances` | Array&nbsp;of&nbsp;[Field&nbsp;instance](#ldtk-FieldInstanceJson) | An array of all custom fields and their values.
`height`<br/> ![Generic badge](https://img.shields.io/badge/Added_0.8.0-gray.svg) | Int | Entity height in pixels. For non-resizable entities, it will be the same as Entity definition.
Expand Down
14 changes: 14 additions & 0 deletions docs/JSON_SCHEMA.json
Original file line number Diff line number Diff line change
Expand Up @@ -502,6 +502,8 @@
"__pivot",
"__smartColor",
"__tags",
"__worldX",
"__worldY",
"defUid",
"fieldInstances",
"height",
Expand Down Expand Up @@ -553,6 +555,18 @@
"array"
]
},
"__worldX": {
"description": "X world coordinate in pixels",
"type": [
"integer"
]
},
"__worldY": {
"description": "Y world coordinate in pixels",
"type": [
"integer"
]
},
"__smartColor": {
"description": "The entity \"smart\" color, guessed from either Entity definition, or one its field instances.",
"type": [
Expand Down
14 changes: 14 additions & 0 deletions docs/MINIMAL_JSON_SCHEMA.json
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,8 @@
"__pivot",
"__smartColor",
"__tags",
"__worldX",
"__worldY",
"defUid",
"fieldInstances",
"height",
Expand Down Expand Up @@ -345,6 +347,18 @@
"array"
]
},
"__worldX": {
"description": "X world coordinate in pixels",
"type": [
"integer"
]
},
"__worldY": {
"description": "Y world coordinate in pixels",
"type": [
"integer"
]
},
"__smartColor": {
"description": "The entity \"smart\" color, guessed from either Entity definition, or one its field instances.",
"type": [
Expand Down

0 comments on commit 581e4b9

Please sign in to comment.