Background for Fallout 4
Member of the ScriptObject script
voidfunctionStartTimerGameTime(floatafInterval, intaiTimerID=0)Native

Description

Wiki Description

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.

Documentation Comment

Start a game-time timer on this script with the specified ID. Interval is in hours and the
timer event will fire only once.


Parameters

  1. floatafInterval

    CK Wiki Description

    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.

  2. intaiTimerID=0

    CK Wiki Description

    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

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)

Auto-Generated Example

float myFloat__afInterval
int myInt__aiTimerID

myScriptObject__toCallFunctionOn.StartTimerGameTime(myFloat__afInterval, myInt__aiTimerID)

Related Pages


Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki

Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.