Skip to content

AwardXP

Referee: apply an XP award to one character, outside the adventure award.

Full documentation: AwardXP. Wire type: award_xp.

Legal session modes: battle, encounter, exploring, game_over, town

JSON Schema

{
  "description": "Referee: apply an XP award to one character, outside the adventure award.\n\nReferee commands are legal in every mode. The award applies the\nprime-requisite modifier and can trigger level gains.\n\nModes:\n    `town`, `exploring`, `encounter`, `battle`, `game_over`\n\nRejections:\n    - `session.command.unknown_member` \u2014 `character_id` names no party member.\n\nEvents:\n    [`XpAwardedEvent`][osrlib.crawl.events.XpAwardedEvent] with the award, the\n    modified award, and the level after.",
  "properties": {
    "command_type": {
      "const": "award_xp",
      "default": "award_xp",
      "title": "Command Type",
      "type": "string"
    },
    "character_id": {
      "title": "Character Id",
      "type": "string"
    },
    "amount": {
      "minimum": 0,
      "title": "Amount",
      "type": "integer"
    }
  },
  "required": [
    "character_id",
    "amount"
  ],
  "title": "AwardXP",
  "type": "object"
}