Add item_descriptor and use it in acceptable places (#115)

* Add item_descriptor and use it in acceptable places * Rename descriptor * Fix refs * Fix refs * Add descriptor to 3 more components
2022-10-01 19:34:08 +02:00
parent 393e7191dd
commit dcd9877aa7
15 changed files with 74 additions and 30 deletions
--- a/source/behavior/entities/format/behaviors/avoid_block.json
+++ b/source/behavior/entities/format/behaviors/avoid_block.json
@@ -37,7 +37,7 @@
      "type": "array",
      "title": "Target Blocks",
      "description": "List of block types this mob avoids.",
-      "items": { "title": "Block ID", "$ref": "../../../../general/block/identifier.json" }
+      "items": { "title": "Block ID", "$ref": "../../../../general/item/descriptor.json" }
    },
    "avoid_block_sound": {
      "type": "string",
--- a/source/behavior/entities/format/behaviors/beg.json
+++ b/source/behavior/entities/format/behaviors/beg.json
@@ -16,7 +16,7 @@
        "type": "string",
        "description": "List of items that this mob likes.",
        "title": "Properties",
-        "$ref": "../../../../general/item/identifier.json"
+        "$ref": "../../../../general/item/descriptor.json"
      },
      "title": "Properties"
    },
--- a/source/behavior/entities/format/behaviors/charge_held_item.json
+++ b/source/behavior/entities/format/behaviors/charge_held_item.json
@@ -14,7 +14,7 @@
      "title": "Items",
      "description": "The list of items that can be used to charge the held item. This list is required and must have at least one item in it.",
      "items": {
-        "type": "string",
+        "$ref": "../../../../general/item/descriptor.json",
        "description": "Items names to be used.",
        "title": "Item ID"
      }
--- a/source/behavior/entities/format/behaviors/jump_to_block.json
+++ b/source/behavior/entities/format/behaviors/jump_to_block.json
@@ -20,7 +20,7 @@
      "type": "array",
      "description": "Blocks that the mob can't jump to.",
      "items": {
-        "$ref": "../../../../general/block/identifier.json"
+        "$ref": "../../../../general/item/descriptor.json"
      }
    },
    "max_velocity": {
@@ -46,7 +46,7 @@
      "type": "array",
      "description": "Blocks that the mob prefers jumping to.",
      "items": {
-        "$ref": "../../../../general/block/identifier.json"
+        "$ref": "../../../../general/item/descriptor.json"
      }
    },
    "preferred_blocks_chance": {
--- a/source/behavior/entities/format/behaviors/lay_egg.json
+++ b/source/behavior/entities/format/behaviors/lay_egg.json
@@ -17,7 +17,7 @@
    },
    "egg_type": {
      "title": "Egg Type",
-      "type": "string",
+      "$ref": "../../../../general/item/descriptor.json",
      "default": "minecraft:turtle_egg",
      "description": "[EXPERIMENTAL] Block type for the egg to lay. If this is a turtle egg, the number of eggs in the block is randomly set."
    },
@@ -60,6 +60,7 @@
      "title": "Target Blocks",
      "type": "array",
      "default": ["minecraft:sand"],
+      "items": { "title": "Block ID", "$ref": "../../../../general/item/descriptor.json" },
      "description": "[EXPERIMENTAL] Blocks that the mob can lay its eggs on top of."
    },
    "target_materials_above_block": {
--- a/source/behavior/entities/format/behaviors/move_to_block.json
+++ b/source/behavior/entities/format/behaviors/move_to_block.json
@@ -53,7 +53,7 @@
      "type": "string",
      "default": "nearest",
      "description": "Kind of block to find fitting the specification. Valid values are \"random\" and \"nearest\".",
-      "enum": ["random","nearest"]
+      "enum": ["random", "nearest"]
    },
    "target_offset": {
      "title": "Target Offset",
@@ -71,8 +71,7 @@
      "title": "Target Blocks",
      "description": "Block types to move to.",
      "items": {
-        "$ref": "../../../../general/block/identifier.json",
-        "type": "string"
+        "$ref": "../../../../general/item/descriptor.json"
      }
    },
    "target_block_filters": {
--- a/source/behavior/entities/format/behaviors/pickup_items.json
+++ b/source/behavior/entities/format/behaviors/pickup_items.json
@@ -31,7 +31,7 @@
      "type": "array",
      "items": {
        "title": "Excluded Item",
-        "$ref": "../../../../general/item/identifier.json"
+        "$ref": "../../../../general/item/descriptor.json"
      }
    },
    "goal_radius": {
--- a/source/behavior/entities/format/behaviors/raid_garden.json
+++ b/source/behavior/entities/format/behaviors/raid_garden.json
@@ -16,7 +16,7 @@
        "type": "string",
        "title": "Block Id",
        "description": "A block identifier.",
-        "$ref": "../../../../general/block/identifier.json"
+        "$ref": "../../../../general/item/descriptor.json"
      }
    },
    "eat_delay": {
--- a/source/behavior/entities/format/behaviors/snacking.json
+++ b/source/behavior/entities/format/behaviors/snacking.json
@@ -16,12 +16,12 @@
        {
          "type": "array",
          "items": {
-            "$ref": "../../../../general/item/identifier.json",
+            "$ref": "../../../../general/item/descriptor.json",
            "title": "Item"
          }
        },
        {
-          "$ref": "../../../../general/item/identifier.json"
+          "$ref": "../../../../general/item/descriptor.json"
        }
      ]
    },
--- a/source/behavior/entities/format/behaviors/tempt.json
+++ b/source/behavior/entities/format/behaviors/tempt.json
@@ -30,7 +30,7 @@
      "title": "Items",
      "description": "List of items this mob is tempted by.",
      "items": {
-        "$ref": "../../../../general/item/identifier.json"
+        "$ref": "../../../../general/item/descriptor.json"
      }
    },
    "sound_interval": {
--- a/source/behavior/entities/format/components/ageable.json
+++ b/source/behavior/entities/format/components/ageable.json
@@ -33,21 +33,22 @@
        {
          "type": "array",
          "items": {
-            "$ref": "../../../../general/item/identifier.json"
-          }
-        },
-        {
-          "type": "array",
-          "items": {
-            "type": "object",
-            "properties": {
-              "growth": {
-                "type": "number"
-              },
-              "item": {
+            "oneOf": [
+              {
                "$ref": "../../../../general/item/identifier.json"
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "growth": {
+                    "type": "number"
+                  },
+                  "item": {
+                    "$ref": "../../../../general/item/identifier.json"
+                  }
+                }
              }
-            }
+            ]
          }
        },
        {
--- a/source/behavior/entities/format/components/bribeable.json
+++ b/source/behavior/entities/format/components/bribeable.json
@@ -17,7 +17,7 @@
      "description": "The list of items that can be used to bribe the entity.",
      "items": {
        "description": "An item that can be used to bribe the entity.",
-        "$ref": "../../../../general/item/identifier.json",
+        "$ref": "../../../../general/item/descriptor.json",
        "title": "Bribe Items"
      },
      "title": "Bribe Items"
--- a/source/behavior/entities/format/components/equippable.json
+++ b/source/behavior/entities/format/components/equippable.json
@@ -27,7 +27,7 @@
            "items": {
              "type": "string",
              "description": "A item name.",
-              "$ref": "../../../../general/item/identifier.json",
+              "$ref": "../../../../general/item/descriptor.json",
              "title": "Accepted Items"
            }
          },
--- a/source/behavior/entities/format/components/giveable.json
+++ b/source/behavior/entities/format/components/giveable.json
@@ -23,7 +23,7 @@
          "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",
+            "$ref": "../../../../general/item/descriptor.json",
            "title": "Properties"
          }
        },
--- a/source/general/item/descriptor.json
+++ b/source/general/item/descriptor.json
@@ -0,0 +1,43 @@
+{
+  "$id": "blockception.minecraft.item.descriptor",
+  "oneOf": [
+    {
+      "$ref": "./identifier.json"
+    },
+    {
+      "$ref": "#/definitions/object_item_descriptor"
+    },
+    {
+      "type": "object",
+      "properties": {
+        "item": {
+          "oneOf": [
+            {
+              "$ref": "./identifier.json"
+            },
+            {
+              "$ref": "#/definitions/object_item_descriptor"
+            }
+          ]
+        }
+      }
+    }
+  ],
+  "definitions": {
+    "object_item_descriptor": {
+      "type": "object",
+      "properties": {
+        "tags": {
+          "type": "string",
+          "description": "[UNDOCUMENTED] A Molang expression ran against item or block to match.",
+          "examples": ["query.any_tag('minecraft:is_tool')"]
+        },
+        "item_tag": {
+          "type": "string",
+          "description": "[UNDOCUMENTED] A tag to lookup item or block by.",
+          "examples": ["minecraft:is_tool"]
+        }
+      }
+    }
+  }
+}