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    - `exploration.transition.gate_refused` \u2014 the transition carries an\n      authored condition ([`GateSpec`][osrlib.crawl.gates.GateSpec]) the party\n      does not satisfy; the refusal carries the author's own text, and costs no\n      movement, no time, and no toll.\n\nEvents:\n    [`ItemConsumedEvent`][osrlib.crawl.events.ItemConsumedEvent] first when the\n    gate's condition consumes what it asks for \u2014 the toll is paid at the\n    threshold \u2014 then\n    [`LocationEnteredEvent`][osrlib.crawl.events.LocationEnteredEvent] when the\n    level or dungeon changes, carrying the gate's success text when its author\n    wrote one. Arrival then runs the cell's entry checks \u2014 area treasure, room\n    traps, keyed encounters \u2014 each reporting its own events, and the movement\n    cost accrues toward the turn clock.",
  "properties": {
    "command_type": {
      "const": "use_stairs",
      "default": "use_stairs",
      "title": "Command Type",
      "type": "string"
    },
    "source": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Source"
    }
  },
  "title": "UseStairs",
  "type": "object"
}