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, victory

JSON Schema

{
  "description": "Referee: apply an XP award to one character, outside the adventure award.\n\nReferee commands are legal in every mode, terminal modes included \u2014 an\nadventure's rewards land after the session has concluded. The award applies\nthe prime-requisite modifier and can trigger level gains.\n\nModes:\n    `town`, `exploring`, `encounter`, `battle`, `game_over`, `victory`\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; when the award crosses a level\n    threshold, a\n    [`CharacterLeveledUpEvent`][osrlib.crawl.events.CharacterLeveledUpEvent]\n    follows with the levels, the hit points gained, and the new title.",
  "properties": {
    "command_type": {
      "const": "award_xp",
      "default": "award_xp",
      "title": "Command Type",
      "type": "string"
    },
    "source": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Source"
    },
    "character_id": {
      "title": "Character Id",
      "type": "string"
    },
    "amount": {
      "minimum": 0,
      "title": "Amount",
      "type": "integer"
    }
  },
  "required": [
    "character_id",
    "amount"
  ],
  "title": "AwardXP",
  "type": "object"
}