RegisterForMagicEffectApplyEvent - ScriptObject

Member of: ScriptObject

Registers this script to receive a single OnMagicEffectApply event matching the filters given to this function.

Only the script that registers for an event will receive it. Other scripts attached to the same form, alias, or magic effect will not receive the event unless they also register for it.

Syntax

Function RegisterForMagicEffectApplyEvent(ScriptObject akTarget, ScriptObject akCasterFilter = None, Form akEffectFilter = None, \
  bool abMatch = true) native

Parameters

• akTarget: The ObjectReference, ReferenceAlias or RefCollectionAlias that is having the effect applied to them.
• akCasterFilter: The filter to use for the caster.
  • Default: None
  • Reference or actor: Exact match
  • Base object: Base object match
  • Keyword: Keyword match
  • Faction: Actor in faction match
  • Form list: Containing any of the above (not recursed into)
  • Reference alias: Filling this alias
  • Ref collection alias: Filling this alias
  • None: Anything
• akEffectFilter: The filter to use for the magic effect
  • Default: None
  • Magic effect base object: Base object match
  • Keyword: Keyword match
  • Form list: Containing any of the above (not recursed into)
  • None: Anything
• abMatch: If true, the filter must match the hit - if false, the filter must NOT match the hit (inverted filter)
  • Default: true

Return Value

None

Examples

; Register for when the player has any effects applied to him
RegisterForMagicEffectApplyEvent(Game.GetPlayer())

; Register for when we are hit by anything OTHER then a flame effect
RegisterForMagicEffectApplyEvent(self, akEffectFilter = FlameEffect, abMatch = false)

Notes

• Registration is removed after the first matching effect. You have to re-register to get another effect apply.
• Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.
• You can be registered for as many different magic effect apply events as you like, but if a magic effect arrives that matches multiple filters it is undefined which filter will be removed from the list.

See Also

• ScriptObject Script
• UnregisterForAllMagicEffectApplyEvents - ScriptObject
• UnregisterForMagicEffectApplyEvent - ScriptObject
• OnMagicEffectApply - ScriptObject