UnregisterForAllHitEvents - ScriptObject

Member of: ScriptObject

Unregisters this script from all OnHit 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

Function UnregisterForAllHitEvents(ScriptObject akTarget = None) native

Parameters

• akTarget: The ObjectReference, ReferenceAlias or RefCollectionAlias that we no longer want to get hits from. If None, we will unregister for ALL hit events.
  • Default: None

Return Value

None

Examples

; We no longer care about any hits the player receives
UnregisterForAllHitEvents(Game.GetPlayer())

; We no longer care about any hit events
UnregisterForAllHitEvents()

Notes

• Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.

See Also

• ScriptObject Script
• RegisterForHitEvent - ScriptObject
• UnregisterForHitEvent - ScriptObject
• OnHit - ScriptObject