EffectTickedEvent
An effect did what it does at regular intervals, like a troll's regeneration healing it.
Full documentation: EffectTickedEvent. Wire type: effect_ticked.
Default visibility: referee
Message codes: effects.effect.ticked
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 did what it does at regular intervals, like a troll's regeneration healing it.\n\n`EffectsLedger.advance` reports this each time a regeneration\nheals or a charmed creature rolls its repeated save, and\n`pop_mirror_image` reports it when an attack destroys one image. What\nthe effect did is in the events next to this one: healing, a saving throw, or a release.",
"properties": {
"code": {
"default": "effects.effect.ticked",
"title": "Code",
"type": "string",
"description": "Fixed at `effects.effect.ticked`."
},
"visibility": {
"$ref": "#/$defs/Visibility",
"default": "referee",
"description": "Referee visibility: this is the ledger's record."
},
"event_type": {
"const": "effect_ticked",
"default": "effect_ticked",
"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."
},
"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 is attached to."
},
"round": {
"title": "Round",
"type": "integer",
"description": "The round the effect acted on, counted from the start of the game clock."
}
},
"required": [
"effect_id",
"kind",
"target_ref",
"round"
],
"title": "EffectTickedEvent",
"type": "object"
}