RevealObjective

Referee: show the players a hidden objective of an active quest.

Full documentation: RevealObjective. Wire type: reveal_objective.

Legal session modes: battle, encounter, exploring, game_over, town, victory

JSON Schema

{
  "description": "Referee: show the players a hidden objective of an active quest.\n\nA hidden objective is absent from the player view until it is revealed or until\nit completes. Completing an objective reveals it, so a quest whose hidden\nobjective is finished before anyone announces it needs no reveal. Ids are the closed domain\n`ActivateQuest` documents.\n\nAn accepted reveal appends the objective's `offer` beat to the journal when its\nauthor wrote one, and the event includes the same line. No\n`JournalEntryAddedEvent` follows,\nbecause the lifecycle event is that beat's event. Referee commands are legal in\nevery mode, terminal modes included.\n\nModes:\n    `town`, `exploring`, `encounter`, `battle`, `game_over`, `victory`\n\nRejections:\n    - `session.command.unknown_quest` - `quest_id` names no quest of the\n      adventure.\n    - `session.command.unknown_objective` - `objective_id` names no objective of\n      that quest.\n    - `session.command.quest_state` - the quest is not active, or the objective\n      is already visible or already complete. The rejection names the quest and\n      the state that refused it.\n\nEvents:\n    `ObjectiveRevealedEvent` with\n    the quest id, the objective id, and the objective's offer beat.",
  "properties": {
    "command_type": {
      "const": "reveal_objective",
      "default": "reveal_objective",
      "title": "Command Type",
      "type": "string",
      "description": "The wire discriminator. Each subclass fixes it to its own snake_case literal, like\n`\"move_party\"` or `\"open_door\"`, so you never set it yourself: constructing the subclass\ndoes. It's what `parse_command` and the\n`AnyCommand` union read to rebuild the right class\nfrom a serialized mapping, and it stays the same across releases."
    },
    "source": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Source",
      "description": "An annotation naming the authored object (a trigger or quest id) or the game\nsystem on whose behalf the command was issued. Execution never reads it: a stamped\ncommand does exactly what the same command unstamped does. It is logged and replayed\nwith the command, so the log alone answers \"why did this happen\". Absent is `None`,\nand the empty string is not a value."
    },
    "quest_id": {
      "minLength": 1,
      "title": "Quest Id",
      "type": "string",
      "description": "Which quest the objective belongs to, by\n`QuestSpec.id`. The quest has to be active already."
    },
    "objective_id": {
      "minLength": 1,
      "title": "Objective Id",
      "type": "string",
      "description": "Which objective to show the players, by\n`ObjectiveSpec.id` within that quest. An objective\nalready visible, or already complete, is refused with `session.command.quest_state`."
    }
  },
  "required": [
    "quest_id",
    "objective_id"
  ],
  "title": "RevealObjective",
  "type": "object"
}