Updated comments

2021-07-03 11:45:14 +02:00
parent 0755a30b1e
commit 56d96d8c64
15 changed files with 92 additions and 95 deletions
--- a/source/behavior/entities/1.16.0/behaviors/minecraft.behavior.drink_potion.json
+++ b/source/behavior/entities/1.16.0/behaviors/minecraft.behavior.drink_potion.json
@@ -8,7 +8,7 @@
  "properties": {
    "priority": { "$ref": "./types/priority.json" },
    "speed_multiplier": { "$ref": "./types/speed_multiplier.json" },
-    "speed_modifier": { "default": 0.0, "description": "UNDOCUMENTED: speed modifier", "title": "Speed Modifier" },
+    "speed_modifier": { "default": 0.0, "description": "Movement speed modifier of the mob when using this AI Goal", "title": "Speed Modifier" },
    "potions": {
      "type": "array",
      "description": "A list of potions that this entity can drink.",
@@ -17,7 +17,7 @@
        "required": ["id", "chance", "filters"],
        "additionalProperties": false,
        "type": "object",
-        "description": "UNDOCUMENTED: potions",
+        "description": "A potions that this entity can drink.",
        "title": "Potions",
        "properties": {
          "id": { "type": "integer", "default": -1, "description": "The registry ID of the potion to use", "title": "Id" },
--- a/source/behavior/entities/1.16.0/behaviors/minecraft.behavior.equip_item.json
+++ b/source/behavior/entities/1.16.0/behaviors/minecraft.behavior.equip_item.json
@@ -2,8 +2,7 @@
  "$id": "blockception.minecraft.behavior.entities.1.16.0.minecraft.behavior.equip_item",
  "type": "object",
  "title": "Equip Item 1.16.0",
-  "description": "UNDOCUMENTED",
-  "$comment": "UNDOCUMENTED",
+  "description": "Allows the entity to equip desired equipment.",
  "additionalProperties": false,
  "properties": { "priority": { "$ref": "types/priority.json" } }
 }
--- a/source/behavior/entities/1.16.0/behaviors/minecraft.behavior.go_home.json
+++ b/source/behavior/entities/1.16.0/behaviors/minecraft.behavior.go_home.json
@@ -4,25 +4,6 @@
  "description": "Allows the mob to move back to the position they were spawned.",
  "title": "Go Home",
  "type": "object",
-  "definitions": {
-    "on_home_spec": {
-      "additionalProperties": false,
-      "type": "object",
-      "title": "On Home Event",
-      "description": "UNDOCUMENTED",
-      "$comment": "UNDOCUMENTED",
-      "properties": {
-        "event": { "type": "string", "pattern": "^[a-zA-Z0-9_\\-:]+$", "description": "The event to fire", "title": "Event" },
-        "target": {
-          "type": "string",
-          "description": "The target of the event",
-          "title": "Target",
-          "enum": ["baby", "block", "damager", "other", "parent", "player", "self", "target"]
-        },
-        "filters": { "$ref": "../../filters/filters.json" }
-      }
-    }
-  },
  "properties": {
    "priority": { "$ref": "types/priority.json" },
    "speed_multiplier": { "$ref": "types/speed_multiplier.json" },
@@ -41,11 +22,7 @@
    "on_home": {
      "description": "Event to run when this mob gets home.",
      "title": "On Home",
-      "oneOf": [
-        { "type": "string", "pattern": "^[a-zA-Z0-9_\\-:]+$" },
-        { "type": "object", "$ref": "#/definitions/on_home_spec" },
-        { "type": "array", "items": { "$ref": "#/definitions/on_home_spec" } }
-      ]
+      "$ref": "../types/trigger.json"
    },
    "on_failed": {
      "$ref": "../types/event.json",
--- a/source/behavior/entities/1.16.0/behaviors/minecraft.behavior.knockback_roar.json
+++ b/source/behavior/entities/1.16.0/behaviors/minecraft.behavior.knockback_roar.json
@@ -28,14 +28,20 @@
      "title": "Knockback Range"
    },
    "knockback_strength": { "type": "integer", "default": 4, "description": "The strength of the knockback.", "title": "Knockback Strength" },
-    "Trigger": { "$ref": "../types/trigger.json", "description": "On_roar_end", "title": "Trigger" },
    "knockback_filters": {
      "$ref": "../../filters/filters.json",
-      "description": "UNDOCUMENTED",
-      "$comment": "UNDOCUMENTED",
+      "description": "filters to use to decide what is affected by knockback roar.",
      "title": "Knockback Filters"
    },
-    "damage_filters": { "$ref": "../../filters/filters.json", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Damage Filters" },
-    "on_roar_end": { "$ref": "../types/event.json", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "On Roar End" }
+    "damage_filters": {
+      "$ref": "../../filters/filters.json",
+      "description": "filters to use to decide what is damaged by knockback roar.",
+      "title": "Damage Filters"
+    },
+    "on_roar_end": {
+      "$ref": "../types/event.json",
+      "description": "Event to run when knockback roar has finished.",
+      "title": "On Roar End"
+    }
  }
 }
--- a/source/behavior/entities/1.16.0/behaviors/minecraft.behavior.rise_to_liquid_level.json
+++ b/source/behavior/entities/1.16.0/behaviors/minecraft.behavior.rise_to_liquid_level.json
@@ -10,10 +10,17 @@
    "liquid_y_offset": {
      "type": "number",
      "title": "Liquid Y Offset",
-      "description": "UNDOCUMENTED",
-      "$comment": "UNDOCUMENTED"
+      "description": "Vertical offset from the liquid"
    },
-    "rise_delta": { "type": "number", "title": "Rise Delta", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" },
-    "sink_delta": { "type": "number", "title": "Sink Delta", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" }
+    "rise_delta": {
+      "type": "number",
+      "title": "Rise Delta",
+      "description": "Displacement for how much the entity will move up in the vertical axis"
+    },
+    "sink_delta": {
+      "type": "number",
+      "title": "Sink Delta",
+      "description": "Displacement for how much the entity will move down in the vertical axis"
+    }
  }
 }
--- a/source/behavior/entities/1.16.0/components/minecraft.block_sensor.json
+++ b/source/behavior/entities/1.16.0/components/minecraft.block_sensor.json
@@ -9,23 +9,22 @@
    "on_break": {
      "type": "array",
      "title": "On Break",
+      "description": "Blocks that will trigger the component when broken and what event will trigger.",
      "items": {
        "type": "object",
        "title": "On Block Broken",
+        "description": "",
        "additionalProperties": false,
        "properties": {
          "block_list": {
            "type": "array",
            "title": "Block List",
-            "description": "UNDOCUMENTED",
-            "$comment": "UNDOCUMENTED",
-            "items": { "type": "string", "title": "Block ID" }
+            "description": "Blocks that will trigger the component when broken and what event will trigger.",
+            "items": { "$ref": "../../../../general/block/identifier.json", "title": "Block ID" }
          },
-          "on_block_broken": { "type": "string", "title": "On Block Broken", "description": "On block broken" }
+          "on_block_broken": { "type": "string", "title": "On Block Broken", "description": "Event to run when a block breaks" }
        }
-      },
-      "description": "UNDOCUMENTED",
-      "$comment": "UNDOCUMENTED"
+      }
    }
  }
 }
--- a/source/behavior/entities/1.16.0/components/minecraft.buoyant.json
+++ b/source/behavior/entities/1.16.0/components/minecraft.buoyant.json
@@ -8,8 +8,7 @@
    "base_buoyancy": {
      "type": "number",
      "default": 0,
-      "description": "UNDOCUMENTED",
-      "$comment": "UNDOCUMENTED",
+      "description": "Base buoyancy used to calculate how much will a mob float.",
      "title": "Base Buoyancy"
    },
    "apply_gravity": {
--- a/source/behavior/entities/1.16.0/components/minecraft.celebrate_hunt.json
+++ b/source/behavior/entities/1.16.0/components/minecraft.celebrate_hunt.json
@@ -48,15 +48,13 @@
          "properties": {
            "range_min": {
              "type": "number",
-              "title": "Update Interval Variant",
-              "description": "UNDOCUMENTED",
-              "$comment": "UNDOCUMENTED"
+              "title": "Minimum",
+              "description": "Minimum"
            },
            "range_max": {
              "type": "number",
-              "title": "Update Interval Variant",
-              "description": "UNDOCUMENTED",
-              "$comment": "UNDOCUMENTED"
+              "title": "Maximum",
+              "description": "Maximum"
            }
          }
        }
--- a/source/behavior/entities/1.16.0/components/minecraft.custom_hit_test.json
+++ b/source/behavior/entities/1.16.0/components/minecraft.custom_hit_test.json
@@ -8,23 +8,32 @@
    "hitboxes": {
      "type": "array",
      "title": "Hitboxes",
-      "description": "UNDOCUMENTED",
-      "$comment": "UNDOCUMENTED",
+      "description": "Defines a hitbox size and pivot to test against.",
      "items": {
        "type": "object",
        "title": "Hitbox",
-        "description": "UNDOCUMENTED",
-        "$comment": "UNDOCUMENTED",
+        "description": "Defines a hitbox size and pivot to test against.",
        "additionalProperties": false,
        "properties": {
-          "width": { "type": "number", "title": "Width", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" },
-          "height": { "type": "number", "title": "Height", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" },
+          "width": {
+            "type": "number",
+            "title": "Width",
+            "description": "Height of the hitbox in blocks. A negative value will be assumed to be 0."
+          },
+          "height": {
+            "type": "number",
+            "title": "Height",
+            "description": "Width and Depth of the hitbox in blocks. A negative value will be assumed to be 0."
+          },
          "pivot": {
            "type": "array",
            "title": "Pivot",
-            "description": "UNDOCUMENTED",
-            "$comment": "UNDOCUMENTED",
-            "items": [{ "type": "number" }, { "type": "number" }, { "type": "number" }]
+            "description": "The offset from the entity's anchor where the hitbox will spawn",
+            "items": [
+              { "type": "number", "title": "X" },
+              { "type": "number", "title": "Y" },
+              { "type": "number", "title": "Z" }
+            ]
          }
        }
      }
--- a/source/behavior/entities/1.16.0/components/minecraft.damage_sensor.json
+++ b/source/behavior/entities/1.16.0/components/minecraft.damage_sensor.json
@@ -31,16 +31,12 @@
          "type": "object",
          "description": "Specifies filters for entity definitions and events.",
          "title": "On Damage",
-          "properties": {
-            "filters": { "$ref": "../../filters/filters.json" },
-            "event": { "type": "string", "pattern": "^.*$", "description": "UNDOCUMENTED: event", "title": "Event" },
-            "target": { "$ref": "../../filters/filters/types/subject.json", "description": "UNDOCUMENTED: target", "title": "Target" }
-          },
-          "on_damage_sound_event": {
-            "type": "string",
-            "description": "Defines what sound to play, if any, when the on_damage filters are met.",
-            "title": "On Damage Sound Event"
-          }
+          "$ref": "../types/trigger.json"
+        },
+        "on_damage_sound_event": {
+          "type": "string",
+          "description": "Defines what sound to play, if any, when the on_damage filters are met.",
+          "title": "On Damage Sound Event"
        }
      }
    }
--- a/source/behavior/entities/1.16.0/components/minecraft.despawn.json
+++ b/source/behavior/entities/1.16.0/components/minecraft.despawn.json
@@ -14,8 +14,7 @@
    "despawn_from_distance": {
      "type": "object",
      "additionalProperties": false,
-      "description": "UNDOCUMENTED",
-      "$comment": "UNDOCUMENTED",
+      "description": "Defines the minimum and maximum distance for despawn to occur.",
      "title": "Despawn From Distance",
      "properties": {
        "max_distance": {
--- a/source/behavior/entities/1.16.0/components/minecraft.equipment.json
+++ b/source/behavior/entities/1.16.0/components/minecraft.equipment.json
@@ -2,6 +2,7 @@
  "$id": "blockception.minecraft.behavior.entities.1.16.0.minecraft.equipment",
  "type": "object",
  "title": "Equipment 1.16.0",
+  "description": "Sets the equipment table to use for the entity.",
  "additionalProperties": false,
  "required": [],
  "properties": {
@@ -12,8 +13,7 @@
      "items": {
        "additionalProperties": false,
        "title": "Slot Drop Chance",
-        "description": "UNDOCUMENTED",
-        "$comment": "UNDOCUMENTED",
+        "description": "A slots with the chance to drop an equipped item from that slot.",
        "type": "object",
        "properties": {
          "drop_chance": {
@@ -26,7 +26,10 @@
        }
      }
    },
-    "table": { "type": "string", "pattern": ".*\\.json$", "description": "UNDOCUMENTED: table", "title": "Table" }
-  },
-  "description": "UNDOCUMENTED: "
+    "table": {
+      "title": "Table",
+      "description": "The file path to the equipment table, relative to the behavior pack's root.",
+      "$ref": "../../../../general/loot_table/identifier.json"
+    }
+  }
 }
--- a/source/behavior/entities/1.16.0/components/minecraft.experience_reward.json
+++ b/source/behavior/entities/1.16.0/components/minecraft.experience_reward.json
@@ -2,8 +2,7 @@
  "$id": "blockception.minecraft.behavior.entities.1.16.0.minecraft.experience_reward",
  "type": "object",
  "title": "Experience Reward 1.16.0",
-  "description": "UNDOCUMENTED",
-  "$comment": "UNDOCUMENTED",
+  "description": "Defines the amount of experience rewarded when the entity dies or is successfully bred.",
  "additionalProperties": false,
  "properties": {
    "on_bred": {
--- a/source/behavior/entities/1.16.0/components/minecraft.giveable.json
+++ b/source/behavior/entities/1.16.0/components/minecraft.giveable.json
@@ -7,9 +7,10 @@
  "required": [],
  "properties": {
    "triggers": {
-      "description": "UNDOCUMENTED",
-      "$comment": "UNDOCUMENTED",
+      "description": "Defines sets of items that can be used to trigger events when used on this entity. The item will also be taken and placed in the entity's inventory.",
      "title": "Triggers",
+      "type": "object",
+      "additionalProperties": false,
      "properties": {
        "cooldown": {
          "type": "number",
@@ -19,13 +20,13 @@
        },
        "items": {
          "type": "array",
+          "title": "Properties",
          "description": "The list of items that can be given to the entity to place in their inventory.",
          "items": {
            "description": "An items that can be given to the entity to place in their inventory.",
            "$ref": "../../../../general/item/identifier.json",
            "title": "Properties"
-          },
-          "title": "Properties"
+          }
        },
        "on_give": { "$ref": "../types/event.json", "description": "Event to fire when the correct item is given.", "title": "On Give" }
      }
--- a/source/behavior/entities/1.8.0/types/trigger.json
+++ b/source/behavior/entities/1.8.0/types/trigger.json
@@ -1,16 +1,21 @@
 {
  "$id": "blockception.minecraft.behavior.entities.type.trigger.1.8.0",
  "title": "Trigger1.8.0",
-  "type": "object",
  "description": "Trigger to fire",
-  "minProperties": 1,
-  "additionalProperties": false,
-  "properties": {
-    "event": { "type": "string", "description": "Event", "title": "Event To Fire" },
-    "filters": {
-      "$ref": "../../filters/filters.json",
-      "description": "The filters to check to determine if the event should be fired"
-    },
-    "target": { "$ref": "../../filters/filters/types/subject.json", "description": "The entity to target", "title": "Target" }
-  }
+  "oneOf": [
+    { "type": "string" },
+    {
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": false,
+      "properties": {
+        "event": { "type": "string", "description": "Event", "title": "Event To Fire" },
+        "filters": {
+          "$ref": "../../filters/filters.json",
+          "description": "The filters to check to determine if the event should be fired"
+        },
+        "target": { "$ref": "../../filters/filters/types/subject.json", "description": "The entity to target", "title": "Target" }
+      }
+    }
+  ]
 }