FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
timeevent.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005-2017 by the FIFE team *
3  * http://www.fifengine.net *
4  * This file is part of FIFE. *
5  * *
6  * FIFE is free software; you can redistribute it and/or *
7  * modify it under the terms of the GNU Lesser General Public *
8  * License as published by the Free Software Foundation; either *
9  * version 2.1 of the License, or (at your option) any later version. *
10  * *
11  * This library is distributed in the hope that it will be useful, *
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14  * Lesser General Public License for more details. *
15  * *
16  * You should have received a copy of the GNU Lesser General Public *
17  * License along with this library; if not, write to the *
18  * Free Software Foundation, Inc., *
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20  ***************************************************************************/
21 
22 #ifndef FIFE_TIMEVENT_H
23 #define FIFE_TIMEVENT_H
24 
25 // Standard C++ library includes
26 
27 // 3rd party library includes
28 
29 // FIFE includes
30 // These includes are split up in two parts, separated by one empty line
31 // First block: files included from the FIFE root src directory
32 // Second block: files included from the same folder
33 #include "util/base/fife_stdint.h"
34 
35 namespace FIFE {
36 
48  class TimeEvent {
49  public:
54  TimeEvent(int32_t period = -1);
55 
59  virtual ~TimeEvent();
60 
65  virtual void updateEvent(uint32_t time) = 0;
66 
71  void managerUpdateEvent(uint32_t time);
72 
77  void setPeriod(int32_t period);
78 
83  int32_t getPeriod();
84 
90 
95  void setLastUpdateTime(uint32_t ms);
96 
97  private:
98  // The period of the event. See the class description.
99  int32_t m_period;
100 
101  // The last time the class was updated.
103  };
104 
105 }//FIFE
106 
107 #endif
TimeEvent(int32_t period=-1)
Default constructor.
Definition: timeevent.cpp:37
uint32_t getLastUpdateTime()
Get the last time the event was updated.
Definition: timeevent.cpp:64
uint32_t m_last_updated
Definition: timeevent.h:102
Interface for events to be registered with TimeManager.
Definition: timeevent.h:48
void managerUpdateEvent(uint32_t time)
Called by TimeManager to update the event.
Definition: timeevent.cpp:46
int32_t getPeriod()
Get the period of the event.
Definition: timeevent.cpp:60
int32_t m_period
Definition: timeevent.h:99
virtual void updateEvent(uint32_t time)=0
Update function to be overridden by client.
void setPeriod(int32_t period)
Set the period of the event.
Definition: timeevent.cpp:56
void setLastUpdateTime(uint32_t ms)
Set the last time the event was updated.
Definition: timeevent.cpp:68
virtual ~TimeEvent()
Destructor.
Definition: timeevent.cpp:42
unsigned int uint32_t
Definition: core.h:40