X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=src%2Ftimer.h;h=88441839fce947a516ac41795b4505de1a522650;hb=0b585f0dc8e185bcf1a7e281108281f5b2b96706;hp=a0e49e06070b5c0da5f5ce4439488e841f6df0cf;hpb=ac9e53e5d668d20fcae8c6ac728602d5359a6004;p=supertux.git

diff --git a/src/timer.h b/src/timer.h
index a0e49e060..88441839f 100644
--- a/src/timer.h
+++ b/src/timer.h
@@ -1,3 +1,23 @@
+//  $Id$
+// 
+//  SuperTux
+//  Copyright (C) 2005 Matthias Braun <matze@braunis.de>
+//
+//  This program is free software; you can redistribute it and/or
+//  modify it under the terms of the GNU General Public License
+//  as published by the Free Software Foundation; either version 2
+//  of the License, or (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+// 
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
+//  02111-1307, USA.
+
 #ifndef __SUPERTUX_TIMER_H__
 #define __SUPERTUX_TIMER_H__
 
@@ -12,13 +32,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