DropItems
Drop items and coins from one member onto the party's cell, or behind a fleeing party.
Full documentation: DropItems. Wire type: drop_items.
Legal session modes: encounter, exploring
JSON Schema
{
"$defs": {
"Coins": {
"description": "A fixed pile of coins, like generated treasure, the contents of a chest, or a pile dropped on the floor.\n\nFrozen, unlike the `CoinPurse` a character carries.\n`generate_treasure` returns its coins in this\nform, and a dungeon feature contains its coins this way until someone picks them up. To\ngive the coins to a character, add each denomination to their purse.",
"properties": {
"pp": {
"default": 0,
"minimum": 0,
"title": "Pp",
"type": "integer",
"description": "Platinum pieces, worth 5 gp each."
},
"gp": {
"default": 0,
"minimum": 0,
"title": "Gp",
"type": "integer",
"description": "Gold pieces."
},
"ep": {
"default": 0,
"minimum": 0,
"title": "Ep",
"type": "integer",
"description": "Electrum pieces, worth half a gold piece each."
},
"sp": {
"default": 0,
"minimum": 0,
"title": "Sp",
"type": "integer",
"description": "Silver pieces, ten to the gold piece."
},
"cp": {
"default": 0,
"minimum": 0,
"title": "Cp",
"type": "integer",
"description": "Copper pieces, a hundred to the gold piece."
}
},
"title": "Coins",
"type": "object"
}
},
"description": "Drop items and coins from one member onto the party's cell, or behind a fleeing party.\n\nIt's legal while exploring a dungeon and during an encounter. Goods dropped on the cell\ngo into its pile, and `TakeTreasure` with\n`feature_id=\"pile\"` picks them back up. While exploring, a drop takes no time.\n\nDuring an encounter, the drop uses up the encounter round, and the monsters then act on\ntheir reaction to the party, as for a `Wait`. While\nmonsters pursue the party after an\n`Evade`, dropped goods scatter behind the party instead of\nlanding in a pile, and can't be picked back up. Dropped coins tempt intelligent pursuers\nand dropped rations tempt unintelligent ones, which can end the pursuit.\n\nModes:\n `exploring`, `encounter`\n\nRejections:\n - `session.command.wrong_mode` - the session is in town or in battle, or has\n ended.\n - `session.command.unknown_member` - `character_id` matches no party member.\n - `session.command.member_incapacitated` - the member can't act.\n - `items.curse.stuck` - a cursed item whose curse has been revealed can't be\n dropped.\n - `exploration.item.not_carried` - the member doesn't carry one of the items, or\n enough of the coins.\n - `encounter.none_active` - a second check behind the mode gate, which normal\n play never reaches.\n\nEvents:\n `ItemsDroppedEvent` with what\n was dropped. In an encounter, the encounter round's events follow. During a pursuit,\n a `PursuitEvent` round follows instead, with\n the drop as bait.",
"properties": {
"command_type": {
"const": "drop_items",
"default": "drop_items",
"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 whose pack and purse the goods leave, by\n`MemberView.id`."
},
"item_ids": {
"default": [],
"items": {
"type": "string"
},
"title": "Item Ids",
"type": "array",
"description": "What to drop, one unit per entry, so repeat an id to drop more than one. Name a mundane\nitem by its catalog id, like `torch` or `rope_hemp`. Name a magic item, a gem, or a piece\nof jewellery by the per-instance id it has in\n`MemberView.inventory`. The session refuses\nthe same magic item, gem, or piece of jewellery named twice with\n`exploration.item.not_carried`, because the whole item leaves with the first entry. A cursed\nitem whose curse has been revealed can't be dropped."
},
"coins": {
"$ref": "#/$defs/Coins",
"default": {
"pp": 0,
"gp": 0,
"ep": 0,
"sp": 0,
"cp": 0
},
"description": "Coins to drop with the items, by denomination. The default drops none. Coins dropped on\nthe cell go into its pile with everything else, and the party can pick them back up with\n`TakeTreasure` naming `\"pile\"`."
}
},
"required": [
"character_id"
],
"title": "DropItems",
"type": "object"
}