BlitzMax/Modules/Events/Timers

FunctionsEdit

CreateTimerEdit

Function CreateTimer:TTimer( hertz#,event:TEvent=Null )

Description: Create a timer

Returns: A new timer object

Information: CreateTimer creates a timer object that 'ticks' hertz times per second.

Each time the timer ticks, event will be emitted using EmitEvent.

If event is Null, an event with an id equal to EVENT_TIMERTICK and source equal to the timer object will be emitted instead.

TimerTicksEdit

Function TimerTicks( timer:TTimer )

Description: Get timer tick counter

Returns: The number of times timer has ticked over

WaitTimerEdit

Function WaitTimer( timer:TTimer )

Description: Wait until a timer ticks

Returns: The number of ticks since the last call to WaitTimer

Example:

timer=CreateTimer( 10 )

Repeat
	Print "Ticks="+WaitTimer( timer )
Forever

StopTimerEdit

Function StopTimer( timer:TTimer )

Description: Stop a timer

Information: Once stopped, a timer can no longer be used.