ItemIdentifiedEvent

A magic item gave itself away, and the party now knows what it is.

Full documentation: ItemIdentifiedEvent. Wire type: item_identified.

Default visibility: player

Message codes: items.item.identified

JSON Schema

{
  "$defs": {
    "Visibility": {
      "description": "Who is allowed to see an event.\n\nEvery event has one of these two values, and the split exists because B/X keeps some rolls behind the\nreferee's screen. Filter a log on it before you show anything to a player, or call\n`GameSession.view`, which builds the player's and the referee's\nviews for you. A narrator playing referee reads both.\n\nThe values are the lowercase strings and they serialize into every event, so a renamed value is a\n`schema_version` bump.\n\nExamples:\n    ```python\n    from osrlib.core.events import DamageDealtEvent, HitPointsReportedEvent, Visibility\n\n    log = [\n        DamageDealtEvent(target_id=\"monster-0001\", amount=5),\n        HitPointsReportedEvent(target_id=\"monster-0001\", current_hp=2, max_hp=7),\n    ]\n    shown = [event.code for event in log if event.visibility is Visibility.PLAYER]\n    assert shown == [\"combat.damage.dealt\"]  # the goblin's remaining hit points stay hidden\n    ```",
      "enum": [
        "player",
        "referee"
      ],
      "title": "Visibility",
      "type": "string"
    }
  },
  "description": "A magic item gave itself away, and the party now knows what it is.\n\nEmitted the first time an item is used in a way that reveals it, which happens\ninside `UseItem`,\n`EquipItem`,\n`ResolveBattleRound`, and the\nreferee's `IdentifyItem`.\n\nBefore this, the item's `instance_id` is all any player-visible event named.\nAfter it, the party can be shown the template's name.",
  "properties": {
    "code": {
      "default": "items.item.identified",
      "title": "Code",
      "type": "string",
      "description": "The message code, always `items.item.identified`."
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "player",
      "description": "Player visibility: this is the moment the party learns what it has."
    },
    "event_type": {
      "const": "item_identified",
      "default": "item_identified",
      "title": "Event Type",
      "type": "string",
      "description": "The wire discriminator, `item_identified`."
    },
    "instance_id": {
      "title": "Instance Id",
      "type": "string",
      "description": "The session-scoped id of the item, the same id the earlier events used."
    },
    "template_id": {
      "title": "Template Id",
      "type": "string",
      "description": "What it turned out to be, as its magic item catalog id."
    }
  },
  "required": [
    "instance_id",
    "template_id"
  ],
  "title": "ItemIdentifiedEvent",
  "type": "object"
}