Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/pickup/items/SpeedPickup.h @ 7052

Last change on this file since 7052 was 6709, checked in by dafrick, 15 years ago

Merged ppspickups1 into trunk.

  • 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 *      Eric Beier
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file SpeedPickup.h
31    @brief Declaration of the SpeedPickup class.
32*/
33
34#ifndef _SpeedPickup_H__
35#define _SpeedPickup_H__
36
37#include "pickup/PickupPrereqs.h"
38
39#include <string>
40#include "worldentities/pawns/Pawn.h"
41#include "worldentities/StaticEntity.h"
42
43#include "pickup/Pickup.h"
44
45namespace orxonox {
46
47    /**
48    @brief
49        A Pickup which can manipulate the Speed of a Pawn.
50
51        1) The speed multiplier:
52           The additional (forward) speed:
53        2) The activation type: 'immediate' or 'onUse'. defines if the item is used when it's picked up or only after the player chooses to use it.
54        4) The duration: the activation time of the pickup.
55
56    @author
57        Eric Beier
58    */
59    class _PickupExport SpeedPickup : public Pickup
60    {
61        public:
62
63            SpeedPickup(BaseObject* creator); //!< Constructor.
64            virtual ~SpeedPickup(); //!< Destructor.
65
66            virtual void XMLPort(Element& xmlelement, orxonox::XMLPort::Mode mode); //!< Method for creating a HealthPickup object through XML.
67
68            virtual void changedUsed(void); //!< Is called when the pickup has transited from used to unused or the other way around.
69            virtual void clone(OrxonoxClass*& item); //!< Creates a duplicate of the input OrxonoxClass.
70
71            inline float getDuration(void)
72                { return this->duration_; }
73            inline float getSpeedAdd(void)
74                { return this->speedAdd_; }
75            inline float getSpeedMultiply(void)
76                { return this->speedMultiply_; }
77
78        protected:
79            void initializeIdentifier(void); //!< Initializes the PickupIdentifier of this pickup.
80           
81            virtual void pickupTimerCallback(void); //!< Function that gets called when timer ends.
82
83            void setDuration(float duration);
84            void setSpeedAdd(float speedAdd);
85            void setSpeedMultiply(float speedMultiply);
86
87        private:
88            void initialize(void); //!< Initializes the member variables.
89            Engine* carrierToEngineHelper(void); //!< Helper to transform the PickupCarrier to a Pawn, and throw an error message if the conversion fails.
90
91            float duration_; //!< The health that is transferred to the Pawn.
92            float speedAdd_;
93            float speedMultiply_;
94    };
95}
96
97#endif // _SpeedPickup_H__
Note: See TracBrowser for help on using the repository browser.