UnregisterForRemoteEvent - ScriptObject

Revision as of 11:35, 3 December 2015 by imported>Plplecuyer
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Member of: ScriptObject Script

Unregisters this script from receive the specified event from the source object whenever that source object receives the event. This will only unregister this script and not any other script attached to the same form, or alias or magic effect.

SyntaxEdit

Function UnregisterForRemoteEvent(ScriptObject akEventSource, ScriptEventName asEventName) native

ParametersEdit

  • akEventSource: The ScriptObject that receives the event we no longer want to receive.
  • asEventName: The event we do not want relayed to us. This must be a raw string literal and may not be a variable.

Return ValueEdit

None

ExamplesEdit

; Stop receiving OnActivate events from the secret door
UnregisterForRemoteEvent(SecretDoor, "OnActivate")

NotesEdit

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

See AlsoEdit