Skip to main content

Event Based Effect

An Event Based Effect Stat triggers an Effect when a specific event occurs.

To function, the owning Actor must have the ActorExtension_EventProcessor extension.

Events are dispatched using a Stat Key. When an event is received, the Actor searches for an Event Based Effect Stat with the matching Stat Key and triggers its configured Effect.

Event Based Effect Signature

Fields

FieldDescription
State CheckEnables conditional triggering based on Stat conditions.
Use Multi Stat CheckEvaluates the condition using multiple Stats instead of a single Stat.
Single Stat CheckerDefines the condition evaluated against a single Stat.
Multi Stat CheckerDefines the condition evaluated against multiple Stats.
Use LimiterLimits the number of active Effects that can be triggered simultaneously.
Use Stat For Use LimitUses a Stat instead of a predefined active Effect limit.
Use Limit StatThe Stat that provides the active Effect limit.
Active Use LimitThe predefined maximum number of active Effects.
Use RateTriggers the Effect based on probability. A random value in the range 0–1 is generated, and the Effect is triggered only if it is less than the configured rate.
Use Stat Use RateUses a Stat instead of a predefined rate value.
Use Rate StatThe Float Stat that provides the trigger probability.
Rate ValueThe predefined probability value used when Use Stat Use Rate is disabled.
Effect TargetDetermines which Actor or Actors receive the triggered Effect. See Effect Targets for the available target types.
Target RelationSpecifies which Relation is used when Effect Target is set to Relation State.
Team FlagsDefines the target teams using bitwise Team Flags.
Custom TargeterDefines a custom target selection model.
Targeting FilterFilters Actors selected through multi-targeting methods such as Relation State or Team Flags.
Effect Source AsDetermines which Actor is assigned as the Source of the triggered Effect.
Custom Effect SourceDefines a custom Effect source provider.
Environment IdThe Environment Id to which the triggered Effect is sent.