Skip to content

ItemConsumedEvent

One carried item was used up — a gate's toll paid, a spike driven home.

Full documentation: ItemConsumedEvent. Wire type: item_consumed.

Default visibility: player

Message codes: exploration.item.consumed

JSON Schema

{
  "$defs": {
    "Visibility": {
      "description": "Who may see an event.\n\nThe wire values are `\"player\"` and `\"referee\"` \u2014 lowercase, serialized into every\nevent; changing them is a `schema_version` bump.",
      "enum": [
        "player",
        "referee"
      ],
      "title": "Visibility",
      "type": "string"
    }
  },
  "description": "One carried item was used up \u2014 a gate's toll paid, a spike driven home.\n\n`item_id` follows the acquisition masking rule: a mundane consumption carries\nthe catalog id, a magic one the instance's session-scoped `instance_id`, never\nits `template_id` \u2014 an unidentified item's true identity never rides a\nplayer-visible event.",
  "properties": {
    "code": {
      "default": "exploration.item.consumed",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "player"
    },
    "event_type": {
      "const": "item_consumed",
      "default": "item_consumed",
      "title": "Event Type",
      "type": "string"
    },
    "character_id": {
      "title": "Character Id",
      "type": "string"
    },
    "item_id": {
      "title": "Item Id",
      "type": "string"
    }
  },
  "required": [
    "character_id",
    "item_id"
  ],
  "title": "ItemConsumedEvent",
  "type": "object"
}