Orxonox  0.0.5 Codename: Arcturus
ReplenishingMunition.h
Go to the documentation of this file.
1 /*
2  * ORXONOX - the hottest 3D action shooter ever to exist
3  * > www.orxonox.net <
4  *
5  *
6  * License notice:
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * Author:
23  * Fabian 'x3n' Landau
24  * Co-authors:
25  * ...
26  *
27  */
28 
34 #ifndef _ReplenishingMunition_H__
35 #define _ReplenishingMunition_H__
36 
37 #include "tools/Timer.h"
38 #include "Munition.h"
39 
40 namespace orxonox
41 {
42 
51  {
52  public:
53  ReplenishingMunition(Context* context);
54  virtual ~ReplenishingMunition() = default;
55 
56  virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override;
57 
58  float getProgress();
59  inline unsigned int getReplenishAmount() const
60  { return replenishAmount_; }
61  inline float getReplenishInterval() const
62  { return replenishInterval_; }
63 
64  protected:
66  unsigned int replenishAmount_;
67 
68  private:
69  void replenish();
70  void initializeTimer();
71 
73 
74  inline void setReplenishAmount(unsigned int replenishAmount)
75  { this->replenishAmount_ = replenishAmount; }
76  inline void setReplenishInterval(float replenishInterval)
77  { this->replenishInterval_ = replenishInterval; }
78  };
79 }
80 
81 #endif /* _ReplenishingMunition_H__ */
unsigned int replenishAmount_
The amount of magazines by which it is replenished.
Definition: ReplenishingMunition.h:66
Definition: Munition.h:48
unsigned int getReplenishAmount() const
Definition: ReplenishingMunition.h:59
void setReplenishInterval(float replenishInterval)
Definition: ReplenishingMunition.h:76
float getReplenishInterval() const
Definition: ReplenishingMunition.h:61
Timer replenishingTimer_
Timer to do the replenishing.
Definition: ReplenishingMunition.h:72
Munition that is replenished by a certain amount each time interval.
Definition: ReplenishingMunition.h:50
xmlelement
Definition: Super.h:519
Declaration of the Timer class, used to call functions after a given time-interval.
Die Wagnis Klasse hat die folgenden Aufgaben:
Definition: ApplicationPaths.cc:66
Mode
Definition: CorePrereqs.h:102
Definition: Context.h:45
float replenishInterval_
The interval in which the munition is replenished.
Definition: ReplenishingMunition.h:65
#define _OrxonoxExport
Definition: OrxonoxPrereqs.h:60
Timer is a helper class that executes a function after a given amount of seconds in game-time...
Definition: Timer.h:105
void setReplenishAmount(unsigned int replenishAmount)
Definition: ReplenishingMunition.h:74