minecraft-bedrock-json-schemas/source/behavior/entities/format/components/interact.json

{
  "$id": "blockception.minecraft.behavior.entities.minecraft.interact",
  "type": "object",
  "title": "Interact",
  "description": "Defines interactions with this entity.",
  "additionalProperties": false,
  "examples": [{ "interactions": [{}] }],
  "definitions": {
    "interaction_spec": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "add_items": {
          "type": "object",
          "description": "Loot table with items to add to the player's inventory upon successful interaction.",
          "title": "Add Items",
          "additionalProperties": false,
          "properties": {
            "table": {
              "type": "string",
              "$ref": "../../../../general/loot_table/identifier.json",
              "description": "File path, relative to the Behavior Pack's path, to the loot table file.",
              "title": "Table"
            }
          }
        },
        "cooldown": {
          "title": "cooldown",
          "type": "number",
          "default": 0,
          "description": "Time in seconds before this entity can be interacted with again."
        },
        "cooldown_after_being_attacked": {
          "title": "cooldown after being attacked",
          "type": "number",
          "default": 0,
          "description": "Time in seconds before this entity can be interacted with after being attacked."
        },
        "health_amount": {
          "title": "health amount",
          "type": "integer",
          "default": 0,
          "description": "The amount of health this entity will recover or hurt when interacting with this item. Negative values will harm the entity."
        },
        "hurt_item": {
          "title": "hurt item",
          "type": "integer",
          "default": 0,
          "description": "The amount of damage the item will take when used to interact with this entity. A value of 0 means the item won't lose durability."
        },
        "interact_text": {
          "title": "interact text",
          "type": "string",
          "default": "",
          "description": "Text to show when the player is able to interact in this way with this entity when playing with Touch-screen controls."
        },
        "on_interact": {
          "$ref": "../types/trigger.json",
          "description": "Event to fire when the interaction occurs.",
          "title": "On Interact"
        },
        "particle_on_start": {
          "type": "object",
          "description": "Particle effect that will be triggered at the start of the interaction.",
          "title": "Particle On Start",
          "properties": {
            "particle_offset_towards_interactor": {
              "type": "boolean",
              "description": "Whether or not the particle will appear closer to who performed the interaction.",
              "title": "Particle Offset Towards Interactor"
            },
            "particle_type": {
              "type": "string",
              "description": "The type of particle that will be spawned.",
              "title": "Particle Type"
            },
            "particle_y_offset": {
              "type": "number",
              "description": "Will offset the particle this amount in the y direction.",
              "title": "Particle Y Offset"
            }
          }
        },
        "play_sounds": {
          "type": "string",
          "default": "",
          "description": "List of sounds to play when the interaction occurs.",
          "title": "Play Sounds"
        },
        "spawn_entities": {
          "type": "string",
          "default": "",
          "description": "List of entities to spawn when the interaction occurs.",
          "title": "Spawn Entities"
        },
        "spawn_items": {
          "type": "object",
          "description": "Loot table with items to drop on the ground upon successful interaction.",
          "title": "Spawn Items",
          "additionalProperties": false,
          "properties": {
            "table": {
              "type": "string",
              "$ref": "../../../../general/loot_table/identifier.json",
              "description": "File path, relative to the Behavior Pack's path, to the loot table file.",
              "title": "Table"
            }
          }
        },
        "swing": {
          "type": "boolean",
          "default": false,
          "description": "If true, the player will do the `swing` animation when interacting with this entity.",
          "title": "Swing"
        },
        "transform_to_item": {
          "type": "string",
          "title": "Transform To Item",
          "description": "The feed item used will transform to this item upon successful interaction. Format: itemName:auxValue"
        },
        "use_item": {
          "type": "boolean",
          "default": false,
          "description": "If true, the interaction will use an item.",
          "title": "Use Item"
        },
        "vibration": {
          "title": "Vibration",
          "type": "string",
          "description": "Vibration to emit when the interaction occurs. Admitted values are entity_interact (used by default), shear, and none (no vibration emitted)."
        },
        "give_item": {
          "type": "boolean",
          "title": "Give Item",
          "$comment": "UNDOCUMENTED",
          "description": "UNDOCUMENTED Item to give to the player upon successful interaction."
        },
        "take_item": {
          "type": "boolean",
          "title": "Take Item",
          "$comment": "UNDOCUMENTED",
          "description": "UNDOCUMENTED Takes an item from the player"
        }
      }
    }
  },
  "properties": {
    "interactions": {
      "description": "The interactions",
      "title": "Interactions",
      "oneOf": [
        {
          "type": "object",
          "$ref": "#/definitions/interaction_spec"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/definitions/interaction_spec"
          }
        }
      ]
    }
  }
}