UseStairs

Take the stair, ladder, or other transition on the party's cell.

Full documentation: UseStairs. Wire type: use_stairs.

Legal session modes: exploring

JSON Schema

{
  "description": "Take the stair, ladder, or other transition on the party's cell.\n\nThe party must be exploring a dungeon (see\n[`EnterDungeon`][osrlib.crawl.commands.EnterDungeon]) and standing on a cell\nwith an authored transition. The move costs one unexplored-cell step of\nmovement.\n\nModes:\n    `exploring`\n\nRejections:\n    - `session.command.wrong_mode` \u2014 the session is not exploring a dungeon.\n    - `exploration.stairs.none` \u2014 no transition on the party's cell.\n\nEvents:\n    [`LocationEnteredEvent`][osrlib.crawl.events.LocationEnteredEvent] when the\n    level or dungeon changes. Arrival then runs the cell's entry checks \u2014 area\n    treasure, room traps, keyed encounters \u2014 each reporting its own events, and\n    the movement cost accrues toward the turn clock.",
  "properties": {
    "command_type": {
      "const": "use_stairs",
      "default": "use_stairs",
      "title": "Command Type",
      "type": "string"
    }
  },
  "title": "UseStairs",
  "type": "object"
}