Skip to content

PickLock

Pick the lock of a locked door with a thief's skill and thieves' tools (one turn).

Full documentation: PickLock. Wire type: pick_lock.

Legal session modes: exploring

JSON Schema

{
  "$defs": {
    "Direction": {
      "description": "The four grid directions the party faces and moves in.\n\nYou use these for the way `MoveParty` steps, the side of a\ncell `OpenDoor` works on, and the way a transition turns the\nparty on arrival. There is no up or down. A\n`TransitionSpec` moves the party between levels.\n\nThe values are lowercase strings, like `\"north\"`, and they appear in commands, events, and saves.",
      "enum": [
        "north",
        "east",
        "south",
        "west"
      ],
      "title": "Direction",
      "type": "string"
    }
  },
  "description": "Pick the lock of a locked door with a thief's skill and thieves' tools (one turn).\n\nThe party must be exploring a dungeon (see\n`EnterDungeon`). Only a member with thief\nskills can pick a lock. That member needs thieves' tools in their pack and light,\nand infravision isn't enough. A member who fails can't try that lock again until they\ngain a level. A picked door is unlocked but still closed, so follow with\n`OpenDoor`.\n\nModes:\n    `exploring`\n\nRejections:\n    - `session.command.wrong_mode` - the session is not exploring a dungeon.\n    - `session.command.unknown_member` - `character_id` matches no party member.\n    - `session.command.member_incapacitated` - the member cannot act.\n    - `exploration.lock.not_a_thief` - the member has no thief skills.\n    - `exploration.lock.no_tools` - the member carries no thieves' tools.\n    - `exploration.door.no_door` - no known door on that side of the cell.\n    - `exploration.lock.not_locked` - the door has no lock left to pick.\n    - `exploration.action.requires_light` - the party has no light. Infravision\n      isn't enough to pick a lock.\n    - `exploration.lock.locked_out` - this member already failed at this lock at\n      their current level.\n\nEvents:\n    `DetectionRolledEvent` with the\n    skill roll and, on success, a `DoorEvent`\n    with code `exploration.door.unlocked`. The attempt costs one turn, and the events of\n    that turn follow: light burning down, the fatigue rule, and the wandering-monster\n    check, each with its usual events.",
  "properties": {
    "command_type": {
      "const": "pick_lock",
      "default": "pick_lock",
      "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."
    },
    "direction": {
      "$ref": "#/$defs/Direction",
      "description": "Which side of the party's cell the locked door is on, from the `door` edges in\n`ExploredLevelView.edges`. The session refuses a door\nthat isn't locked with `exploration.lock.not_locked`."
    },
    "character_id": {
      "title": "Character Id",
      "type": "string",
      "description": "The thief who picks, by `MemberView.id`. The member\nneeds thief skills and thieves' tools in their pack. A member who fails can't try that lock\nagain until they gain a level, so send the best lock picker first."
    }
  },
  "required": [
    "direction",
    "character_id"
  ],
  "title": "PickLock",
  "type": "object"
}