EffectTickedEvent

An effect's periodic tick resolved (referee bookkeeping).

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.\n\nThe wire values are `\"player\"` and `\"referee\"` \u2014 lowercase, serialized into every\nevent; changing them is a `schema_version` bump.",
      "enum": [
        "player",
        "referee"
      ],
      "title": "Visibility",
      "type": "string"
    }
  },
  "description": "An effect's periodic tick resolved (referee bookkeeping).\n\nEmitted by [`EffectsLedger.advance`][osrlib.core.effects.EffectsLedger.advance]\n(regeneration, a charm's re-save) or\n[`pop_mirror_image`][osrlib.core.spells.pop_mirror_image] popping one figment.",
  "properties": {
    "code": {
      "default": "effects.effect.ticked",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "referee"
    },
    "event_type": {
      "const": "effect_ticked",
      "default": "effect_ticked",
      "title": "Event Type",
      "type": "string"
    },
    "effect_id": {
      "title": "Effect Id",
      "type": "string"
    },
    "kind": {
      "title": "Kind",
      "type": "string"
    },
    "target_ref": {
      "title": "Target Ref",
      "type": "string"
    },
    "round": {
      "title": "Round",
      "type": "integer"
    }
  },
  "required": [
    "effect_id",
    "kind",
    "target_ref",
    "round"
  ],
  "title": "EffectTickedEvent",
  "type": "object"
}