getEffects

getEffects

> Functions

Returns the list of effects of the entity with id entity. To directly retrieve the list of effects for your entity, use getEffects without parameters.

Parameters

• entity: The id of the entity whose list of effects will be returned.

Return

• effects: The list of effects currently present on the entity entity. The effects list is an array containing the effects. An effect is itself an array of 8 boxes of the form:

• type is the type of the effect among:
• EFFECT_DAMAGE, value is the damage number
• EFFECT_HEAL, value is the number of HP healed
• EFFECT_BUFF_STRENGTH, value is strength gained
• EFFECT_BUFF_AGILITY, value is the agility gained
• EFFECT_BUFF_TP, value is the number of TP gained
• EFFECT_BUFF_MP, value is the number of MP gained
• EFFECT_ABSOLUTE_SHIELD, value is absolute shield gained
• EFFECT_RELATIVE_SHIELD, value is relative shield gained
• EFFECT_DEBUFF, indicates a debuff, value is the percentage of effects removed.

etc

• value: The value of the effect.
• caster_id: The id of the entity that launched the effect.
• turns: The number of remaining turns of the effect.
• critical: Is the effect a critical hit.
• item_id: The id of the item that caused this effect.
• target_id: The id of the effect target (entity).
• modifiers: Effect modifiers (bit mask with EFFECT_MODIFIER_* constants).

Examples

To know if you are poisoned :