Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/mergeFS18/src/modules/pickup/items/BoostPickup.h @ 12243

Last change on this file since 12243 was 11071, checked in by landauf, 9 years ago

merged branch cpp11_v3 back to trunk

  • Property svn:eol-style set to native
File size: 2.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 *      Fabien Vultier
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file BoostPickup.h
31    @brief Declaration of the BoostPickup class.
32    @ingroup PickupItems
33*/
34
35#ifndef _BoostPickup_H__
36#define _BoostPickup_H__
37
38#include "pickup/PickupPrereqs.h"
39
40#include <string>
41
42#include "pickup/Pickup.h"
43
44namespace orxonox
45{
46
47    class _PickupExport BoostPickup : public Pickup
48    {
49        public:
50
51            BoostPickup(Context* context); //!< Constructor.
52            virtual ~BoostPickup(); //!< Destructor.
53
54            virtual void XMLPort(Element& xmlelement, orxonox::XMLPort::Mode mode) override; //!< Method for creating a BoostPickup object through XML.
55
56            virtual void changedUsed(void) override; //!< Is called when the pickup has transited from used to unused or the other way around.
57            inline float getBoostRefill()
58                { return this->boostRefill_; }
59
60        protected:
61            void setBoostRefill(float boostRefill); //!< Sets the boost refill according to the XML.
62
63        private:
64            void initialize(void); //!< Initializes the member variables.
65            Pawn* carrierToPawnHelper(void); //!< Helper to transform the PickupCarrier to a Pawn, and throw an error message if the conversion fails.
66            SpaceShip* carrierToSpaceShipHelper(void); //!< Helper to transform the PickupCarrier to a SpaceShip, and throw an error message if the conversion fails.
67
68            float boostRefill_; //!< The amount of boost refilled by the user of the pickup. 1.0 means full refill, 0.5 means half refill.
69    };
70}
71
72#endif /* _BoostPickup_H__ */
Note: See TracBrowser for help on using the repository browser.