GetEffectCreator(effect)

Gets the object that created eEffect.

object GetEffectCreator(
    effect eEffect
);

Parameters

eEffect

An existing effect already applied in game.

Description

Returns the object that created eEffect.
Returns OBJECT_INVALID if eEffect is not a valid effect.

Remarks

You must first create and place the effect you wish to examine into a variable before calling this function. This is useful when you want to specify only effects that were applied by specific creatures or objects. An example may be a trap that causes a strength decrease each round if the player is in its area of effect. If the player leaves that area of effect, the trap will loop through the effects on the player looking for only the effects it created, and remove them.

Version

1.22

See Also

functions:	GetAreaOfEffectCreator | GetEffectDurationType | GetEffectSpellId | GetEffectSubType | GetEffectType
categories:	Effects Functions

---

 author: John Shuell, editor: Ryan Hunt
 Send comments on this topic.