Update documentation for spawn rules (#117)

Documentation updates

source/behavior/spawn_rules/components/biome_filter.json

@@ -1,8 +1,7 @@
 {
   "$id": "blockception.minecraft.behavior.spawn_rules.minecraft.biome_filter",
   "title": "Biome Filter",
-  "description": "UNDOCUMENTED.",
-  "$comment": "UNDOCUMENTED",
+  "description": "This component allows the players to specify which biomes the mob spawns in. Each biome in the game has one or more tags. These tags are used to determine what biomes mobs spawn in.",
   "oneOf": [
     { "type": "array", "items": { "$ref": "../../entities/filters/filters.json" } },
     { "type": "object", "$ref": "../../entities/filters/filters.json" }

source/behavior/spawn_rules/components/brightness_filter.json

@@ -3,11 +3,18 @@
   "additionalProperties": false,
   "type": "object",
   "title": "Brightness Filter",
-  "description": "UNDOCUMENTED.",
-  "$comment": "UNDOCUMENTED",
+  "description": "This component allows players to set the light level range that causes the mob to spawn.",
   "properties": {
-    "min": { "type": "integer", "description": "This is the minimum light level value that allows the mob to spawn.", "title": "Min" },
-    "max": { "type": "integer", "description": "This is the maximum light level value that allows the mob to spawn.", "title": "Max" },
+    "min": {
+      "type": "integer",
+      "description": "This is the minimum light level value that allows the mob to spawn.",
+      "title": "Min"
+    },
+    "max": {
+      "type": "integer",
+      "description": "This is the maximum light level value that allows the mob to spawn.",
+      "title": "Max"
+    },
     "adjust_for_weather": {
       "type": "boolean",
       "description": "This determines if weather can affect the light level conditions that cause the mob to spawn (e.g. Allowing hostile mobs to spawn during the day when it rains.)",

source/behavior/spawn_rules/components/delay_filter.json

@@ -3,12 +3,21 @@
   "additionalProperties": false,
   "type": "object",
   "title": "Delay Filter",
-  "description": "UNDOCUMENTED.",
-  "$comment": "UNDOCUMENTED",
+  "description": "This component allows players to set mobs spawn with certain time delays before they will spawn.",
+  "required": ["identifier"],
   "properties": {
-    "min": { "type": "integer", "description": "UNDOCUMENTED.", "$comment": "UNDOCUMENTED", "title": "Min" },
-    "max": { "type": "integer", "description": "UNDOCUMENTED.", "$comment": "UNDOCUMENTED", "title": "Max" },
-    "identifier": { "type": "string", "description": "UNDOCUMENTED.", "$comment": "UNDOCUMENTED", "title": "Identifier" },
-    "spawn_chance": { "title": "Spawn Chance", "description": "UNDOCUMENTED.", "$comment": "UNDOCUMENTED", "type": "number" }
+    "min": { "type": "integer", "description": "This is the minimum delay that a mob spawns.", "title": "Min" },
+    "max": { "type": "integer", "description": "This is the maximum delay that a mob spawns.", "title": "Max" },
+    "identifier": {
+      "type": "string",
+      "description": "The identifier of the mob that will spawn.",
+      "title": "Identifier"
+    },
+    "spawn_chance": {
+      "title": "Spawn Chance",
+      "description": "The percent chance that this entity will spawn.",
+      "type": "number",
+      "default": 100
+    }
   }
 }

source/behavior/spawn_rules/components/density_limit.json

@@ -3,10 +3,13 @@
   "additionalProperties": false,
   "type": "object",
   "title": "Density Limit",
-  "description": "UNDOCUMENTED.",
-  "$comment": "UNDOCUMENTED",
+  "description": "This component allows the players to specify the amount of mobs to spawn in certain locations.",
   "properties": {
-    "surface": { "type": "integer", "description": "This is the maximum number of mobs of this type spawnable on the surface.", "title": "Surface" },
+    "surface": {
+      "type": "integer",
+      "description": "This is the maximum number of mobs of this type spawnable on the surface.",
+      "title": "Surface"
+    },
     "underground": {
       "type": "integer",
       "description": "This is the maximum number of mobs of this type spawnable underground.",

source/behavior/spawn_rules/components/difficulty_filter.json

@@ -3,11 +3,18 @@
   "additionalProperties": false,
   "type": "object",
   "title": "Difficulty Filter",
-  "description": "UNDOCUMENTED.",
-  "$comment": "UNDOCUMENTED",
+  "description": "This component allows players to set mobs spawn at certain difficulty levels. The min is for Peaceful difficulty and the max is for Hard difficulty.",
   "definitions": { "difficulty": { "type": "string", "enum": ["easy", "normal", "hard", "peaceful"] } },
   "properties": {
-    "min": { "$ref": "#/definitions/difficulty", "description": "This is the minimum difficulty level that a mob spawns.", "title": "Min" },
-    "max": { "$ref": "#/definitions/difficulty", "description": "This is the maximum difficulty level that a mob spawns.", "title": "Max" }
+    "min": {
+      "$ref": "#/definitions/difficulty",
+      "description": "This is the minimum difficulty level that a mob spawns.",
+      "title": "Min"
+    },
+    "max": {
+      "$ref": "#/definitions/difficulty",
+      "description": "This is the maximum difficulty level that a mob spawns.",
+      "title": "Max"
+    }
   }
 }

source/behavior/spawn_rules/components/distance_filter.json

@@ -3,10 +3,13 @@
   "additionalProperties": false,
   "type": "object",
   "title": "Distance Filter",
-  "description": "UNDOCUMENTED.",
-  "$comment": "UNDOCUMENTED",
+  "description": "This component allows players to set mobs spawn with certain distance levels.",
   "properties": {
-    "min": { "type": "integer", "description": "UNDOCUMENTED.", "$comment": "UNDOCUMENTED", "title": "Min" },
-    "max": { "type": "integer", "description": "UNDOCUMENTED.", "$comment": "UNDOCUMENTED", "title": "Max" }
+    "min": {
+      "type": "integer",
+      "description": "This is the minimum distance level that a mob spawns.",
+      "title": "Min"
+    },
+    "max": { "type": "integer", "description": "This is the maximum distance level that a mob spawns.", "title": "Max" }
   }
 }

source/behavior/spawn_rules/components/height_filter.json

@@ -3,10 +3,9 @@
   "additionalProperties": false,
   "type": "object",
   "title": "Height Filter",
-  "description": "UNDOCUMENTED.",
-  "$comment": "UNDOCUMENTED",
+  "description": "This component allows players to set mobs spawn within certain heights of their map.",
   "properties": {
-    "min": { "type": "integer", "description": "UNDOCUMENTED.", "$comment": "UNDOCUMENTED", "title": "Min" },
-    "max": { "type": "integer", "description": "UNDOCUMENTED.", "$comment": "UNDOCUMENTED", "title": "Max" }
+    "min": { "type": "integer", "description": "This is the minimum height level that a mob spawns.", "title": "Min" },
+    "max": { "type": "integer", "description": "This is the maximum height level that a mob spawns.", "title": "Max" }
   }
 }

source/behavior/spawn_rules/components/herd.json

@@ -1,8 +1,7 @@
 {
   "$id": "blockception.minecraft.behavior.spawn_rules.minecraft.height_filter",
   "title": "Height Filter",
-  "description": "UNDOCUMENTED.",
-  "$comment": "UNDOCUMENTED",
+  "description": "This component allows players to determine the herd size of animals.",
   "definitions": {
     "herd": {
       "type": "object",
@@ -10,11 +9,33 @@
       "description": "Herd.",
       "additionalProperties": false,
       "properties": {
-        "initial_event": { "title": "Initial Event", "description": "UNDOCUMENTED.", "$comment": "UNDOCUMENTED", "type": "string" },
-        "initial_event_count": { "title": "Initial Event Count", "description": "UNDOCUMENTED.", "$comment": "UNDOCUMENTED", "type": "integer" },
-        "min_size": { "type": "integer", "description": "This is the minimum number of mobs that spawn in a herd.", "title": "Minimum Size" },
-        "max_size": { "type": "integer", "description": "This is the maximum number of mobs that spawn in a herd.", "title": "Maximum Size" },
-        "event": { "type": "string", "description": "This is an event that can be triggered from spawning.", "title": "Event" },
+        "initial_event": {
+          "title": "Initial Event",
+          "description": "UNDOCUMENTED.",
+          "$comment": "UNDOCUMENTED",
+          "type": "string"
+        },
+        "initial_event_count": {
+          "title": "Initial Event Count",
+          "description": "UNDOCUMENTED.",
+          "$comment": "UNDOCUMENTED",
+          "type": "integer"
+        },
+        "min_size": {
+          "type": "integer",
+          "description": "This is the minimum number of mobs that spawn in a herd.",
+          "title": "Minimum Size"
+        },
+        "max_size": {
+          "type": "integer",
+          "description": "This is the maximum number of mobs that spawn in a herd.",
+          "title": "Maximum Size"
+        },
+        "event": {
+          "type": "string",
+          "description": "This is an event that can be triggered from spawning.",
+          "title": "Event"
+        },
         "event_skip_count": {
           "type": "integer",
           "description": "This is the number of mobs spawned before the specified event is triggered.",

source/behavior/spawn_rules/components/mob_event_filter.json

@@ -1,11 +1,11 @@
 {
   "$id": "blockception.minecraft.behavior.spawn_rules.minecraft.mob_event_filter",
   "title": "Mob Event Filter",
-  "description": "This component allows players to spawn mobs on a particular event..",
+  "description": "This component allows players to spawn mobs on a particular event.",
   "additionalProperties": false,
   "type": "object",
   "properties": {
-    "event_filter": {
+    "event": {
       "type": "string",
       "description": "The event String in this JSON Object is used to filter the spawn rules of the mob type. Can be type minecraft:pillager_patrols_event, minecraft:wandering_trader_event, or minecraft:ender_dragon_event..",
       "title": "Event Filter",

source/behavior/spawn_rules/components/permute_type.json

@@ -1,24 +1,35 @@
 {
   "$id": "blockception.minecraft.behavior.spawn_rules.minecraft.permute_type",
-  "additionalProperties": false,
-  "type": "array",
   "title": "Permute Type",
-  "description": "UNDOCUMENTED.",
-  "$comment": "UNDOCUMENTED",
-  "items": {
-    "type": "object",
-    "additionalProperties": false,
-    "title": "Permute Type",
-    "description": "UNDOCUMENTED.",
-    "$comment": "UNDOCUMENTED",
-    "properties": {
-      "weight": { "type": "integer", "title": "Weight", "description": "UNDOCUMENTED.", "$comment": "UNDOCUMENTED" },
-      "entity_type": {
-        "type": "string",
-        "title": "Entity Type",
-        "description": "UNDOCUMENTED.",
-        "$comment": "UNDOCUMENTED"
+  "description": "This component allows the players to specify the permutations of a mob that will spawn.",
+  "definitions": {
+    "permute_type": {
+      "type": "object",
+      "additionalProperties": false,
+      "title": "Permute Type",
+      "description": "UNDOCUMENTED.",
+      "$comment": "UNDOCUMENTED",
+      "properties": {
+        "weight": {
+          "type": "integer",
+          "title": "Weight",
+          "description": "The percentage of 100 of a type of mob that should spawn. If there are multiple weights, they must add up to 100."
+        },
+        "entity_type": {
+          "type": "string",
+          "title": "Entity Type",
+          "description": "The type of mob to spawn."
+        },
+        "guaranteed_count": {
+          "type": "number",
+          "title": "Guaranteed Count",
+          "description": "Causes mobs to spawn with a guaranteed_count before mobs that do not have this spawn condition."
+        }
       }
     }
-  }
+  },
+  "oneOf": [
+    { "type": "object", "$ref": "#/definitions/permute_type" },
+    { "type": "array", "items": { "$ref": "#/definitions/permute_type" } }
+  ]
 }

source/behavior/spawn_rules/components/player_in_village_filter.json

@@ -3,8 +3,7 @@
   "additionalProperties": false,
   "type": "object",
   "title": "Player In Village Filter",
-  "description": "UNDOCUMENTED.",
-  "$comment": "UNDOCUMENTED",
+  "description": "This component lets players be filtered by whether they are in a village or not, using distance and the village border definitions.",
   "properties": {
     "distance": { "type": "integer", "title": "Distance", "description": "UNDOCUMENTED.", "$comment": "UNDOCUMENTED" },
     "village_border_tolerance": {

source/behavior/spawn_rules/components/spawns_lava.json

@@ -3,7 +3,6 @@
   "additionalProperties": false,
   "type": "object",
   "title": "Spawns On Lava",
-  "description": "UNDOCUMENTED.",
-  "$comment": "UNDOCUMENTED",
+  "description": "This component determines if an entity spawns lava.",
   "properties": {}
 }

source/behavior/spawn_rules/components/spawns_on_block_filter.json

@@ -1,7 +1,6 @@
 {
   "$id": "blockception.minecraft.behavior.spawn_rules.minecraft.spawns_on_block_filter",
   "title": "Spawns On Block Filter",
-  "description": "UNDOCUMENTED.",
-  "$comment": "UNDOCUMENTED",
+  "description": "This component allows an entity to spawn on a particular block. It includes a string or array of strings for the block they may spawn on.",
   "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }]
 }

source/behavior/spawn_rules/components/spawns_on_block_prevented_filter.json

@@ -1,7 +1,6 @@
 {
   "$id": "blockception.minecraft.behavior.spawn_rules.minecraft.spawns_on_block_prevented_filter",
   "title": "Spawns On Block Prevented Filter",
-  "description": "UNDOCUMENTED.",
-  "$comment": "UNDOCUMENTED",
+  "description": "This component allows an entity to not spawn on a particular block. It includes a string or array of strings for the block they may not spawn on.",
   "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }]
 }

source/behavior/spawn_rules/components/spawns_on_surface.json

@@ -3,7 +3,6 @@
   "additionalProperties": false,
   "type": "object",
   "title": "Spawns On Surface",
-  "description": "UNDOCUMENTED.",
-  "$comment": "UNDOCUMENTED",
+  "description": "This component allows the mob to spawn on the ground. Adding the component causes it to be true, removing it causes the mob to stop spawning on the surface.",
   "properties": {}
 }

source/behavior/spawn_rules/components/spawns_underground.json

@@ -3,7 +3,6 @@
   "additionalProperties": false,
   "type": "object",
   "title": "Spawns Underground",
-  "description": "UNDOCUMENTED.",
-  "$comment": "UNDOCUMENTED",
+  "description": "This component allows an entity to spawn underground.",
   "properties": {}
 }

source/behavior/spawn_rules/components/spawns_underwater.json

@@ -1,8 +1,7 @@
 {
   "$id": "blockception.minecraft.behavior.spawn_rules.minecraft.spawns_underwater",
   "title": "Spawns Underwater",
-  "description": "UNDOCUMENTED.",
-  "$comment": "UNDOCUMENTED",
+  "description": "This component allows the mob to spawn underwater. Adding the component causes it to be true, removing it causes the mob to stop spawning underwater.",
   "type": "object",
   "additionalProperties": false
 }

source/behavior/spawn_rules/components/weight.json

@@ -3,7 +3,18 @@
   "additionalProperties": false,
   "type": "object",
   "title": "Weight",
-  "description": "UNDOCUMENTED.",
-  "$comment": "UNDOCUMENTED",
-  "properties": { "default": { "type": "integer", "description": "UNDOCUMENTED.", "$comment": "UNDOCUMENTED", "title": "Default" } }
+  "description": "This component allows players to set a priority for how often that mob should spawn. Mobs with lower weight values will have a lower chance to spawn than mobs with higher weight values.",
+  "properties": {
+    "default": {
+      "type": "integer",
+      "description": "This is the priority of the mob spawning out of 100.",
+      "title": "Default"
+    },
+    "rarity": {
+      "type": "integer",
+      "description": "UNDOCUMENTED.",
+      "$comment": "UNDOCUMENTED.",
+      "title": "Rarity"
+    }
+  }
 }

source/behavior/spawn_rules/components/world_age_filter.json

@@ -1,8 +1,13 @@
 {
   "$id": "blockception.minecraft.behavior.spawn_rules.minecraft.world_age_filter",
   "title": "World Age Filter",
-  "description": "UNDOCUMENTED.",
-  "$comment": "UNDOCUMENTED",
+  "description": "This component allows players to set mobs spawn after a certain amount of time has passed within a world.",
   "additionalProperties": false,
-  "properties": { "min": { "type": "integer", "description": "UNDOCUMENTED.", "$comment": "UNDOCUMENTED", "title": "Min" } }
+  "properties": {
+    "min": {
+      "type": "integer",
+      "description": "This is the minimum world_age_filter level that a mob spawns.",
+      "title": "Min"
+    }
+  }
 }