Description
Wiki Description
Unregisters this script from a OnMagicEffectApply event matching the filters given to this function. The filters must match the filters given to the RegisterForMagicEffectApplyEvent function.
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.
Documentation Comment
Unregister for the specified magic effect apply event.
Caveats
CK Wiki - Notes
- Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.
Parameters
ScriptObjectakTarget
CK Wiki Description
The ObjectReference, ReferenceAlias or RefCollectionAlias that is having the effect applied.
ScriptObjectakCasterFilter=NONE
CK Wiki Description
The filter to use for the caster.
- Default:None
FormakEffectFilter=NONE
CK Wiki Description
The filter to use for the magic effect
- Default:None
boolabMatch=true
CK Wiki Description
If true, the filter must match the hit - if false, the filter must NOT match the hit (inverted filter)
- Default:true
Examples
; We no longer care about the player having effects applied to him
UnregisterForMagicEffectApplyEvent(Game.GetPlayer()); We no longer care about the player having fire applied to him
UnregisterForMagicEffectApplyEvent(self, akEffectFilter = FireEffect)Auto-Generated Example
ScriptObject myScriptObject__akTarget
ScriptObject myScriptObject__akCasterFilter
Form myForm__akEffectFilter
bool myBool__abMatch
myScriptObject__toCallFunctionOn.UnregisterForMagicEffectApplyEvent(myScriptObject__akTarget, myScriptObject__akCasterFilter, myForm__akEffectFilter, myBool__abMatch)Related Pages
Additional References
View this function’s page on the Fallout 4 Creation Kit Wiki