EffectExpiredEvent
An effect ran out of time and ended.
Full documentation: EffectExpiredEvent. Wire type: effect_expired.
Default visibility: referee
Message codes: effects.effect.expired
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": "An effect ran out of time and ended.\n\n`EffectsLedger.advance` reports this when the clock reaches the\nround an effect ends on. This event comes first. Then the effect's condition and modifiers come off. Last, an\neffect that does something when it ends does it, like the second hit of thrown oil. When you end an effect early,\nthe ledger reports an `EffectReleasedEvent` instead.",
"properties": {
"code": {
"default": "effects.effect.expired",
"title": "Code",
"type": "string",
"description": "Fixed at `effects.effect.expired`."
},
"visibility": {
"$ref": "#/$defs/Visibility",
"default": "referee",
"description": "Referee visibility: this is the ledger's record. When a light source burns out, a session also reports a\nseparate event the players see."
},
"event_type": {
"const": "effect_expired",
"default": "effect_expired",
"title": "Event Type",
"type": "string",
"description": "The fixed string that identifies this event class in a serialized event."
},
"effect_id": {
"title": "Effect Id",
"type": "string",
"description": "The id of the effect that ended."
},
"kind": {
"title": "Kind",
"type": "string",
"description": "The effect's kind, from its definition."
},
"target_ref": {
"title": "Target Ref",
"type": "string",
"description": "The entity id or location string the effect was attached to."
},
"round": {
"title": "Round",
"type": "integer",
"description": "The round the effect ended on, counted from the start of the game clock."
}
},
"required": [
"effect_id",
"kind",
"target_ref",
"round"
],
"title": "EffectExpiredEvent",
"type": "object"
}