Skip to content

QuestActivatedEvent

An authored quest came into play — the table's news, not the wiring behind it.

Full documentation: QuestActivatedEvent. Wire type: quest_activated.

Default visibility: player

Message codes: session.quest.activated

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": "An authored quest came into play \u2014 the table's news, not the wiring behind it.\n\nPlayer-visible: a quest the party has taken on is theirs to know, while the\nclause that started it stays behind the screen with the trigger and flag events.\n`narrative` is the quest's authored offer beat, `None` when unauthored \u2014 content\ndata in a structured field, not engine-baked English, appended verbatim by the\ndefault formatter after the templated line. The same beat is appended to the\njournal, so this event and its entry are one report of one moment.",
  "properties": {
    "code": {
      "default": "session.quest.activated",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "player"
    },
    "event_type": {
      "const": "quest_activated",
      "default": "quest_activated",
      "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": "QuestActivatedEvent",
  "type": "object"
}