Difference between revisions of "HasMagicEffect"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Catwheezle
(Syntax fix on the example. I think, at least, that the stuff in braces is meant to be a comment.)
imported>DavidJCobb
(→‎Description: The description for this function was totally wrong!)
Line 1: Line 1:
==Description==
==Description==
Returns 1 if the calling reference is currently being affected by the given magic effect.
If the calling reference is being affected by a [[Spell]] that ''can potentially apply'' the specified [[Magic Effect]], then the condition function returns 1. Effects will be detected by this condition even if they aren't ''actually'' affecting the reference (because their spell-side conditions aren't being met).
 
In other words, "having a magic effect" is distinct from "being affected by a magic effect," and this function tests for the former.


==Syntax:==
==Syntax:==

Revision as of 16:06, 1 June 2017

Description

If the calling reference is being affected by a Spell that can potentially apply the specified Magic Effect, then the condition function returns 1. Effects will be detected by this condition even if they aren't actually affecting the reference (because their spell-side conditions aren't being met).

In other words, "having a magic effect" is distinct from "being affected by a magic effect," and this function tests for the former.

Syntax:

ActorRef.HasMagicEffect EffectID 

Example:

Player.HasMagicEffect 000B729D ; (FrostSlowConcAimed)

Returns 1 if the calling reference is currently being affected by the given magic effect.

Papyrus Version

HasMagicEffect

See Also

IsSpellTarget
OnMagicEffectHit