EffectReleasedEvent
An effect was ended early, before its time was up.
Full documentation: EffectReleasedEvent. Wire type: effect_released.
Default visibility: referee
Message codes: effects.effect.released
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 was ended early, before its time was up.\n\n`EffectsLedger.release` reports this, as when a *dispel magic*\nends a spell, a charmed creature makes its save, or someone puts out a torch. For an effect that ran out of time,\nthe ledger reports an `EffectExpiredEvent` instead.",
"properties": {
"code": {
"default": "effects.effect.released",
"title": "Code",
"type": "string",
"description": "Fixed at `effects.effect.released`."
},
"visibility": {
"$ref": "#/$defs/Visibility",
"default": "referee",
"description": "Referee visibility: this is the ledger's record."
},
"event_type": {
"const": "effect_released",
"default": "effect_released",
"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 was 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."
}
},
"required": [
"effect_id",
"kind",
"target_ref"
],
"title": "EffectReleasedEvent",
"type": "object"
}