LightEvent

A light source changed state.

Full documentation: LightEvent. Wire type: light.

Default visibility: player

Message codes: exploration.light.expired, exploration.light.extinguished, exploration.light.failed, exploration.light.lit

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 light source changed state.\n\n`source` is the item or effect kind (`torch`, `lantern`, `light`); `.failed`\nis a failed tinder-box attempt; `.expired` is the session's player-facing\ntranslation of the ledger's referee-visibility expiry.",
  "properties": {
    "code": {
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "player"
    },
    "event_type": {
      "const": "light",
      "default": "light",
      "title": "Event Type",
      "type": "string"
    },
    "character_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Character Id"
    },
    "source": {
      "title": "Source",
      "type": "string"
    }
  },
  "required": [
    "code",
    "source"
  ],
  "title": "LightEvent",
  "type": "object"
}