X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=src%2Ftimer.h;h=4640e575bc7d839130bd01db1fdd39dcb27acf4b;hb=5a542dea3c6043703683b68fcaa774f6cb0d9127;hp=a0e49e06070b5c0da5f5ce4439488e841f6df0cf;hpb=ac9e53e5d668d20fcae8c6ac728602d5359a6004;p=supertux.git diff --git a/src/timer.h b/src/timer.h index a0e49e060..4640e575b 100644 --- a/src/timer.h +++ b/src/timer.h @@ -12,12 +12,14 @@ 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(); /** returns the period of the timer or 0 if it isn't started */