Skip to content

QuestCompletedEvent

A quest is finished, however the ruling was reached.

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.\n\nThe wire values are `\"player\"` and `\"referee\"` \u2014 lowercase, serialized into every\nevent; changing them is a `schema_version` bump.",
      "enum": [
        "player",
        "referee"
      ],
      "title": "Visibility",
      "type": "string"
    }
  },
  "description": "A quest is finished, however the ruling was reached.\n\n`narrative` is the quest's authored completion beat, `None` when unauthored, and\nthe journal carries the same line. Rewards, when the quest pays any, land as\ntheir own commands and their own events after this one.",
  "properties": {
    "code": {
      "default": "session.quest.completed",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "player"
    },
    "event_type": {
      "const": "quest_completed",
      "default": "quest_completed",
      "title": "Event Type",
      "type": "string"
    },
    "quest_id": {
      "title": "Quest Id",
      "type": "string"
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "narrative": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Narrative"
    }
  },
  "required": [
    "quest_id",
    "name"
  ],
  "title": "QuestCompletedEvent",
  "type": "object"
}