Package fife :: Package extensions :: Module fife_timer

[frames] | no frames]

Module fife_timer

Convenient timers

Usage:

 import fife.extensions.fife_timer
 
 fife_timer.init( my_fife_engine.getTimeManager() )
 
 def spam():
    print "SPAM SPAM ",
 
 repeater = fife_timer.repeatCall(500,spam)
 
 def stop_spam():
    repeater.stop()
    print "BACON EGGS AND SPAM"
 
 delayed = fife_timer.delayCall(50000,stop_spam)

Classes

Timer
Timer

Functions

init(timemanager)
Initialize timers.

source code

Timer

delayCall(delay, callback)
Delay a function call by a number of milliseconds.

source code

Timer

repeatCall(period, callback)
Repeat a function call.

source code

Variables

_manager = None
hash(x)

Function Details

init(timemanager)

Initialize timers.

Parameters:

timemanager - A fife.TimeManager as retuned by fife.Engine.getTimeManager.

delayCall(delay, callback)

Delay a function call by a number of milliseconds.

Remember to keep a reference to the timer this function returns. If you do not python will delete the timer prematurely which may case a segfault.

Parameters:

delay - Delay in milliseconds.
callback - The function to call.

Returns: Timer

The timer.

repeatCall(period, callback)

Repeat a function call. The call is repeated until the timer is stopped.

Remember to keep a reference to the timer this function returns. If you do not python will delete the timer prematurely which may case a segfault.

Parameters:

period - Period between calls in milliseconds.
callback - The function to call.

Returns: Timer

The timer.