UnregisterForAllMagicEffectApplyEvents - ScriptObject
Jump to navigation
Jump to search
Member of: ScriptObject
Unregisters this script from all OnMagicEffectApply events from the specified target - or from all targets if given a None target.
Only the script that unregisters for an event will stop receiving it. Other scripts attached to the same form, alias, or magic effect will still receive the event if they registered for it separately.
Syntax[edit | edit source]
Function UnregisterForAllMagicEffectApplyEvents(ScriptObject akTarget = None) native
Parameters[edit | edit source]
- akTarget: The ObjectReference, ReferenceAlias or RefCollectionAlias that we no longer want to get magic effect apply events from. If None, we will unregister for ALL magic effect apply events.
- Default: None
Return Value[edit | edit source]
None
Examples[edit | edit source]
; We no longer care about any magic effect apply events the player receives
UnregisterForAllMagicEffectApplyEvents(Game.GetPlayer())
; We no longer care about any magic effect apply events
UnregisterForAllMagicEffectApplyEvents()
Notes[edit | edit source]
- Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.