StartTimer function - ScriptObject script | Starfield

Found in:

Vanilla

voidfunctionStartTimer(floatafInterval, intaiTimerID=0)Native

Description

Wiki Description

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

Documentation Comment

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

Caveats

CK Wiki - Notes

The time will be affected by the global time modifier. So if, for example, VATS fires off and slows down time, it will affect these timers as well.
Timers on ObjectReference scripts must have an explicit aiTimerID parameter, the default implicit timer ID 0 will never start.

Parameters

floatafInterval
CK Wiki Description
How long until the timer expires, in seconds.
intaiTimerID=0
CK Wiki Description
The ID of the real-time timer to start. The ID is unique per-script and will not conflict with game-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 10 second timer with an ID of 0 on this script
StartTimer(10)

; Start a 5.5 second timer with an ID of 10 on this script
StartTimer(5.5, 10)

Auto-Generated Example

float myFloat__afInterval
int myInt__aiTimerID

myScriptObject__toCallFunctionOn.StartTimer(myFloat__afInterval, myInt__aiTimerID)

Additional References

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