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 | * Benedict Simlinger |
---|
24 | * Co-authors: |
---|
25 | * ... |
---|
26 | * |
---|
27 | */ |
---|
28 | |
---|
29 | /** |
---|
30 | @file InvisiblePickup.h |
---|
31 | @brief Declaration of the InvisiblePickup class. |
---|
32 | @ingroup PickupItems |
---|
33 | */ |
---|
34 | |
---|
35 | #ifndef _InvisiblePickup_H__ |
---|
36 | #define _InvisiblePickup_H__ |
---|
37 | |
---|
38 | #include "pickup/PickupPrereqs.h" |
---|
39 | |
---|
40 | #include <string> |
---|
41 | |
---|
42 | #include <worldentities/pawns/Pawn.h> |
---|
43 | #include "worldentities/StaticEntity.h" |
---|
44 | #include "pickup/Pickup.h" |
---|
45 | |
---|
46 | namespace orxonox { |
---|
47 | |
---|
48 | /** |
---|
49 | @brief |
---|
50 | A pickup that makes the Pawn invisible. |
---|
51 | There are 2 parameters that can be chosen: |
---|
52 | - The <b>activation type</b> It can be chosen to be either <em>immediate</em> or <em>onUse</em>. The activation type essentially (as indicated by the name) defines when the Pawn will be invisible, either immediately after being picked up or only after the player uses it. |
---|
53 | - The <b>duration type</b> It can be chosen to be either <em>once</em> or <em>continuous</em>. For <em>once</em> the InvisiblePickup just makes the Pawn invisible for as long as it is used, for <em>continuous</em> the Pawn is invisible for the specified duration. |
---|
54 | - The <b>duration</b> Specifies how long (in seconds) the invisibility lasts. |
---|
55 | |
---|
56 | An examle of a XML implementation of a InvisiblePickup would be: |
---|
57 | @code |
---|
58 | <HealthPickup |
---|
59 | activationType = "immediate" |
---|
60 | durationType = "continuous" |
---|
61 | duration = 30.0 |
---|
62 | /> |
---|
63 | @endcode |
---|
64 | |
---|
65 | @author |
---|
66 | Benedict Simlinger |
---|
67 | |
---|
68 | @ingroup PickupItems |
---|
69 | */ |
---|
70 | class _PickupExport InvisiblePickup : public Pickup |
---|
71 | { |
---|
72 | public: |
---|
73 | |
---|
74 | InvisiblePickup(BaseObject* creator); //!< Constructor. |
---|
75 | virtual ~InvisiblePickup(); //!< Destructor. |
---|
76 | |
---|
77 | virtual void XMLPort(Element& xmlelement, orxonox::XMLPort::Mode mode); //!< Method for creating a HealthPickup object through XML. |
---|
78 | virtual void changedUsed(void); //!< Is called when the pickup has transited from used to unused or the other way around. |
---|
79 | virtual void clone(OrxonoxClass*& item); //!< Creates a duplicate of the input OrxonoxClass. |
---|
80 | |
---|
81 | /** |
---|
82 | @brief Checks whether the Pawn is invisible. |
---|
83 | @return Returns if the Pawn is invisible. |
---|
84 | */ |
---|
85 | inline bool getInvisibility(bool) |
---|
86 | { return this->invisible_; } |
---|
87 | /** |
---|
88 | @brief Get the time the InvisibilityPickup lasts. |
---|
89 | @return Returns the time in seconds the InvisibiltyPickup lasts. |
---|
90 | */ |
---|
91 | inline float getDuration(void) |
---|
92 | { return this->duration_; } |
---|
93 | |
---|
94 | protected: |
---|
95 | void initializeIdentifier(void); |
---|
96 | |
---|
97 | bool setInvisible(bool invisibility); //!< Set the Pawn to be invisible or visible again. |
---|
98 | void setDuration(float duration); //!< Sets the time the InvisibilityPickup will last. |
---|
99 | |
---|
100 | void pickupTimerCallback(void); //!< Helper method. Is called by the Timer as soon as it expires. |
---|
101 | |
---|
102 | private: |
---|
103 | void initialize(void); //!< Initializes the member variables. |
---|
104 | Pawn* carrierToPawnHelper(void); //!< Helper to transform the PickupCarrier to a Pawn, and throw an error message if the conversion fails. |
---|
105 | |
---|
106 | Timer durationTimer_; //!< Timer. |
---|
107 | |
---|
108 | bool invisible_; //!< Helper to remember wether the Pawn is invisible. |
---|
109 | float duration_; //! Duration of invisibility. |
---|
110 | }; |
---|
111 | } |
---|
112 | |
---|
113 | #endif // _InvisiblePickup_H__ |
---|