Difference between revisions of "RegisterForSingleUpdateGameTime - Form"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>JustinOther
m (→‎Examples: Floatified parameter)
imported>RJC
(→‎See Also: + related)
Line 34: Line 34:
*[[Form Script]]
*[[Form Script]]
*[[RegisterForUpdateGameTime - Form]]
*[[RegisterForUpdateGameTime - Form]]
*[[RegisterForSingleUpdate - Form]]
*[[UnregisterForUpdateGameTime - Form]]
*[[UnregisterForUpdateGameTime - Form]]
*[[OnUpdateGameTime - Form]]
*[[OnUpdateGameTime - Form]]

Revision as of 19:27, 21 November 2012

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

Registers this active magic effect/alias/form for a single update game time event. Of course, this means you don't need to call UnregisterForUpdateGameTime(). 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 RegisterForSingleUpdateGameTime(float afInterval) native

Parameters

  • afInterval: In how much time (in game hours) the OnUpdateGameTime() should be triggered

Return Value

None

Examples

; Just tell us when 5 days have passed in game
RegisterForSingleUpdateGameTime(120.0) ; 24 * 5

Notes

  • Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.
  • Using this function could cause your game to freeze under any of the following conditions:
    • afInterval is less than some number between 0.0244 and 0.0238. (1.0 / 41.0 and 1.0 / 42.0)
    • afInterval is expressed as X / Y where X and Y are both integers (no decimal points) and evaluate to less than 1.

See Also