StatusEffectData

Description

StatusEffectDatas contain all of the necessary data to describe a StatusEffect.

Properties

Name
Type
Description

Id

A unique Hash128 ID for quick comparisons and easy serialization with other supported packages.

AutomaticallyAddToDatabase

bool

If enabled the StatusEffectData will be automatically added to the StatusEffectDatabase.

Group

The groups which define this effect. Multiple groups can be selected.

ComparableName

The ComparableName that groups similar effects together.

BaseValue

float

The base value is used mainly when calculating how effects should be stacked. An Effect can use this value over its own.

Icon

An optional sprite.

Color

An optional Color

StatusEffectName

string

An optional name.

Acronym

string

An optional acronym

Description

string

An optional description.

AllowEffectStacking

bool

True if multiple StatusEffects of the same StatusEffectData can exist on the same MonoBehaviour.

NonStackingBehaviour

When stacking is not allowed, the behaviour determines how to resolve a situation when the same StatusEffect is added. See below for more information.

MaxStacks

int

The maximum stacks that can be added to a MonoBehaviour.

Effects

The list of Effects.

Conditions

The list of Conditionals.

Modules

ReadOnlyCollection<ModuleContainer>

The list of Modules and ModuleInstances.

Non-Stacking Behaviour

The non-stacking behavior determines how a duplicate status effect should resolve.

Name
Description

MatchHighestValue

Match Highest Value will take the value of the effect and recalculate the duration to the equivalent final value over the time. This is the recommended option for non-stacking behaviour.

TakeHighestValue

Regardless of the durations, use the effect with the highest value.

TakeHighestDuration

Regardless of the value, use the effect with the highest duration.

TakeNewest

Use the newest effect.

TakeOldest

Use the oldest effect.

Last updated