Skip to content

UnequipItem

Return an equipped item to the member's item list (zero time).

Full documentation: UnequipItem. Wire type: unequip_item.

Legal session modes: exploring, town

JSON Schema

{
  "description": "Return an equipped item to the member's item list (zero time).\n\nLegal in town and while exploring. A revealed cursed item stays put until\n*remove curse*.\n\nModes:\n    `town`, `exploring`\n\nRejections:\n    - `session.command.wrong_mode` \u2014 an encounter or battle is underway, or the\n      game is over.\n    - `session.command.unknown_member` \u2014 `character_id` names no party member.\n    - `session.command.member_incapacitated` \u2014 the member cannot act.\n    - `exploration.item.not_equipped` \u2014 nothing by that id is equipped.\n    - `items.curse.stuck` \u2014 a revealed cursed item cannot be removed.\n\nEvents:\n    Usually none; a worn magic item's effects release\n    ([`EffectReleasedEvent`][osrlib.core.events.EffectReleasedEvent]).",
  "properties": {
    "command_type": {
      "const": "unequip_item",
      "default": "unequip_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": "UnequipItem",
  "type": "object"
}