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 CollectiblePickup.h |
---|
31 | @brief Definition of the CollectiblePickup class. |
---|
32 | @ingroup Pickup |
---|
33 | */ |
---|
34 | |
---|
35 | #ifndef _CollectiblePickup_H__ |
---|
36 | #define _CollectiblePickup_H__ |
---|
37 | |
---|
38 | #include "pickup/PickupPrereqs.h" |
---|
39 | |
---|
40 | #include "interfaces/Pickupable.h" |
---|
41 | |
---|
42 | namespace orxonox { |
---|
43 | |
---|
44 | /** |
---|
45 | @brief |
---|
46 | The CollectiblePickup class encompasses all @ref orxonox::Pickupable "Pickupables" that can be added to a @ref orxonox::PickupCollection "PickupCollection" and thus be part of such. |
---|
47 | |
---|
48 | All you need to do to make your @ref orxonox::Pickupable "Pickupable" a CollectiblePickup is to, in some way, inherit from it. (The @ref orxonox::Pickup "Pickup" class, for example, is already a CollectiblePickup). |
---|
49 | |
---|
50 | @author |
---|
51 | Damian 'Mozork' Frick |
---|
52 | |
---|
53 | @ingroup Pickup |
---|
54 | */ |
---|
55 | class _PickupExport CollectiblePickup : public Pickupable |
---|
56 | { |
---|
57 | |
---|
58 | public: |
---|
59 | CollectiblePickup(); //!< Constructor. |
---|
60 | virtual ~CollectiblePickup(); //! Destructor. |
---|
61 | |
---|
62 | virtual void changedUsed(void); //!< Is called when the pickup has transited from used to unused or the other way around. |
---|
63 | virtual void changedPickedUp(void); //!< Is called when the pickup has transited from picked up to dropped or the other way around. |
---|
64 | |
---|
65 | /** |
---|
66 | @brief Check whether the given CollectiblePickup is par of a PickupCollection. |
---|
67 | @return Returns true if the CollectiblePickup is part of a PickupCollection. |
---|
68 | */ |
---|
69 | bool isInCollection(void) const |
---|
70 | { return this->isInCollection_; } |
---|
71 | |
---|
72 | bool addToCollection(PickupCollection* collection); //!< Adds this CollectiblePickup to the input PickupCollection. |
---|
73 | bool removeFromCollection(void); //!< Removes this CollectiblePickup from its PickupCollection. |
---|
74 | |
---|
75 | void carrierDestroyed(void); //!< Is called by the PickupCarrier when it is being destroyed. |
---|
76 | |
---|
77 | protected: |
---|
78 | virtual void preDestroy(void); //!< Is called by OrxonoxClass::destroy() before the object is actually destroyed. |
---|
79 | virtual void destroyPickup(void); //!< Destroys a Pickupable. |
---|
80 | |
---|
81 | private: |
---|
82 | bool isInCollection_; //!< True if the CollectiblePickup is in a PickupCollection. |
---|
83 | PickupCollection* collection_; //!< A pointer to the PickupCollection this CollectiblePickup is in. |
---|
84 | |
---|
85 | }; |
---|
86 | } |
---|
87 | |
---|
88 | #endif // _CollectiblePickup_H__ |
---|