Skip to content

ItemIdentifiedEvent

A magic item identified — a first meaningful use of it is the trigger.

Full documentation: ItemIdentifiedEvent. Wire type: item_identified.

Default visibility: player

Message codes: items.item.identified

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": "A magic item identified \u2014 a first meaningful use of it is the trigger.",
  "properties": {
    "code": {
      "default": "items.item.identified",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "player"
    },
    "event_type": {
      "const": "item_identified",
      "default": "item_identified",
      "title": "Event Type",
      "type": "string"
    },
    "instance_id": {
      "title": "Instance Id",
      "type": "string"
    },
    "template_id": {
      "title": "Template Id",
      "type": "string"
    }
  },
  "required": [
    "instance_id",
    "template_id"
  ],
  "title": "ItemIdentifiedEvent",
  "type": "object"
}