MoveParty
Move the party one cell, turning to face the way it goes.
Full documentation: MoveParty. Wire type: move_party.
Legal session modes: exploring
JSON Schema
{
"$defs": {
"Direction": {
"description": "The four grid directions the party faces and moves in.\n\nYou use these for the way `MoveParty` steps, the side of a\ncell `OpenDoor` works on, and the way a transition turns the\nparty on arrival. There is no up or down. A\n`TransitionSpec` moves the party between levels.\n\nThe values are lowercase strings, like `\"north\"`, and they appear in commands, events, and saves.",
"enum": [
"north",
"east",
"south",
"west"
],
"title": "Direction",
"type": "string"
}
},
"description": "Move the party one cell, turning to face the way it goes.\n\nThe party must already be in a dungeon. A new session starts in town, and\n`EnterDungeon` places the party at the entrance\nand switches the session to `exploring`. A step onto a cell the party hasn't explored\nuses 10 feet of the party's movement, and a step onto an explored cell uses a third of\nthat. Each time the movement adds up to the party's exploration rate, one turn passes on\nthe game clock.\n\nA passage is a `TransitionSpec` whose `kind` is\n`\"passage\"`, standing on one side of a cell. A move toward that side crosses the passage\ninstead of stopping at the wall there. The party arrives at the passage's destination,\nfacing its `to_facing`, and the move costs what a step onto that destination cell costs.\n\nModes:\n `exploring`\n\nRejections:\n - `session.command.wrong_mode` - the session is not exploring a dungeon.\n - `exploration.move.cannot_move` - the party cannot move: it is overloaded,\n or a living member is unable to walk.\n - `exploration.move.blocked` - a wall, a closed door, an undiscovered secret\n door, or the edge of the map is on that side, and no passage stands there.\n - `exploration.transition.gate_refused` - the move would cross a passage\n whose authored condition (`GateSpec`) the\n party doesn't meet. The rejection includes the gate's authored refusal text.\n Like every refusal, it costs no movement, no time, and no toll.\n\nEvents:\n `PartyMovedEvent` with the new position\n and facing. Arriving in the new cell can set off more, each with a\n separate event. A `LocationEnteredEvent`\n follows when the party crosses into a new area, level, or dungeon. A\n `DoorEvent` follows for each unwedged door the party\n opened that swings shut behind it. The area's treasure roll arrives as a\n `HoardGeneratedEvent`. A room\n trap's spring check produces a\n `DetectionRolledEvent` and a\n `TrapEvent`, and a trap that springs\n resolves at once.\n\n A pool of burning oil or a *web* on the cell affects the party as it arrives\n (`DamageDealtEvent`,\n `HitPointsReportedEvent`,\n `DeathEvent`,\n `EffectAttachedEvent`,\n `ConditionGainedEvent`). Monsters keyed to\n the area in the adventure (a keyed encounter) meet the party the first time it enters,\n with `SurpriseRolledEvent`s,\n `EncounterStartedEvent`,\n `ReactionRolledEvent`, and\n `StanceChangedEvent`. When their reaction is\n to attack, battle opens at once\n (`BattleStartedEvent`).\n\n A move through a passage reports the crossing before the step, as\n `UseStairs` does. An\n `ItemConsumedEvent` comes first when\n the passage's gate takes an item as a toll. A `LocationEnteredEvent` follows when the\n level or dungeon changes, with `via` set to `\"passage\"` and `transition_ref`\n set to the passage's cell. Then come the `DoorEvent`s for the doors that swing shut\n on the level the party left, the `PartyMovedEvent` for the landing cell, and the\n landing cell's events.\n\n When the step's movement completes a turn on the game clock, the events of that turn\n follow:\n `EffectExpiredEvent` with a\n `LightEvent` for a light burning out,\n `FatigueEvent` when the fatigue penalty starts or ends,\n `ProvisionsEvent` on a day boundary,\n and `WanderingCheckEvent` when a\n wandering-monster check is due.",
"properties": {
"command_type": {
"const": "move_party",
"default": "move_party",
"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."
},
"direction": {
"$ref": "#/$defs/Direction",
"description": "Which way to step. The party turns to face that way as it goes, so a move is also a turn.\nTo change facing without moving, use `TurnParty`. A\ndirection with a wall, a closed door, an undiscovered secret door, or the edge of the map\non that side of the party's cell gets the refusal `exploration.move.blocked`, unless a\npassage stands on that side. Read\n`ExploredLevelView.edges` to find which sides\nof the cell the party can leave by."
}
},
"required": [
"direction"
],
"title": "MoveParty",
"type": "object"
}