Skip to content

FlagSetEvent

A session flag changed (referee — content wiring is the game's secret).

Full documentation: FlagSetEvent. Wire type: flag_set.

Default visibility: referee

Message codes: session.flag.set

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 session flag changed (referee \u2014 content wiring is the game's secret).",
  "properties": {
    "code": {
      "default": "session.flag.set",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "referee"
    },
    "event_type": {
      "const": "flag_set",
      "default": "flag_set",
      "title": "Event Type",
      "type": "string"
    },
    "key": {
      "title": "Key",
      "type": "string"
    },
    "value": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "boolean"
        }
      ],
      "title": "Value"
    }
  },
  "required": [
    "key",
    "value"
  ],
  "title": "FlagSetEvent",
  "type": "object"
}