Skip to content

CompleteObjective

Referee: mark one objective of an active quest done.

Full documentation: CompleteObjective. Wire type: complete_objective.

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

JSON Schema

{
  "description": "Referee: mark one objective of an active quest done.\n\nCompleting surfaces a hidden objective on the way: an objective the party\nfinished before it was ever announced is revealed and complete in one step, with\nno separate [`RevealObjective`][osrlib.crawl.commands.RevealObjective]. Ids are\nthe closed domain [`ActivateQuest`][osrlib.crawl.commands.ActivateQuest]\ndocuments.\n\nCompleting the last objective a quest's completion rule needs does *not*\ncomplete the quest: [`CompleteQuest`][osrlib.crawl.commands.CompleteQuest] is its\nown command, so whoever drives the quest layer decides when the rule is\nsatisfied. An accepted completion appends the objective's `progress` beat to the\njournal when its author wrote one, and the event carries the same line; no\n[`JournalEntryAddedEvent`][osrlib.crawl.events.JournalEntryAddedEvent] follows.\nReferee commands are legal in every 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 complete; the rejection names the quest and the state that\n      refused it.\n\nEvents:\n    [`ObjectiveCompletedEvent`][osrlib.crawl.events.ObjectiveCompletedEvent] with\n    the quest id, the objective id, and the objective's progress beat.",
  "properties": {
    "command_type": {
      "const": "complete_objective",
      "default": "complete_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": "CompleteObjective",
  "type": "object"
}