updating Nolok contrib templates
[supertux.git] / src / timer.h
index a0e49e0..9e93c90 100644 (file)
@@ -12,13 +12,18 @@ public:
   Timer2();
   ~Timer2();
 
-  /** start the timer with the given period. If cyclic=true then the timer willl
-   * be reset after each period.
+  /** 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 */
+  /** returns true if a period (or more) passed since start call or last
+   * successfull check
+   */
   bool check();
+  /** stop the timer */
+  void stop()
+  { start(0); }
 
   /** returns the period of the timer or 0 if it isn't started */
   float get_period() const