Skip to content

TriggerFiredEvent

An authored trigger fired (referee — trigger wiring is the game's secret).

Full documentation: TriggerFiredEvent. Wire type: trigger_fired.

Default visibility: referee

Message codes: session.trigger.fired

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 trigger fired (referee \u2014 trigger wiring is the game's secret).\n\nEmitted for every [`MarkTriggerFired`][osrlib.crawl.commands.MarkTriggerFired],\na mark of an already-fired trigger included: session state records that a\ntrigger has fired, and these events record each firing.\n\n`narrative` is the trigger's authored beat for the firing \u2014 content data in a\nstructured field, not engine-baked English: the event still carries its message\ncode and its facts, and the default formatter appends the line verbatim after\nthe templated one. It rides a referee-visibility event because trigger wiring is\nthe game's secret; a beat written for the table is a journal entry.",
  "properties": {
    "code": {
      "default": "session.trigger.fired",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "referee"
    },
    "event_type": {
      "const": "trigger_fired",
      "default": "trigger_fired",
      "title": "Event Type",
      "type": "string"
    },
    "trigger_id": {
      "title": "Trigger Id",
      "type": "string"
    },
    "narrative": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Narrative"
    }
  },
  "required": [
    "trigger_id"
  ],
  "title": "TriggerFiredEvent",
  "type": "object"
}