Docs

deepnight · Dec 1, 2023 · 749f8cc · 749f8cc
1 parent b0e3c54
commit 749f8cc
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 1 deletion.
diff --git a/docs/JSON_DOC.md b/docs/JSON_DOC.md
@@ -224,7 +224,9 @@ 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.4.0-gray.svg) </li><li>**`icon`** **([Tileset rectangle](#ldtk-TilesetRect) *(can be `null`)***)  ![Generic badge](https://img.shields.io/badge/Added_1.4.0-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>**`biomeRequirementMode`** **(Int**)  ![Generic badge](https://img.shields.io/badge/Added_1.4.2-gray.svg) </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.4.0-gray.svg) </li><li>**`icon`** **([Tileset rectangle](#ldtk-TilesetRect) *(can be `null`)***)  ![Generic badge](https://img.shields.io/badge/Added_1.4.0-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>**`requiredBiomeValues`** **(Array of String**)  ![Generic badge](https://img.shields.io/badge/Added_1.4.2-gray.svg) </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>
+`autoTilesKilledByOtherLayerUid`<br/><sup class="only">Only *Auto layers*</sup><br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_1.4.2-gray.svg)  | Int&nbsp;*(can&nbsp;be&nbsp;`null`)* | 
+`biomeFieldUid`<br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_1.4.2-gray.svg)  | Int&nbsp;*(can&nbsp;be&nbsp;`null`)* | 
 `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

diff --git 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
@@ -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": [