Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/lastmanstanding/src/modules/pickup/items/HealthPickup.h @ 7636

Last change on this file since 7636 was 7456, checked in by dafrick, 14 years ago

Reviewing documentation fo Questsystem, moving documentation fully into doxygen.
Added some files to modules they belong to.

  • Property svn:eol-style set to native
File size: 6.0 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 *      Damian 'Mozork' Frick
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file HealthPickup.h
31    @brief Declaration of the HealthPickup class.
32    @ingroup PickupItems
33*/
34
35#ifndef _HealthPickup_H__
36#define _HealthPickup_H__
37
38#include "pickup/PickupPrereqs.h"
39
40#include <string>
41#include <worldentities/pawns/Pawn.h>
42#include "worldentities/StaticEntity.h"
43
44#include "pickup/Pickup.h"
45#include "tools/interfaces/Tickable.h"
46
47namespace orxonox {
48
49    //! Enum for the type of the HealthPickup
50    namespace pickupHealthType
51    {
52        enum Value
53        {
54            limited,
55            temporary,
56            permanent
57        };
58    }
59
60    /**
61    @brief
62        A pickup that can do (dependent upon the parameters) lots of different things to the health of a Pawn.
63        There are 4 parameters that can be chosen:
64        1) The health. The amount of health that (in a way dependent on the other parameters) is transfered to the Pawn.
65        2) The activation type: It can be chosen to be either 'immediate' or 'onUse'. The activation type essentially (as indicated by the name) defines when the health is transfered, either immediately after being picked up or only after the player uses it.
66        3) The duration type: It can be chosen to be either 'once' or 'continuous'. For 'once' the specified health is transfered once to the Pawn, for 'continuous' the set health is transfered over a span of time at a rate defined by the health rate parameter.
67        4) The health type: The health type can be chosen to be 'limited', 'temporary' or 'permanent'. 'limited' means that the health is increased only to the maximum health of the Pawn. 'temporary' means that the maximum health is temporarily elevated but will be set back as soon as the pickup is no longer in use. 'permanent' means that the maximum health of the Pawn is increased such that the health provided by the pickup will fit in and the maximum health stays that way.
68    @author
69        Damian 'Mozork' Frick
70    */
71    class _PickupExport HealthPickup : public Pickup, public Tickable
72    {
73        public:
74
75            HealthPickup(BaseObject* creator); //!< Constructor.
76            virtual ~HealthPickup(); //!< Destructor.
77
78            virtual void XMLPort(Element& xmlelement, orxonox::XMLPort::Mode mode); //!< Method for creating a HealthPickup object through XML.
79            virtual void tick(float dt); //!< Is called every tick.
80
81            virtual void changedUsed(void); //!< Is called when the pickup has transited from used to unused or the other way around.
82            virtual void clone(OrxonoxClass*& item); //!< Creates a duplicate of the input OrxonoxClass.
83
84            /**
85            @brief Get the health that is transfered to the Pawn upon usage of this pickup.
86            @return Returns the health.
87            */
88            inline float getHealth(void)
89                { return this->health_; }
90            /**
91            @brief Get the rate at which the health is transferred to the Pawn, if this pickup has duration type 'continuous'.
92            @return Returns the rate.
93            */
94            inline float getHealthRate(void)
95                { return this->healthRate_; }
96
97            /**
98            @brief Get the type of HealthPickup, this pickup is.
99            @return Returns the health type as an enum.
100            */
101            inline pickupHealthType::Value getHealthTypeDirect(void)
102                { return this->healthType_; }
103            const std::string& getHealthType(void); //!< Get the health type of this pickup.
104
105        protected:
106            void initializeIdentifier(void); //!< Initializes the PickupIdentifier of this pickup.
107
108            void setHealth(float health); //!< Sets the health.
109            void setHealthRate(float speed); //!< Set the rate at which health is transferred if the pickup is continuous.
110
111            /**
112            @brief Set the health type of this pickup.
113            @param type The type of this pickup as an enum.
114            */
115            inline void setHealthTypeDirect(pickupHealthType::Value type)
116                { this->healthType_ = type; }
117            void setHealthType(std::string type); //!< Set the type of the HealthPickup.
118
119        private:
120            void initialize(void); //!< Initializes the member variables.
121            Pawn* carrierToPawnHelper(void); //!< Helper to transform the PickupCarrier to a Pawn, and throw an error message if the conversion fails.
122
123            float health_; //!< The health that is transferred to the Pawn.
124            float healthRate_; //!< The rate at which the health is transferred.
125            float maxHealthSave_; //!< Helper to remember what the actual maxHealth of the Pawn was before we changed it.
126            float maxHealthOverwrite_; //!< Helper to remember with which value we overwrote the maxHealh, to detect if someone else changed it as well.
127            pickupHealthType::Value healthType_; //!< The type of the HealthPickup.
128
129            //! Strings for the health types.
130            static const std::string healthTypeLimited_s;
131            static const std::string healthTypeTemporary_s;
132            static const std::string healthTypePermanent_s;
133
134    };
135}
136
137#endif // _HealthPickup_H__
Note: See TracBrowser for help on using the repository browser.