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 missing from the player view until it's revealed or completed.\nCompleting an objective reveals it, so an objective the party finishes before anyone\nannounces it needs no reveal. The command accepts only the ids the adventure's quest\nspecs define, as `ActivateQuest` describes, and\nthe `ActivateQuest` example shows a quest from start to finish.\n\nWhen the objective's author wrote an `offer` text in its narrative, an accepted reveal\nadds that text to the journal, and the event includes it. No\n`JournalEntryAddedEvent` follows,\nbecause the objective's event already includes the text. This command is legal in\nevery mode, `game_over` and `victory` included.\n\nModes:\n `town`, `exploring`, `encounter`, `battle`, `game_over`, `victory`\n\nRejections:\n - `session.command.unknown_quest` - `quest_id` matches no quest of the\n adventure.\n - `session.command.unknown_objective` - `objective_id` matches no objective of\n that quest.\n - `session.command.quest_state` - the quest isn't active, or the objective\n is already revealed or already complete. The rejection includes the quest\n id and the state that caused the refusal.\n\nEvents:\n `ObjectiveRevealedEvent` with\n the quest id, the objective id, and the objective's offer text.",
"properties": {
"command_type": {
"const": "reveal_objective",
"default": "reveal_objective",
"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."
},
"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. The session\nrefuses an objective that's already revealed or complete with `session.command.quest_state`."
}
},
"required": [
"quest_id",
"objective_id"
],
"title": "RevealObjective",
"type": "object"
}