RevealObjective

Referee: surface 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: surface 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 \u2014 completing an objective reveals it, so a quest whose hidden\nobjective simply lands needs no reveal at all. Ids are the closed domain\n[`ActivateQuest`][osrlib.crawl.commands.ActivateQuest] documents.\n\nAn accepted reveal appends the objective's `offer` beat to the journal when its\nauthor wrote one, and the event carries the same line; no\n[`JournalEntryAddedEvent`][osrlib.crawl.events.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` \u2014 `quest_id` names no quest of the\n      adventure.\n    - `session.command.unknown_objective` \u2014 `objective_id` names no objective of\n      that quest.\n    - `session.command.quest_state` \u2014 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`][osrlib.crawl.events.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"
    },
    "source": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Source"
    },
    "quest_id": {
      "minLength": 1,
      "title": "Quest Id",
      "type": "string"
    },
    "objective_id": {
      "minLength": 1,
      "title": "Objective Id",
      "type": "string"
    }
  },
  "required": [
    "quest_id",
    "objective_id"
  ],
  "title": "RevealObjective",
  "type": "object"
}