Vixen
caa30e12
csharp
public sealed class EffectTemplate

An EffectDefinition with every name resolved: the form the frame runs.

Read the guide page for this →

Remarks

Compiled once, shared by every instance of the effect on every target. A definition holds strings because a designer wrote it; a template holds GameplayTagRanges and AttributeIds because a hundred stacks of burning on forty targets must not resolve a string. Nothing here is per-target — that is ActiveEffect.

⚠ A tag the table does not have compiles to an empty range and matches nothing, rather than failing the compile. A definition that mentions a tag no content baked is a content bug, and the place that reports it is the content build; a realm that refused to load the effect would turn one misspelling into an ability that throws.

Fields and properties (13)

  • public EffectDefinition Definition

    What it was compiled from.

  • public DefId Id

    The definition's id — what the wire carries and a saved row stores.

  • public float Duration

    How long one application lasts, in seconds. Zero or less is forever.

  • public bool IsInfinite

    Whether it lasts until something removes it.

  • public float Period

    How often it ticks, in seconds. Zero is never.

  • public EffectStacking Stacking

    What a second application does.

  • public int MaximumStacks

    How high StackTo counts, never below one.

  • public ReadOnlySpan<Modifier> Modifiers

    What it does to the target's stats, per stack. Source is unset.

  • public ReadOnlySpan<GameplayTag> Tags

    What this effect is, for an immunity to match.

  • public ReadOnlySpan<GameplayTag> GrantedTags

    What the target has while it is active.

  • public ReadOnlySpan<GameplayTagRange> BlockedTags

    What the target may not do while it is active.

  • public ReadOnlySpan<GameplayTagRange> Immunities

    What may not be applied to the target while it is active.

  • public ReadOnlySpan<GameplayTagRange> CancelOn

    Which gameplay events end it.

Methods (2)

Used by (8)

  • AbilityCasterTestsVixen.Gameplay.Combat.Tests
  • AbilityLibraryVixen.Gameplay.Combat
  • AbilityTemplateVixen.Gameplay.Combat
  • ActiveEffectVixen.Gameplay
  • CombatResolverVixen.Gameplay.Combat
  • EffectSetVixen.Gameplay
  • EffectSetTestsVixen.Gameplay.Tests
  • GameplaySubjectTestsVixen.Gameplay.Tests