Difference between revisions of "HasMagicEffectKeyword"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Egocarib
(reword/clarify & exchange "Frost" for an actual Keyword that exists)
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 a [[MagicEffect_Script|Magic Effect]] with the given keyword.
If the calling reference is being affected by a [[Spell]] that ''[[Effect List|can potentially apply]]'' a [[Magic Effect]] with the specified [[Keyword]], 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:10, 1 June 2017

Description

If the calling reference is being affected by a Spell that can potentially apply a Magic Effect with the specified Keyword, 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.HasMagicEffectKeyword KeywordString 

Example

Player.HasMagicEffectKeyword "MagicBlessing"

Papyrus Version

Actor.HasMagicEffectWithKeyword

See Also

HasMagicEffect
IsSpellTarget
OnMagicEffectHit