From 749f8cc1f4bb41bbf8cbf0033f587f79caffc845 Mon Sep 17 00:00:00 2001 From: Sebastien Benard Date: Fri, 1 Dec 2023 17:39:13 +0100 Subject: [PATCH] Docs --- docs/JSON_DOC.md | 4 +++- docs/JSON_SCHEMA.json | 33 +++++++++++++++++++++++++++++++++ docs/MINIMAL_JSON_SCHEMA.json | 19 +++++++++++++++++++ 3 files changed, 55 insertions(+), 1 deletion(-) diff --git a/docs/JSON_DOC.md b/docs/JSON_DOC.md index b1994da3e..3c4bef8fa 100644 --- a/docs/JSON_DOC.md +++ b/docs/JSON_DOC.md @@ -224,7 +224,9 @@ Value | Type | Description `pxOffsetY`
![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`
Only *Tile layers, Auto-layers*
![Generic badge](https://img.shields.io/badge/Changed_1.0.0-gray.svg) | Int *(can be `null`)* | Reference to the default Tileset UID being used by this layer definition.
**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.
Note: since version 1.0.0, the old `autoTilesetDefUid` was removed and merged into this value. `uid` | Int | Unique Int identifier -`autoRuleGroups`
Only *Auto-layers*
*Only used by editor* | Array of Object | Contains all the auto-layer rule definitions.
This array contains objects with the following fields:
+`autoRuleGroups`
Only *Auto-layers*
*Only used by editor* | Array of Object | Contains all the auto-layer rule definitions.
This array contains objects with the following fields:
+`autoTilesKilledByOtherLayerUid`
Only *Auto layers*
*Only used by editor*
![Generic badge](https://img.shields.io/badge/Added_1.4.2-gray.svg) | Int *(can be `null`)* | +`biomeFieldUid`
*Only used by editor*
![Generic badge](https://img.shields.io/badge/Added_1.4.2-gray.svg) | Int *(can be `null`)* | `canSelectWhenInactive`
*Only used by editor*
![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`
*Only used by editor*
![Generic badge](https://img.shields.io/badge/Added_1.2.5-gray.svg) | String *(can be `null`)* | User defined documentation for this element to provide help/tips to level designers. `excludedTags`
Only *Entity layer*
*Only used by editor*
![Generic badge](https://img.shields.io/badge/Added_0.8.0-gray.svg) | Array of String | An array of tags to forbid some Entities in this layer diff --git a/docs/JSON_SCHEMA.json b/docs/JSON_SCHEMA.json index 9a6e3f065..c665e0110 100644 --- a/docs/JSON_SCHEMA.json +++ b/docs/JSON_SCHEMA.json @@ -1587,8 +1587,10 @@ "title": "Auto-layer rule group", "required": [ "active", + "biomeRequirementMode", "isOptional", "name", + "requiredBiomeValues", "rules", "uid", "usesWizard" @@ -1608,6 +1610,12 @@ "null" ] }, + "biomeRequirementMode": { + "description": "", + "type": [ + "integer" + ] + }, "color": { "description": "", "type": [ @@ -1646,6 +1654,17 @@ "integer" ] }, + "requiredBiomeValues": { + "description": "", + "items": { + "type": [ + "string" + ] + }, + "type": [ + "array" + ] + }, "active": { "description": "", "type": [ @@ -2647,6 +2666,13 @@ "number" ] }, + "biomeFieldUid": { + "description": "", + "type": [ + "integer", + "null" + ] + }, "gridSize": { "description": "Width and height of the grid in pixels", "type": [ @@ -2658,6 +2684,13 @@ "type": [ "number" ] + }, + "autoTilesKilledByOtherLayerUid": { + "description": "", + "type": [ + "integer", + "null" + ] } }, "type": [ diff --git a/docs/MINIMAL_JSON_SCHEMA.json b/docs/MINIMAL_JSON_SCHEMA.json index 478409348..261062fb2 100644 --- a/docs/MINIMAL_JSON_SCHEMA.json +++ b/docs/MINIMAL_JSON_SCHEMA.json @@ -703,8 +703,10 @@ "title": "Auto-layer rule group", "required": [ "active", + "biomeRequirementMode", "isOptional", "name", + "requiredBiomeValues", "rules", "uid", "usesWizard" @@ -717,6 +719,12 @@ "string" ] }, + "biomeRequirementMode": { + "description": "", + "type": [ + "integer" + ] + }, "color": { "description": "", "type": [ @@ -755,6 +763,17 @@ "integer" ] }, + "requiredBiomeValues": { + "description": "", + "items": { + "type": [ + "string" + ] + }, + "type": [ + "array" + ] + }, "active": { "description": "", "type": [