Skip to content

DropItems

Drop items and coins onto the party's cell (or the pursuit trail).

Full documentation: DropItems. Wire type: drop_items.

Legal session modes: encounter, exploring

JSON Schema

{
  "$defs": {
    "Coins": {
      "description": "A frozen coin bundle: generated treasure, cache contents, dropped piles.",
      "properties": {
        "pp": {
          "default": 0,
          "minimum": 0,
          "title": "Pp",
          "type": "integer"
        },
        "gp": {
          "default": 0,
          "minimum": 0,
          "title": "Gp",
          "type": "integer"
        },
        "ep": {
          "default": 0,
          "minimum": 0,
          "title": "Ep",
          "type": "integer"
        },
        "sp": {
          "default": 0,
          "minimum": 0,
          "title": "Sp",
          "type": "integer"
        },
        "cp": {
          "default": 0,
          "minimum": 0,
          "title": "Cp",
          "type": "integer"
        }
      },
      "title": "Coins",
      "type": "object"
    }
  },
  "description": "Drop items and coins onto the party's cell (or the pursuit trail).\n\nEach `item_ids` entry drops one unit (repeat an id for more). Legal while\nexploring a dungeon and during an encounter \u2014 dropping treasure or food is the\npursuit-distraction move.\n\nModes:\n    `exploring`, `encounter`\n\nRejections:\n    - `session.command.wrong_mode` \u2014 the session is in town, in battle, or\n      over.\n    - `session.command.unknown_member` \u2014 `character_id` names no party member.\n    - `session.command.member_incapacitated` \u2014 the member cannot act.\n    - `items.curse.stuck` \u2014 a revealed cursed item cannot be discarded.\n    - `exploration.item.not_carried` \u2014 the member lacks an item or the coins.\n    - `encounter.none_active` \u2014 defensive twin of the mode gate; not reachable\n      through normal play.\n\nEvents:\n    [`ItemsDroppedEvent`][osrlib.crawl.events.ItemsDroppedEvent] with what\n    fell. In an encounter the round then closes \u2014 the monsters act per their\n    stance \u2014 or, mid-pursuit, a\n    [`PursuitEvent`][osrlib.crawl.events.PursuitEvent] round resolves with the\n    drop as bait.",
  "properties": {
    "command_type": {
      "const": "drop_items",
      "default": "drop_items",
      "title": "Command Type",
      "type": "string"
    },
    "character_id": {
      "title": "Character Id",
      "type": "string"
    },
    "item_ids": {
      "default": [],
      "items": {
        "type": "string"
      },
      "title": "Item Ids",
      "type": "array"
    },
    "coins": {
      "$ref": "#/$defs/Coins",
      "default": {
        "pp": 0,
        "gp": 0,
        "ep": 0,
        "sp": 0,
        "cp": 0
      }
    }
  },
  "required": [
    "character_id"
  ],
  "title": "DropItems",
  "type": "object"
}