Skip to content

Wait

Hold for one encounter round, and let the monsters act on their stance.

Full documentation: Wait. Wire type: wait.

Legal session modes: encounter

JSON Schema

{
  "description": "Hold for one encounter round, and let the monsters act on their stance.\n\nAn encounter must be open. The monsters' stance is their reaction to the party:\n`attacks`, `hostile`, `uncertain`, `indifferent`, or `friendly`. Waiting spends a round\nto see what the monsters do. Monsters whose stance is `uncertain` roll a new reaction,\nand `hostile` monsters attack once their patience runs out. During a pursuit after an\n`Evade`, waiting runs one round of the pursuit instead.\n\nModes:\n    `encounter`\n\nRejections:\n    - `session.command.wrong_mode` - no encounter is open.\n    - `encounter.none_active` - a second check behind the mode gate, which normal\n      play never reaches.\n\nEvents:\n    The encounter round's events. Monsters whose stance is `uncertain` roll a new\n    reaction (`ReactionRolledEvent`, and a\n    `StanceChangedEvent` when it changes).\n    Battle opens when the monsters attack, or when `hostile` monsters run out of\n    patience (`BattleStartedEvent`). During a\n    pursuit, a `PursuitEvent` round runs\n    instead, which can end in an\n    `ExhaustionEvent` at the round limit\n    (with an `EffectAttachedEvent`\n    and a `ConditionGainedEvent` for the\n    exhaustion) or in battle.\n\n    When the encounter ends, the session emits\n    `EncounterEndedEvent`, a\n    `MonsterDefeatedEvent` for each\n    monster killed or driven off, a\n    `LootDroppedEvent` when the slain leave\n    anything on the floor,\n    `EffectReleasedEvent`s, and, under\n    the immediate XP timing,\n    `XpAwardedEvent` and\n    `CharacterLeveledUpEvent`.\n    The round also brings the usual\n    `EffectExpiredEvent`,\n    `LightEvent`, and\n    `ProvisionsEvent` events for the time that\n    passes.",
  "properties": {
    "command_type": {
      "const": "wait",
      "default": "wait",
      "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": "Wait",
  "type": "object"
}