Skip to content

XpAwardedEvent

An XP award applied to one character.

Full documentation: XpAwardedEvent. Wire type: xp_awarded.

Default visibility: player

Message codes: session.xp.awarded

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 XP award applied to one character.",
  "properties": {
    "code": {
      "default": "session.xp.awarded",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "player"
    },
    "event_type": {
      "const": "xp_awarded",
      "default": "xp_awarded",
      "title": "Event Type",
      "type": "string"
    },
    "character_id": {
      "title": "Character Id",
      "type": "string"
    },
    "award": {
      "title": "Award",
      "type": "integer"
    },
    "modified_award": {
      "title": "Modified Award",
      "type": "integer"
    },
    "level_after": {
      "title": "Level After",
      "type": "integer"
    }
  },
  "required": [
    "character_id",
    "award",
    "modified_award",
    "level_after"
  ],
  "title": "XpAwardedEvent",
  "type": "object"
}