Skip to content

CurseRevealedEvent

The curse on a cursed item is now known, and the item can't be taken off.

Full documentation: CurseRevealedEvent. Wire type: curse_revealed.

Default visibility: player

Message codes: items.curse.revealed

JSON Schema

{
  "$defs": {
    "Visibility": {
      "description": "Who may see an event: the players, or only the referee.\n\nEvery event has one of these values, because in B/X the referee makes some rolls behind a screen. Filter\na log on it before you show anything to a player, or call\n`GameSession.view`, which builds the players' view and the referee's\nview for you. A narrator that plays the referee reads every event.\n\nA serialized event contains the lowercase value. The values stay fixed within a `schema_version`, the version\nstamp of the saved format.\n\nExamples:\n    ```python\n    from osrlib.core.events import DamageDealtEvent, HitPointsReportedEvent, Visibility\n\n    log = [\n        DamageDealtEvent(target_id=\"monster-0001\", amount=5),\n        HitPointsReportedEvent(target_id=\"monster-0001\", current_hp=2, max_hp=7),\n    ]\n    shown = [event.code for event in log if event.visibility is Visibility.PLAYER]\n    assert shown == [\"combat.damage.dealt\"]  # the goblin's remaining hit points stay hidden\n    ```",
      "enum": [
        "player",
        "referee"
      ],
      "title": "Visibility",
      "type": "string"
    }
  },
  "description": "The curse on a cursed item is now known, and the item can't be taken off.\n\nEmitted when the party learns of a cursed item's curse: when the item is used, or worn\nso that its curse takes hold, or when the referee identifies it with\n`IdentifyItem`. It comes right after the\n`ItemIdentifiedEvent` when the item wasn't\nidentified yet. From then on the member can't drop, give away, or unequip the item until\na *remove curse* lifts the curse.",
  "properties": {
    "code": {
      "default": "items.curse.revealed",
      "title": "Code",
      "type": "string",
      "description": "The message code, always `items.curse.revealed`."
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "player",
      "description": "Player visibility: the bearer learns about the curse when it takes hold."
    },
    "event_type": {
      "const": "curse_revealed",
      "default": "curse_revealed",
      "title": "Event Type",
      "type": "string",
      "description": "The event type, `curse_revealed`, which identifies this class in serialized form."
    },
    "character_id": {
      "title": "Character Id",
      "type": "string",
      "description": "The member who has the cursed item."
    },
    "instance_id": {
      "title": "Instance Id",
      "type": "string",
      "description": "The session-scoped id of the cursed item."
    },
    "template_id": {
      "title": "Template Id",
      "type": "string",
      "description": "What the item is, as its magic item catalog id."
    }
  },
  "required": [
    "character_id",
    "instance_id",
    "template_id"
  ],
  "title": "CurseRevealedEvent",
  "type": "object"
}