Skip to content

ExtinguishSource

Extinguish the bearer's burning source, forfeiting the remainder (zero time).

Full documentation: ExtinguishSource. Wire type: extinguish_source.

Legal session modes: exploring, town

JSON Schema

{
  "description": "Extinguish the bearer's burning source, forfeiting the remainder (zero time).\n\nLegal in town and while exploring. A doused torch or lantern is spent \u2014 the\nremaining burn time does not bank.\n\nModes:\n    `town`, `exploring`\n\nRejections:\n    - `session.command.wrong_mode` \u2014 an encounter or battle is underway, or the\n      game is over.\n    - `session.command.unknown_member` \u2014 `character_id` names no party member.\n    - `session.command.member_incapacitated` \u2014 the member cannot act.\n    - `exploration.light.not_burning` \u2014 the member carries no burning torch or\n      lantern.\n\nEvents:\n    An [`EffectReleasedEvent`][osrlib.core.events.EffectReleasedEvent] and a\n    [`LightEvent`][osrlib.crawl.events.LightEvent] with code\n    `exploration.light.extinguished` per doused source.",
  "properties": {
    "command_type": {
      "const": "extinguish_source",
      "default": "extinguish_source",
      "title": "Command Type",
      "type": "string"
    },
    "character_id": {
      "title": "Character Id",
      "type": "string"
    }
  },
  "required": [
    "character_id"
  ],
  "title": "ExtinguishSource",
  "type": "object"
}