CancelTimerGameTime - ScriptObject

From Creation Kit
Jump to: navigation, search

Member of: ScriptObject Script

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

Syntax

Function CancelTimerGameTime(int aiTimerID = 0) native

Parameters

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

Return Value

None.

Examples

; Cancel pending game-time timer 0 on this script
CancelTimerGameTime()


; Cancel pending game-time timer 99 on this script
CancelTimerGameTime(99)

See Also