Skip to content

UseStairs

Take the stairs, trapdoor, chute, or other transition on the party's cell.

Full documentation: UseStairs. Wire type: use_stairs.

Legal session modes: exploring

JSON Schema

{
  "description": "Take the stairs, trapdoor, chute, or other transition on the party's cell.\n\nThe party must be exploring a dungeon (see\n`EnterDungeon`) and standing on a cell\nwith an authored transition, a `TransitionSpec`.\nThe move uses as much movement as a step onto an unexplored cell. A passage doesn't\ncount, because the party walks through a passage with\n`MoveParty`. On a cell with both a passage and\nstairs, this command takes the stairs.\n\nModes:\n    `exploring`\n\nRejections:\n    - `session.command.wrong_mode` - the session is not exploring a dungeon.\n    - `exploration.stairs.none` - the party's cell has no transition other than a\n      passage.\n    - `exploration.transition.gate_refused` - the transition has an\n      authored condition (`GateSpec`) the party\n      doesn't meet. The rejection includes the gate's authored refusal text. Like every\n      refusal, it costs no movement, no time, and no toll.\n\nEvents:\n    `ItemConsumedEvent` first when\n    the gate takes an item as a toll, then\n    `LocationEnteredEvent` when the\n    level or dungeon changes, with the gate's success text when its author\n    wrote one. That arrival event records how the party crossed: `via` is the\n    transition's `kind`, and `transition_ref` is the cell the transition stands\n    on, which is the cell the party left. Leaving a level shuts the unwedged doors the\n    party opened on it, with a `DoorEvent` for each.\n\n    The session then runs the destination cell's entry checks, the same ones as for\n    `MoveParty`: a\n    `HoardGeneratedEvent` for area\n    treasure, a\n    `DetectionRolledEvent` and a\n    `TrapEvent` for a room trap with its\n    resolution, and the opening of an encounter with monsters keyed to that area in the adventure\n    (`SurpriseRolledEvent`s,\n    `EncounterStartedEvent`,\n    `ReactionRolledEvent`,\n    `StanceChangedEvent`, and\n    `BattleStartedEvent` when the monsters\n    attack). When the movement completes a turn on the game clock, the events of that\n    turn follow, as they do for a step.",
  "properties": {
    "command_type": {
      "const": "use_stairs",
      "default": "use_stairs",
      "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."
    }
  },
  "title": "UseStairs",
  "type": "object"
}