Define the allowed ActiveEffect application modes.

Remarks

Other arbitrary mode numbers can be used by systems and modules to identify special behaviors and are ignored

Enumeration Members

CUSTOM: number

Used to denote that the handling of the effect is programmatically provided by a system or module.

MULTIPLY: number

Multiplies a numeric base value by the numeric effect value

Example

2 (base value) * 3 (effect value) = 6 (derived value)
ADD: number

Adds a numeric base value to a numeric effect value, or concatenates strings

Example

2 (base value) + 3 (effect value) = 5 (derived value)

Example

"Hello" (base value) + " World" (effect value) = "Hello World"
DOWNGRADE: number

Keeps the lower value of the base value and the effect value

Example

2 (base value), 0 (effect value) = 0 (derived value)

Example

2 (base value), 3 (effect value) = 2 (derived value)
UPGRADE: number

Keeps the greater value of the base value and the effect value

Example

2 (base value), 4 (effect value) = 4 (derived value)

Example

2 (base value), 1 (effect value) = 2 (derived value)
OVERRIDE: number

Directly replaces the base value with the effect value

Example

2 (base value), 4 (effect value) = 4 (derived value)