Background for Fallout 4
Member of the ScriptObject script
voidfunctionCancelTimer(intaiTimerID=0)Native

Description

Wiki Description

Cancels the specified real-time timer on this script. Does nothing if that timer has already expired or doesn't exist.

Documentation Comment

Cancels a pending timer on this script with the specified ID


Caveats


Parameters

intaiTimerID=0

CK Wiki Description

The ID of the real-time timer to cancel. The ID is unique per-script and will not conflict with game-time timers.

  • Default:0

Examples

; Cancel pending timer 0 on this script
CancelTimer()
; Cancel pending timer 99 on this script
CancelTimer(99)

Auto-Generated Example

int myInt__aiTimerID

myScriptObject__toCallFunctionOn.CancelTimer(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.