GetEffectSubType(effect)

Get the subtype (SUBTYPE_*) of the effect.

int GetEffectSubType(
    effect eEffect
);

Parameters

eEffect

The effect you wish to compare or examine.

Description

Returns one of three subtype constants (SUBTYPE_*). An effect applied to an object will default to being of the Magical variety, but by using the other apply effect commands you can place supernatural or extrordinary effects on an object.
Return a 0 on error.

Remarks

You must first create and place the effect you wish to examine into a variable before calling this function. The longest effect type currently is the extraordinary effect, which will resist dispel magic effects and resting.

Version

1.22

See Also

functions:	GetEffectCreator | GetEffectDurationType | GetEffectSpellId | GetEffectType | RemoveEffect
categories:	Effects Functions
constants:	SUBTYPE_* Constants

---

 author: John Shuell