CancelTimer - ScriptObject

Member of: ScriptObject Script

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

Syntax

Function CancelTimer(int aiTimerID = 0) native

Parameters

• aiTimerID: 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

Return Value

None.

Examples

; Cancel pending timer 0 on this script
CancelTimer()

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

See Also

• ScriptObject Script
• StartTimer - ScriptObject
• OnTimer - ScriptObject