Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/pickup/items/DamageBoostPickup.h @ 12012

Last change on this file since 12012 was 11099, checked in by muemart, 9 years ago

Fix loads of doxygen warnings and other documentation issues

  • Property svn:eol-style set to native
File size: 3.2 KB
Line 
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 *      Kevin Lengauer
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file DamageBoostPickup.h
31    @brief Declaration of the DamageBoostPickup class.
32    @ingroup PickupItems
33*/
34
35#ifndef _DamageBoostPickup_H__
36#define _DamageBoostPickup_H__
37
38#include "pickup/PickupPrereqs.h"
39
40#include <string>
41
42#include "pickup/Pickup.h"
43#include "tools/interfaces/Tickable.h"
44
45namespace orxonox {
46
47    class _PickupExport DamageBoostPickup : public Pickup, public Tickable
48    {
49        public:
50
51            DamageBoostPickup(Context* context); //!< Constructor.
52            virtual ~DamageBoostPickup(); //!< Destructor.
53
54            virtual void XMLPort(Element& xmlelement, orxonox::XMLPort::Mode mode); //!< Method for creating a DamageBoostPickup object through XML.
55
56            virtual void changedUsed(void); //!< Is called when the pickup has transited from used to unused or the other way around.
57
58            /**
59            @brief Get the time the DamagePickup lasts.
60            @return Returns the time in seconds the DamagePickup lasts.
61            */
62            inline float getDuration(void) const
63                { return this->duration_; }
64
65            inline void setDuration( float duration );
66
67
68
69            /**
70             @brief Get Damage multiplier
71             */
72            inline float getDamageMultiplier()
73                { return this->damageMultiplier_; }
74
75
76
77
78        protected:
79            void setDamageMultiplier(float damageMultiplier); //!< Sets the DamageMultiplier according to the XML.
80
81
82        private:
83            void initialize(void); //!< Initializes the member variables.
84            Pawn* carrierToPawnHelper(void); //!< Helper to transform the PickupCarrier to a Pawn, and throw an error message if the conversion fails.
85            SpaceShip* carrierToSpaceShipHelper(void); //!< Helper to transform the PickupCarrier to a SpaceShip, and throw an error message if the conversion fails.
86            void pickupTimerCallback(void);
87
88
89
90            float damageMultiplier_; //!< The damage boost that is transferred to the Pawn.
91            float olddamageMultiplier_; //!< Helper to remember what the actual damage of the Pawn was before we changed it.
92
93            Timer durationTimer_; //!< Timer.
94            float duration_; //! Duration of damage boost.
95
96    };
97}
98
99#endif // _DamageBoostPickup_H__
Note: See TracBrowser for help on using the repository browser.