Skip to content

TravelToTown

Travel from a dungeon's entrance back to town.

Full documentation: TravelToTown. Wire type: travel_to_town.

Legal session modes: exploring

JSON Schema

{
  "description": "Travel from a dungeon's entrance back to town.\n\nThe party must be exploring and standing on the entrance cell it arrived on. The trip\ntakes as many turns as the trip out, with no wandering-monster checks. The unwedged\ndoors the party opened on the level swing shut behind it. Under the on-return XP\ntiming, the session awards the party's XP for the trip when it arrives in town.\n\nModes:\n    `exploring`\n\nRejections:\n    - `session.command.wrong_mode` - the session is not exploring a dungeon.\n    - `exploration.travel.not_at_entrance` - the party is not on the entrance\n      cell.\n\nEvents:\n    `DoorEvent`s for the doors swinging shut, the\n    events of the travel time passing, then\n    `LocationEnteredEvent` for\n    town. Under the on-return XP timing, an\n    `AdventureXpAwardEvent` and an\n    `XpAwardedEvent` for each living member follow,\n    with a `CharacterLeveledUpEvent` for\n    each member who gains a level.",
  "properties": {
    "command_type": {
      "const": "travel_to_town",
      "default": "travel_to_town",
      "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": "TravelToTown",
  "type": "object"
}