added object remove_listener so that you can get a message if some objects are remove...

[supertux.git] / src / timer.h

diff --git a/src/timer.h b/src/timer.h
index 8a0cf40..4640e57 100644 (file)
--- a/src/timer.h
+++ b/src/timer.h
@@ -1,33 +1,42 @@
-//
-// C Interface: timer
-//
-// Description: 
-//
-//
-// Author: Tobias Glaesser <tobi.web@gmx.de>, (C) 2004
-//
-// Copyright: See COPYING file that comes with this distribution
-//
-//
+#ifndef __SUPERTUX_TIMER_H__
+#define __SUPERTUX_TIMER_H__
 
-#ifndef SUPERTUX_TIMER_H
-#define SUPERTUX_TIMER_H
+extern float global_time;
 
-/* Timer type */
-typedef struct timer_type
-  {
-   unsigned int period;
-   unsigned int time;
-  }
-timer_type;
+/**
+ * new simpler timer designed to be used in the update functions of objects
+ */
+class Timer2 // TODO rename later
+{
+public:
+  Timer2();
+  ~Timer2();
 
-void timer_init(timer_type* ptimer);
-void timer_start(timer_type* ptimer, unsigned int period);
-void timer_stop(timer_type* ptimer);
-int timer_check(timer_type* ptimer);
-int timer_started(timer_type* ptimer);
-int timer_get_left(timer_type* ptimer);
-int timer_get_gone(timer_type* ptimer);
+  /** start the timer with the given period (in seconds).
+   * If cyclic=true then the timer willl be reset after each period.
+   * Set period to zero if you want to disable the timer.
+   */
+  void start(float period, bool cyclic = false);
+  /** returns true if a period (or more) passed since start call or last
+   * successfull check
+   */
+  bool check();
 
-#endif /*SUPERTUX_TIMER_H*/
+  /** returns the period of the timer or 0 if it isn't started */
+  float get_period() const
+  { return period; }
+  float get_timeleft() const
+  { return period - (global_time - cycle_start); }
+  float get_timegone() const
+  { return global_time - cycle_start; }
+  bool started() const
+  { return period != 0 && get_timeleft() > 0; }
+
+private:
+  float period;
+  float cycle_start;
+  bool cyclic;
+};
+
+#endif