Skip to content

TurnParty

Turn the party in place to a new facing (zero time).

Full documentation: TurnParty. Wire type: turn_party.

Legal session modes: exploring

JSON Schema

{
  "$defs": {
    "Direction": {
      "description": "The four grid directions.\n\nThe wire values are lowercase \u2014 they serialize into commands, events, and\nsaves; changing them is a `schema_version` bump.",
      "enum": [
        "north",
        "east",
        "south",
        "west"
      ],
      "title": "Direction",
      "type": "string"
    }
  },
  "description": "Turn the party in place to a new facing (zero time).\n\nThe party must already be inside a dungeon \u2014 see\n[`EnterDungeon`][osrlib.crawl.commands.EnterDungeon].\n\nModes:\n    `exploring`\n\nRejections:\n    - `session.command.wrong_mode` \u2014 the session is not exploring a dungeon.\n\nEvents:\n    [`PartyMovedEvent`][osrlib.crawl.events.PartyMovedEvent] with the unchanged\n    position and the new facing.",
  "properties": {
    "command_type": {
      "const": "turn_party",
      "default": "turn_party",
      "title": "Command Type",
      "type": "string"
    },
    "facing": {
      "$ref": "#/$defs/Direction"
    }
  },
  "required": [
    "facing"
  ],
  "title": "TurnParty",
  "type": "object"
}