EnterDungeon

Travel from town to a dungeon's entrance and start exploring.

Full documentation: EnterDungeon. Wire type: enter_dungeon.

Legal session modes: town

JSON Schema

{
  "description": "Travel from town to a dungeon's entrance and start exploring.\n\nThe party must be in town. Travel takes the adventure's authored cost in\nturns; arrival places the party at the entrance and switches the session to\n`exploring`. Departure also snapshots the party's treasure valuation \u2014 the\nend-of-adventure XP award is the delta against it.\n\nModes:\n    `town`\n\nRejections:\n    - `session.command.wrong_mode` \u2014 the party is not in town.\n    - `session.command.unknown_location` \u2014 `dungeon_id` names no dungeon, or\n      the dungeon has no entrance level.\n\nEvents:\n    [`LocationEnteredEvent`][osrlib.crawl.events.LocationEnteredEvent] for the\n    dungeon, after the travel time's own events. Arrival runs the entrance\n    cell's entry checks (area treasure, room traps, keyed encounters), each\n    reporting its own events.",
  "properties": {
    "command_type": {
      "const": "enter_dungeon",
      "default": "enter_dungeon",
      "title": "Command Type",
      "type": "string"
    },
    "dungeon_id": {
      "title": "Dungeon Id",
      "type": "string"
    }
  },
  "required": [
    "dungeon_id"
  ],
  "title": "EnterDungeon",
  "type": "object"
}