Background for Skyrim SE
Member of the Form script
voidfunctionUnregisterForUpdate()Native

Description

Wiki Description

Unregisters this active magic effect/alias/form so it no longer receives Form.OnUpdate() triggered by a call to Form.RegisterForUpdate(...) or Form.RegisterForSingleUpdate(...).

Documentation Comment

Unregister for OnUpdate events, all attached scripts will stop getting update events


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.
  • When changing the timer interval or switching between periodic and single updates, you should always call UnregisterForUpdate first, or strange behavior may result.

Examples

; We no longer want any update events
UnregisterForUpdate()

Auto-Generated Example

myForm__toCallFunctionOn.UnregisterForUpdate()

Related Pages


Additional References

View this function’s page on the Skyrim Creation Kit Wiki

Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.