DeathEvent
A creature has been killed.
Full documentation: DeathEvent. Wire type: death.
Default visibility: player
Message codes: combat.death.died, combat.death.permanent
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": "A creature has been killed.\n\n`kill` reports this, whether the death came from damage, a failed save, or an\neffect running out. It comes after the `ConditionGainedEvent` for\n`dead`, and before the `HitPointsReportedEvent`.\n\n`deal_damage` reports a second one, with the code `combat.death.permanent`,\nwhen the damage a dead monster can't regenerate adds up to its maximum hit points. That one\ncomes after the `HitPointsReportedEvent`, with no condition event, because the monster is already `dead`.\n\nRead the code to know whether the death can be undone. An ordinary death can be, by magic or by regeneration. A\npermanent one can't, which is what enough fire and acid do to a troll.",
"properties": {
"code": {
"title": "Code",
"type": "string",
"description": "What happened, like `combat.attack.hit`: two or more lowercase parts separated by dots. The first part is\nthe area of the rules the event comes from, like `combat` or `magic`.\n\nBranch on it, and pass the event to `format_message` to turn it into English.\nBuilding an event with a code in any other format raises a pydantic `ValidationError`."
},
"visibility": {
"$ref": "#/$defs/Visibility",
"default": "player",
"description": "Player visibility: everyone sees a creature fall."
},
"event_type": {
"const": "death",
"default": "death",
"title": "Event Type",
"type": "string",
"description": "The fixed string that identifies this event class in a serialized event."
},
"target_id": {
"title": "Target Id",
"type": "string",
"description": "The entity id of the creature that died."
}
},
"required": [
"code",
"target_id"
],
"title": "DeathEvent",
"type": "object"
}