Skip to main content

State Based Effect

A State Based Effect Stat automatically triggers an Effect when the configured Stat condition is satisfied.

It can be used to implement passive gameplay mechanics such as auras, low-health effects, status effects, or conditional abilities that activate in response to an Actor's current state.

State Based Effect Signature

Fields

FieldDescription
Use Multi Stat CheckEvaluates the activation condition using multiple Stats instead of a single Stat.
Single Stat CheckDefines the condition evaluated against a single Stat.
Multi Stat CheckDefines the condition evaluated against multiple Stats.
ToggleableAllows the State Based Effect to be enabled or disabled based on the value of a Toggle Stat.
Toggle Stat KeyThe Stat Key of the Toggle Stat. The referenced Stat must be an Int Stat.
Toggle On Value TypeDetermines when the State Based Effect is active. See Toggle On Value Types below.
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.
Target Actor Stat KeyThe Stat Key of the Actor Stat used when Effect Target is set to Actor Stat.
Effect Source AsDetermines which Actor is assigned as the Source of the triggered Effect.
Custom Effect SourceDefines a custom Effect source provider.
Effect Source Actor Stat FromDetermines which Actor provides the Actor Stat when Effect Source As is set to Actor Stat.
Custom Actor For Actor StatDefines the custom Actor when Effect Source Actor Stat From is set to Custom.
Effect Source Actor Stat KeyThe Stat Key used to retrieve the Actor Stat.
Effect Apply TypeDetermines how the triggered Effect is applied. See Effect Apply Types below.
Environment IdThe Environment Id to which the triggered Effect is sent.

Toggle On Value Types

TypeDescription
On ZeroThe State Based Effect is active when the Toggle Stat's value is 0.
On PositiveThe State Based Effect is active when the Toggle Stat's value is greater than 0.

Effect Apply Types

TypeDescription
Apply OnceApplies the Effect when the condition becomes true. When the condition becomes false, the applied Effect is removed.
Replace On UpdateApplies the Effect when the condition becomes true. While the condition remains true, each update removes the previously applied Effect and applies a new one.
PersistentApplies the Effect every time the condition is updated while it remains true.