Skip to content

PickLock

Pick a locked door's lock: thief-only, needs thieves' tools, one turn.

Full documentation: PickLock. Wire type: pick_lock.

Legal session modes: exploring

JSON Schema

{
  "$defs": {
    "Direction": {
      "description": "The four grid directions.\n\nThe wire values are lowercase \u2014 they serialize into commands, events, and\nsaves; changing them is a `schema_version` bump.",
      "enum": [
        "north",
        "east",
        "south",
        "west"
      ],
      "title": "Direction",
      "type": "string"
    }
  },
  "description": "Pick a locked door's lock: thief-only, needs thieves' tools, one turn.\n\nThe party must be exploring a dungeon (see\n[`EnterDungeon`][osrlib.crawl.commands.EnterDungeon]). A failed attempt locks\nthat character out of that lock until the next level gain.\n\nModes:\n    `exploring`\n\nRejections:\n    - `session.command.wrong_mode` \u2014 the session is not exploring a dungeon.\n    - `session.command.unknown_member` \u2014 `character_id` names no party member.\n    - `session.command.member_incapacitated` \u2014 the member cannot act.\n    - `exploration.lock.not_a_thief` \u2014 the member has no thief skills.\n    - `exploration.lock.no_tools` \u2014 the member carries no thieves' tools.\n    - `exploration.door.no_door` \u2014 no known door on that side of the cell.\n    - `exploration.lock.not_locked` \u2014 the door has no lock left to pick.\n    - `exploration.action.requires_light` \u2014 picking needs real light;\n      infravision does not suffice.\n    - `exploration.lock.locked_out` \u2014 this character already failed here at\n      their current level.\n\nEvents:\n    [`DetectionRolledEvent`][osrlib.crawl.events.DetectionRolledEvent] with the\n    skill roll and, on success, a [`DoorEvent`][osrlib.crawl.events.DoorEvent]\n    with code `exploration.door.unlocked`. The attempt costs one turn, whose\n    bookkeeping (light burn-down, the rest cadence, wandering checks) reports\n    through its own events.",
  "properties": {
    "command_type": {
      "const": "pick_lock",
      "default": "pick_lock",
      "title": "Command Type",
      "type": "string"
    },
    "direction": {
      "$ref": "#/$defs/Direction"
    },
    "character_id": {
      "title": "Character Id",
      "type": "string"
    }
  },
  "required": [
    "direction",
    "character_id"
  ],
  "title": "PickLock",
  "type": "object"
}