Skip to content

BattleRoundEvent

A battle round began.

Full documentation: BattleRoundEvent. Wire type: battle_round.

Default visibility: player

Message codes: battle.round.started

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 battle round began.",
  "properties": {
    "code": {
      "default": "battle.round.started",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "player"
    },
    "event_type": {
      "const": "battle_round",
      "default": "battle_round",
      "title": "Event Type",
      "type": "string"
    },
    "round": {
      "title": "Round",
      "type": "integer"
    }
  },
  "required": [
    "round"
  ],
  "title": "BattleRoundEvent",
  "type": "object"
}