[10688] | 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 | |
---|
| 29 | /** |
---|
| 30 | @file ReplenishingMunition.h |
---|
| 31 | @brief Definition of the ReplenishingMunition class. |
---|
| 32 | */ |
---|
| 33 | |
---|
| 34 | #ifndef _ReplenishingMunition_H__ |
---|
| 35 | #define _ReplenishingMunition_H__ |
---|
| 36 | |
---|
| 37 | #include "tools/Timer.h" |
---|
| 38 | #include "Munition.h" |
---|
| 39 | |
---|
| 40 | namespace orxonox |
---|
| 41 | { |
---|
| 42 | |
---|
| 43 | /** |
---|
| 44 | @brief |
---|
| 45 | Munition that is replenished by a certain amount each time interval. |
---|
| 46 | @author |
---|
| 47 | Fabian 'x3n' Landau |
---|
| 48 | @ingroup WeaponsMunitions |
---|
| 49 | */ |
---|
| 50 | class _OrxonoxExport ReplenishingMunition : public Munition |
---|
| 51 | { |
---|
| 52 | public: |
---|
| 53 | ReplenishingMunition(Context* context); |
---|
| 54 | virtual ~ReplenishingMunition() {} |
---|
[10791] | 55 | |
---|
| 56 | virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); |
---|
| 57 | |
---|
[10688] | 58 | virtual float getProgress(); |
---|
[11030] | 59 | inline unsigned int getReplenishAmount() const |
---|
[10791] | 60 | { return replenishAmount_; } |
---|
| 61 | inline float getReplenishInterval() const |
---|
| 62 | { return replenishInterval_; } |
---|
[10688] | 63 | |
---|
| 64 | protected: |
---|
| 65 | float replenishInterval_; //!< The interval in which the munition is replenished. |
---|
[10878] | 66 | unsigned int replenishAmount_; //!< The amount of magazines by which it is replenished. |
---|
[10688] | 67 | |
---|
| 68 | private: |
---|
[10878] | 69 | void replenish(); //!< Every call of this function replenishes the munition. This function is called by the timer. |
---|
[10688] | 70 | void initializeTimer(); |
---|
| 71 | |
---|
| 72 | Timer replenishingTimer_; //!< Timer to do the replenishing. |
---|
[10791] | 73 | |
---|
| 74 | inline void setReplenishAmount(unsigned int replenishAmount) |
---|
| 75 | { this->replenishAmount_ = replenishAmount; } |
---|
| 76 | inline void setReplenishInterval(float replenishInterval) |
---|
| 77 | { this->replenishInterval_ = replenishInterval; } |
---|
[10688] | 78 | }; |
---|
| 79 | } |
---|
| 80 | |
---|
| 81 | #endif /* _ReplenishingMunition_H__ */ |
---|