Skip to content

IdentifyItem

Referee: identify a magic item outright — game-driven identification.

Full documentation: IdentifyItem. Wire type: identify_item.

Legal session modes: battle, encounter, exploring, game_over, town

JSON Schema

{
  "description": "Referee: identify a magic item outright \u2014 game-driven identification.\n\nReferee commands are legal in every mode and are logged and replayed like any\nother.\n\nModes:\n    `town`, `exploring`, `encounter`, `battle`, `game_over`\n\nRejections:\n    - `session.command.unknown_member` \u2014 `character_id` names no party member.\n    - `session.command.unknown_item` \u2014 the member carries no magic item with\n      that instance id.\n\nEvents:\n    [`ItemIdentifiedEvent`][osrlib.crawl.events.ItemIdentifiedEvent]; a cursed\n    item also reveals with a\n    [`CurseRevealedEvent`][osrlib.crawl.events.CurseRevealedEvent].",
  "properties": {
    "command_type": {
      "const": "identify_item",
      "default": "identify_item",
      "title": "Command Type",
      "type": "string"
    },
    "character_id": {
      "title": "Character Id",
      "type": "string"
    },
    "item_id": {
      "title": "Item Id",
      "type": "string"
    }
  },
  "required": [
    "character_id",
    "item_id"
  ],
  "title": "IdentifyItem",
  "type": "object"
}