Skip to main content

Effect

An Effect defines a modification that can be applied to one or more target Stats.

It contains all the information required to determine how, when, and where the modification is applied. When an Effect is dispatched, it is processed by the Processor identified by its Processor Id, which then applies the Effect according to its configuration.

Fields

FieldDescription
Processor IdIdentifies the Processor that handles this Effect.
AttributesA collection of Effect Attributes used by Processors. Some Processors require specific Attributes in order to process the Effect.
Apply TypeDetermines whether the Effect is applied permanently or temporarily. See Apply Types below.
Modifier TypeDetermines how a temporary Effect is removed. Used only when Apply Type is set to Temporary. See Modifier Types below.
UpdaterSpecifies which Updater manages the lifetime of the Modifier. Used only when Apply Type is Temporary and Modifier Type is With Duration.
Use DelayEnables delayed application of the Effect.
Use Stat DelayUses a Stat instead of a predefined delay value.
DelayThe predefined delay before the Effect is applied.
Delay StatThe Stat that provides the delay value.
Use Stat DurationUses a Stat instead of a predefined duration value.
DurationThe predefined duration of the temporary Modifier.
Duration StatThe Stat that provides the duration value.
Use Turn StatUses a Stat instead of a predefined turn value.
TurnThe predefined number of turns the temporary Modifier remains active.
Turn StatThe Int Stat that provides the turn duration.
Stat TargetingDetermines whether the Effect targets a single Stat or multiple tagged Stats. See Stat Targeting Types below.
Target StatThe Stat Key of the target Stat. Used when Stat Targeting is Single Stat.
Tagged StatsDefines the criteria used to target multiple Stats. Used when Stat Targeting is Tagged Stats.

Apply Types

TypeDescription
PermanentApplies the Effect permanently.
TemporaryApplies the Effect temporarily by creating a Modifier.

Modifier Types

TypeDescription
With DurationThe temporary Modifier is removed automatically after its configured duration or turn count expires.
Managed By CodeThe temporary Modifier remains active until it is removed manually through code.

Stat Targeting Types

TypeDescription
Single StatTargets a single Stat specified by Target Stat.
Tagged StatsTargets all Stats matching the configured tag criteria.

Tagged Stats

FieldDescription
EnvironmentsDefines which Environments are searched for matching Stats.
Container IdDefines which Container is searched for matching Stats.
TagsDefines the tags that a Stat must have to be targeted.