Skip to content

LightSource

Light a torch or a lantern, or set fire to a dropped flask of oil (one round).

Full documentation: LightSource. Wire type: light_source.

Legal session modes: exploring, town

JSON Schema

{
  "description": "Light a torch or a lantern, or set fire to a dropped flask of oil (one round).\n\nIt's legal in town and while exploring. When no living member already has a flame\nburning, the member needs a tinder box, and each strike lights on a 2 in 6. Each\nattempt takes a round, whether or not it lights, as the OSE SRD's tinder box entry says.\nLighting `oil_flask` sets fire to a flask already dropped on the party's cell, which\nmakes a pool of burning oil there.\n\nModes:\n    `town`, `exploring`\n\nRejections:\n    - `session.command.wrong_mode` - an encounter or battle is underway, or the\n      session has ended.\n    - `session.command.unknown_member` - `character_id` matches no party member.\n    - `session.command.member_incapacitated` - the member can't act.\n    - `exploration.light.not_a_source` - `item_id` isn't `torch`, `lantern`,\n      or `oil_flask`.\n    - `exploration.item.not_carried` - the member doesn't carry the torch or the\n      lantern, or carries a lantern and no oil flask. For `oil_flask`, no dropped\n      flask is on the cell, which is always so in town.\n    - `exploration.light.no_flame` - no flame is burning in the party, and the member\n      has no tinder box.\n\nEvents:\n    An `EffectAttachedEvent` for the light's\n    burn time, then a `LightEvent` with code\n    `exploration.light.lit`. A strike that doesn't light produces only a `LightEvent` with\n    code `exploration.light.failed`. One round passes either way.",
  "properties": {
    "command_type": {
      "const": "light_source",
      "default": "light_source",
      "title": "Command Type",
      "type": "string",
      "description": "The name that identifies the command class in serialized data. Each command class fixes\nit to a distinct snake_case string, like `\"move_party\"` or `\"open_door\"`, and constructing\nthe class sets it, so you never pass it yourself.\n`parse_command` and the\n`AnyCommand` union use it to rebuild the right class\nfrom a serialized mapping. A class's value never changes between releases."
    },
    "source": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Source",
      "description": "Who or what issued the command on whose behalf: an authored trigger or quest id, or the\nname of one of your game's systems. The engine never reads it, so a command with a\n`source` does exactly what the same command without one does. The session logs and\nreplays it with the command, so the log alone shows why something happened. Leave it\n`None` when there's nothing to record. An empty string fails validation when the command\nis constructed."
    },
    "character_id": {
      "title": "Character Id",
      "type": "string",
      "description": "The member who strikes the light and then carries it, by\n`MemberView.id`. The light goes with this member, so the\nparty loses it when this member dies."
    },
    "item_id": {
      "title": "Item Id",
      "type": "string",
      "description": "Which source to light: `torch`, `lantern`, or `oil_flask`. Lighting a torch uses it up,\nand it burns for a torch's full duration. A lantern burns one oil flask from the member's\npack, and the member keeps the lantern. `oil_flask` sets fire to a flask already dropped on\nthe party's cell, not one in the pack, so drop it with\n`DropItems` first. The session refuses any other id with\n`exploration.light.not_a_source`."
    }
  },
  "required": [
    "character_id",
    "item_id"
  ],
  "title": "LightSource",
  "type": "object"
}