PropaneAutoResetTimer Class Reference

A timer that resets itself when it hits the limit. More...

#include <PropaneTimers.h>

Inheritance diagram for PropaneAutoResetTimer:

List of all members.

Public Member Functions
virtual bool	update (float delta)
	Update the timer. Returns TRUE if the update tripped the timer, then resets itself.
	PropaneAutoResetTimer (float limit, bool increment)
	Construct the timer.

---

Detailed Description

A timer that resets itself when it hits the limit.

---

Constructor & Destructor Documentation

PropaneAutoResetTimer::PropaneAutoResetTimer (  float  mlimit, bool  incr )

Construct the timer. Constructs an automatic reset timer with a given time span and increment Parameters: mlimit  The span in seconds between timer firings incr  True if you want the timer to increment, false otherwise.

---

Member Function Documentation

bool PropaneAutoResetTimer::update (  float  delta  )  [virtual]

Update the timer. Returns TRUE if the update tripped the timer, then resets itself. Updates the auto-reset timer. Same as updating the normal timer, except when this returns true it automatically calls reset() to reset the timer so you do not have to do it manually. Parameters: delta  The time to add to the timer, in seconds Returns: True if the timer is fired, false otherwise. Reimplemented from PropaneTimer.

---

The documentation for this class was generated from the following files:

• PropaneTimers.h
• PropaneTimers.cpp

---