QuestCompletedEvent
A quest is finished.
Full documentation: QuestCompletedEvent. Wire type: quest_completed.
Default visibility: player
Message codes: session.quest.completed
JSON Schema
{
"$defs": {
"Visibility": {
"description": "Who may see an event: the players, or only the referee.\n\nEvery event has one of these values, because in B/X the referee makes some rolls behind a screen. Filter\na log on it before you show anything to a player, or call\n`GameSession.view`, which builds the players' view and the referee's\nview for you. A narrator that plays the referee reads every event.\n\nA serialized event contains the lowercase value. The values stay fixed within a `schema_version`, the version\nstamp of the saved format.\n\nExamples:\n ```python\n from osrlib.core.events import DamageDealtEvent, HitPointsReportedEvent, Visibility\n\n log = [\n DamageDealtEvent(target_id=\"monster-0001\", amount=5),\n HitPointsReportedEvent(target_id=\"monster-0001\", current_hp=2, max_hp=7),\n ]\n shown = [event.code for event in log if event.visibility is Visibility.PLAYER]\n assert shown == [\"combat.damage.dealt\"] # the goblin's remaining hit points stay hidden\n ```",
"enum": [
"player",
"referee"
],
"title": "Visibility",
"type": "string"
}
},
"description": "A quest is finished.\n\nEmitted by `CompleteQuest`. Whether the\nquest is done is the referee's ruling: the engine checks that the quest is\nactive, not that every objective was completed.\n\nA quest's rewards arrive after this event, as the events of the commands that pay\nthem. When the quest concludes the adventure, an\n`AdventureCompletedEvent` follows\nin the same result.",
"properties": {
"code": {
"default": "session.quest.completed",
"title": "Code",
"type": "string",
"description": "The message code, always `session.quest.completed`."
},
"visibility": {
"$ref": "#/$defs/Visibility",
"default": "player",
"description": "Player visibility: the party learns the quest is done."
},
"event_type": {
"const": "quest_completed",
"default": "quest_completed",
"title": "Event Type",
"type": "string",
"description": "The event type, `quest_completed`, which identifies this class in serialized form."
},
"quest_id": {
"title": "Quest Id",
"type": "string",
"description": "Which quest was completed."
},
"name": {
"title": "Name",
"type": "string",
"description": "The quest's display name."
},
"narrative": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Narrative",
"description": "The completion text the author wrote, or `None`. The journal has the same line."
}
},
"required": [
"quest_id",
"name"
],
"title": "QuestCompletedEvent",
"type": "object"
}