- added standard copyright header to every file
[supertux.git] / src / timer.h
index 8c69b3d..b12d32e 100644 (file)
@@ -1,14 +1,22 @@
+//  $Id$
+// 
+//  SuperTux
+//  Copyright (C) 2004 Tobias Glaesser <tobi.web@gmx.de>
 //
-// C Interface: timer
-//
-// Description: 
-//
-//
-// Author: Tobias Glaesser <tobi.web@gmx.de>, (C) 2004
-//
-// Copyright: See COPYING file that comes with this distribution
-//
+//  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
@@ -20,7 +28,7 @@ void st_pause_ticks_init(void);
 void st_pause_ticks_start(void);
 void st_pause_ticks_stop(void);
 
-class timer_type
+class Timer
 {
  public:
   unsigned int period;
@@ -33,30 +41,26 @@ class timer_type
   void stop();
 
   /*======================================================================
-    int timer_check(timer_type* ptimer);
-    
-    param : pointer to a timer which needs to be checked
     return: NO  = the timer is not started
     or it is over
     YES = otherwise
     ======================================================================*/
   int check();
   int started();
+
+  /*======================================================================
+    return: the time left (in millisecond)
+    note  : the returned value can be negative
+    ======================================================================*/
+  int get_left();
+
+  int  get_gone();
+  void fwrite(FILE* fi);
+  void fread(FILE* fi);
 };
-/*======================================================================
-  int timer_get_left(timer_type* ptimer);
-
-  param : pointer to a timer that you want to get the time left
-  return: the time left (in millisecond)
-  note  : the returned value can be negative
-  ======================================================================*/
-int timer_get_left(timer_type* ptimer);
-int timer_get_gone(timer_type* ptimer);
-void timer_fwrite(timer_type* ptimer, FILE* fi);
-void timer_fread(timer_type* ptimer, FILE* fi);
 
 #endif /*SUPERTUX_TIMER_H*/
 
 /* Local Variables: */
 /* mode:c++ */
-/* End */
+/* End: */