GetIsEffectValid(effect)

Determines whether an effect is valid.

int GetIsEffectValid(
    effect eEffect
);

Parameters

eEffect

The effect to check for validity.

Description

Returns TRUE if eEffect is a valid effect, otherwise FALSE.

Remarks

Typically used on functions that return effects, like GetFirstEffect or GetNextEffect.

Version

1.22

Example

// Remove the Paralysis effect
effect eFind = GetFirstEffect(oTarget);
while (GetIsEffectValid(eFind))
{
   if(eFind == EffectDazed())
   {
      if (GetEffectType(eFind) == EFFECT_TYPE_PARALYZE)
      {
         RemoveEffect(oTarget, eFind);
      }
   }
   eFind = GetNextEffect(oTarget);
}

See Also

categories:

Effects Functions

---

 author: Tom Cassiotis, editor: Kristian Markon
 Send comments on this topic.