RegisterForSingleUpdate - Form

Revision as of 13:00, 13 July 2023 by Ingvion (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Member of: ActiveMagicEffect Script, Alias Script, and Form Script

Registers this form/alias/magic effect for a single update event. Which also means you don't need to call UnregisterForUpdate() unless you want to cancel the update early. Only the specific form, alias, or magic effect that registered will get the event - it will not be relayed to attached aliases or magic effects.

SyntaxEdit

Function RegisterForSingleUpdate(float afInterval) native

ParametersEdit

  • afInterval: In how much time (in seconds, ignoring menu-mode time) the OnUpdate() should be triggered

Return ValueEdit

None

ExamplesEdit

; Register for a single update in 30.0 seconds - does not count menu-mode time.
RegisterForSingleUpdate(30.0)

NotesEdit

  • Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.
  • Subsequent calls to RegisterForSingleUpdate will override previous ones - i.e. calling it back to back will result in the second registered update occurring, but not the first. It will not interfere with updates started by RegisterForUpdate however.

See AlsoEdit