Add Status Effect

Signature

addStatusEffect(casterAddress, targetAddress, id, duration, tickDuration)

Description

Adds a (temporary) status effect to a character.

If the status effect identifier is invalid, this function will just return.

If the target doesn't already have the (permanent / temporary) status effect, it also does the following:

• Remove all other (temporary) status effects that are nullified by the added one (e.g. Slow / Haste).

• If the target is within 24 meters of the player party leader, show status effect name as text on the target.

• Call additional functions (e.g. play actor animation) based on the added status effect.

Arguments

Caster Address

The battle unit keep address of the caster.

Target Address

The battle unit keep address of the target.

Identifier

The identifier of the status effect.

Duration

The duration of the status effect.

Tick Duration

The tick duration of the status effect.

Notes

This function requires the Remove Status Effect function.

If the target is an Esper, the status effects KO, Stone and X-Zone will force them to be dismissed instead.

If the target is affected by god mode, the status effects KO, Stone and X-Zone cannot be added to them.

The following conditions are not taken into consideration:

• If the status effect requires another one to be absent (e.g. Berserk / Confuse).

• If the status effect can be applied to foes.

• If the status effect's duration can be refreshed.

• If the target is immune to status effect via their status effect immunities or the Status-Immunity augment.

• If the target's hp should be doubled when the status effect Bubble is added to them.

• If the target's hp should be halved when the status effect Bubble is removed from them.

All of these need be manually checked instead.

Only up to 5 texts can be shown on a character at a time. If the limit is exceeded, the new text replaces the oldest one based on the order they were shown. Their placement also slightly differs based on their order (mid -> top right -> bottom left -> top left -> bottom right).

For a list of status effect identifiers, you can view battlepack spreadsheet in Resources.