RegisterForUpdateGameTime - Form
Revision as of 23:22, 13 April 2012 by imported>Fg109 (→Notes)
Member of: ActiveMagicEffect Script, Alias Script, and Form Script
Registers this active magic effect/alias/form for periodic update events in game time. 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.
Syntax
Function RegisterForUpdateGameTime(float afInterval) native
Parameters
- afInterval: How often, in game hours, the update event should be sent
Return Value
None
Examples
; Register to be notified every in-game day
RegisterForUpdateGameTime(24)
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 the notes for OnUpdateGameTime for details on how often the event will be sent as sleeping, fast traveling, and serving jail time will affect it - as well as any additional notes.
- If you find yourself doing this:
Event OnUpdateGameTime()
UnregisterForUpdateGameTime()
; Do some stuff
endEvent
Then you should use RegisterForSingleUpdateGameTime instead