Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 7533 was 7493, checked in by dafrick, 14 years ago

Fixing small bug in Script (regarding number of executions).
Fixed bug in WorldEntity, that caused the visibility and activity to be synchronized incorrectly (since bVisibleMem and bActiveMem are not synchronized).
Some small changed in documentation.
Started "synchronizing" pickups. Seems to work (except GUI), but haven't done any extensive testing yet.

  • Property svn:eol-style set to native
File size: 3.4 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    @ingroup PickupItems
33*/
34
35#ifndef _SpeedPickup_H__
36#define _SpeedPickup_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
46namespace orxonox {
47
48    /**
49    @brief
50        A Pickup which can manipulate the Speed of a Pawn.
51
52        There are 4 parameters that can be cosen:
53        - The @b speed @b multiplier
54        - The @b additional (forward) @b speed
55        - The @b activation @b type 'immediate' or 'onUse'. defines if the item is used when it's picked up or only after the player chooses to use it.
56        - The @b duration The activation time of the pickup.
57
58    @author
59        Eric Beier
60    */
61    class _PickupExport SpeedPickup : public Pickup
62    {
63        public:
64
65            SpeedPickup(BaseObject* creator); //!< Constructor.
66            virtual ~SpeedPickup(); //!< Destructor.
67
68            virtual void XMLPort(Element& xmlelement, orxonox::XMLPort::Mode mode); //!< Method for creating a HealthPickup object through XML.
69
70            virtual void changedUsed(void); //!< Is called when the pickup has transited from used to unused or the other way around.
71            virtual void clone(OrxonoxClass*& item); //!< Creates a duplicate of the input OrxonoxClass.
72
73            inline float getDuration(void)
74                { return this->duration_; }
75            inline float getSpeedAdd(void)
76                { return this->speedAdd_; }
77            inline float getSpeedMultiply(void)
78                { return this->speedMultiply_; }
79
80        protected:
81            void initializeIdentifier(void); //!< Initializes the PickupIdentifier of this pickup.
82
83            void pickupTimerCallback(void); //!< Function that gets called when timer ends.
84
85            void setDuration(float duration);
86            void setSpeedAdd(float speedAdd);
87            void setSpeedMultiply(float speedMultiply);
88
89        private:
90            void initialize(void); //!< Initializes the member variables.
91            Engine* carrierToEngineHelper(void); //!< Helper to transform the PickupCarrier to a Pawn, and throw an error message if the conversion fails.
92
93            Timer durationTimer_; //!< Timer.
94
95            float duration_; //!< The health that is transferred to the Pawn.
96            float speedAdd_;
97            float speedMultiply_;
98    };
99}
100
101#endif // _SpeedPickup_H__
Note: See TracBrowser for help on using the repository browser.