Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ACTIVE_EFFECT_MODES

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

Index

Enumeration Members

Enumeration Members

CUSTOM

CUSTOM: number

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

MULTIPLY

MULTIPLY: number

Multiplies a numeric base value by the numeric effect value

example

2 (base value) * 3 (effect value) = 6 (derived value)

ADD

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

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

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

OVERRIDE: number

Directly replaces the base value with the effect value

example

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