StartTimerGameTime - ScriptObject

Member of: ScriptObject Script

Starts a game-time timer on this script with the specified ID. Will cause an OnTimerGameTime event to occur once the timer expires that will not repeat. Time will only count when not in menu-mode.

Syntax

Function StartTimerGameTime(float afInterval, int aiTimerID = 0) native

Parameters

• afInterval: How long until the timer expires, in game-time hours. Any value smaller then 0.033 (2 minutes) will be rounded up to that value.
• aiTimerID: The ID of the game-time timer to start. The ID is unique per-script and will not conflict with real-time timers. If a timer with the same ID is already ticking down, it will reset the timer with the specified time.
  • Default: 0

Return Value

None.

Examples

; Start a 1 hour game-time timer with an ID of 0 on this script
StartTimerGameTime(1)

; Start a 15 minute game-time timer with an ID of 10 on this script
StartTimerGameTime(0.25, 10)

See Also

• ScriptObject Script
• CancelTimerGameTime - ScriptObject
• OnTimerGameTime - ScriptObject