Skip to content

UnequipItem

Take off or put away an equipped item, returning it to the member's pack (takes no game time).

Full documentation: UnequipItem. Wire type: unequip_item.

Legal session modes: exploring, town

JSON Schema

{
  "description": "Take off or put away an equipped item, returning it to the member's pack (takes no game time).\n\nIt's legal in town and while exploring. A cursed item whose curse has been revealed\ncan't be taken off until a *remove curse* lifts the curse, from a caster or from the\ntemple's `PurchaseHealing`.\n\nModes:\n    `town`, `exploring`\n\nRejections:\n    - `session.command.wrong_mode` - an encounter or battle is underway, or the\n      session has ended.\n    - `session.command.unknown_member` - `character_id` matches no party member.\n    - `session.command.member_incapacitated` - the member can't act.\n    - `exploration.item.not_equipped` - the member has nothing by that id equipped.\n    - `items.curse.stuck` - a cursed item whose curse has been revealed can't be\n      taken off.\n\nEvents:\n    Usually none. Taking off a magic item that works while it's worn releases its effects\n    (`EffectReleasedEvent`).",
  "properties": {
    "command_type": {
      "const": "unequip_item",
      "default": "unequip_item",
      "title": "Command Type",
      "type": "string",
      "description": "The name that identifies the command class in serialized data. Each command class fixes\nit to a distinct snake_case string, like `\"move_party\"` or `\"open_door\"`, and constructing\nthe class sets it, so you never pass it yourself.\n`parse_command` and the\n`AnyCommand` union use it to rebuild the right class\nfrom a serialized mapping. A class's value never changes between releases."
    },
    "source": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Source",
      "description": "Who or what issued the command on whose behalf: an authored trigger or quest id, or the\nname of one of your game's systems. The engine never reads it, so a command with a\n`source` does exactly what the same command without one does. The session logs and\nreplays it with the command, so the log alone shows why something happened. Leave it\n`None` when there's nothing to record. An empty string fails validation when the command\nis constructed."
    },
    "character_id": {
      "title": "Character Id",
      "type": "string",
      "description": "The member doing the unequipping, by\n`MemberView.id`."
    },
    "item_id": {
      "title": "Item Id",
      "type": "string",
      "description": "What to take off or put away. Name it the same way as in\n`EquipItem.item_id`. The item has to be equipped\nnow, not in the pack. A cursed item whose curse has been revealed stays equipped until a\n*remove curse* lifts the curse."
    }
  },
  "required": [
    "character_id",
    "item_id"
  ],
  "title": "UnequipItem",
  "type": "object"
}