Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/masterserver/src/orxonox/interfaces/Pickupable.h @ 7998

Last change on this file since 7998 was 7494, checked in by dafrick, 14 years ago

Some documenting and cleaning up/re-organization in pickups module.

  • Property svn:eol-style set to native
File size: 8.8 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 *      Damian 'Mozork' Frick
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file Pickupable.h
31    @brief Definition of the Pickupable class.
32    @ingroup Pickup
33*/
34
35#ifndef _Pickupable_H__
36#define _Pickupable_H__
37
38#include "OrxonoxPrereqs.h"
39
40#include <list>
41#include "core/Super.h"
42
43#include "core/OrxonoxClass.h"
44#include "Rewardable.h"
45
46namespace orxonox // tolua_export
47{ // tolua_export
48
49    /**
50    @brief
51        An Interface (or more precisely an abstract class) to model and represent different (all kinds of) pickups.
52
53        Pickups (@ref orxonox:Pickupable "Pickupables") are objects that (quite unsurprisingly) can be picked up. Additionally they can be used and unused (transition from used to not used), and also dropped.
54
55        A class of Pickups can incorporate many different types of pickups (see @ref orxonox::PickupIdentifier "PickupIdentifier"), each type is uniquely defined by a @ref orxonox::PickupIdentifier "PickupIdentifier". Each pickup has such an identifier identiying its type. This means that two pickups of the same type have identifiers which are equal.
56
57    @author
58        Damian 'Mozork' Frick
59    */
60    class _OrxonoxExport Pickupable  // tolua_export
61        : virtual public OrxonoxClass, public Rewardable
62    {  // tolua_export
63        protected:
64            Pickupable(); //!< Default constructor.
65
66        public:
67            virtual ~Pickupable(); //!< Default destructor.
68
69            /**
70            @brief Get whether the Pickupable is currently in use or not.
71            @return Returns true if the Pickupable is currently in use.
72            */
73            inline bool isUsed(void) { return this->used_; }  // tolua_export
74            /**
75            @brief  Should be called when the Pickupable has transited from used to unused or the other way around.
76                    Any Class overwriting this method must call its SUPER function by adding SUPER(Classname, changedUsed); to their changdeUsed method.
77            */
78            virtual void changedUsed(void) {}
79
80            /**
81            @brief Get the carrier of the Pickupable.
82            @return Returns a pointer to the carrier of the Pickupable.
83            */
84            inline PickupCarrier* getCarrier(void)
85                { return this->carrier_; }
86            /**
87            @brief Should be called when the Pickupable has changed its PickupCarrier.
88                   Any Class overwriting this method must call its SUPER function by adding SUPER(Classname, changedCarrier); to their changedCarrier method.
89            */
90            virtual void changedCarrier(void) {}
91
92            /**
93            @brief Returns whether the Pickupable is currently picked up.
94            @return Returns true if the Pickupable is currently picked up, false if not.
95            */
96            inline bool isPickedUp(void) { return this->pickedUp_; }  // tolua_export
97            /**
98            @brief  Should be called when the Pickupable has transited from picked up to dropped or the other way around.
99                    Any Class overwriting this method must call its SUPER function by adding SUPER(Classname, changedPickedUp); to their changedPickedUp method.
100            */
101            virtual void changedPickedUp(void) {}
102
103            /**
104            @brief Returns whether the Pickupable can be used.
105            @return Returns true if it can be used.
106            */
107            inline bool isUsable(void) { return this->enabled_; } // tolua_export
108           
109            /**
110            @brief Returns whether the Pickupable can be unused.
111            @return Returns true if it can be unused.
112            */
113            inline bool isUnusable(void) { return this->enabled_; } // tolua_export
114
115            /**
116            @brief Returns whether the Pickupable is enabled.
117                   Once a Pickupable is disabled it cannot be enabled again. A Pickupable that is disabled can neither be used nor unused.
118            @return Returns true if the Pickupable is enabled.
119            */
120            inline bool isEnabled(void)
121                { return this->enabled_; }
122
123            bool pickup(PickupCarrier* carrier); //!< Can be called to pick up a Pickupable.
124            bool drop(bool createSpawner = true); //!< Can be called to drop a Pickupable.
125
126            virtual bool isTarget(PickupCarrier* carrier) const; //!< Get whether the given PickupCarrier is a target of this Pickupable.
127            bool isTarget(const Identifier* identifier) const; //!< Get whether a given class, represented by the input Identifier, is a target of this Pickupable.
128            bool addTarget(PickupCarrier* target); //!< Add a PickupCarrier as target of this Pickupable.
129            bool addTarget(Identifier* identifier); //!< Add a class, representetd by the input Identifier, as target of this Pickupable.
130
131            Pickupable* clone(void); //!< Creates a duplicate of the Pickupable.
132            virtual void clone(OrxonoxClass*& item); //!< Creates a duplicate of the input OrxonoxClass.
133
134            /**
135            @brief Get the PickupIdentifier of this Pickupable.
136            @return Returns a pointer to the PickupIdentifier of this Pickupable.
137            */
138            virtual const PickupIdentifier* getPickupIdentifier(void)
139                { return this->pickupIdentifier_; }
140
141            bool setUsed(bool used); //!< Sets the Pickupable to used or unused, depending on the input.
142            bool setPickedUp(bool pickedUp); //!< Helper method to set the Pickupable to either picked up or not picked up.
143            //TODO: private?
144            bool setCarrier(PickupCarrier* carrier, bool tell = true); //!< Sets the carrier of the Pickupable.
145
146            //TODO: private?
147            virtual void carrierDestroyed(void); //!< Is called by the PickupCarrier when it is being destroyed.
148
149            void destroy(void); //!< Is called internally within the Pickupable module to destroy pickups.
150
151        protected:
152            /**
153            @brief Helper method to initialize the PickupIdentifier.
154            */
155            void initializeIdentifier(void) {}
156
157            virtual void preDestroy(void); //!< A method that is called by OrxonoxClass::destroy() before the object is actually destroyed.
158            virtual void destroyPickup(void); //!< Destroys a Pickupable.
159
160            /**
161            @brief Sets the Pickuapble to disabled.
162            */
163            inline void setDisabled(void)
164                { this->enabled_ = false; }
165
166            /**
167            @brief Facilitates the creation of a PickupSpawner upon dropping of the Pickupable.
168                   This method must be implemented by any class directly inheriting from Pickupable. It is most easily done by just creating a new DroppedPickup, e.g.:
169                   DroppedPickup(BaseObject* creator, Pickupable* pickup, PickupCarrier* carrier, float triggerDistance);
170            @return Returns true if a spawner was created, false if not.
171            */
172            virtual bool createSpawner(void) = 0;
173
174            PickupIdentifier* pickupIdentifier_; //!< The PickupIdentifier of this Pickupable.
175
176        private:
177
178            bool used_; //!< Whether the Pickupable is currently in use or not.
179            bool pickedUp_; //!< Whether the Pickupable is currently picked up or not.
180
181            bool enabled_; //!< Whether the Pickupable is enabled or not.
182
183            PickupCarrier* carrier_; //!< The PickupCarrier of the Pickupable.
184            std::list<Identifier*> targets_; //!< The possible targets of this Pickupable.
185
186            bool beingDestroyed_; //!< Is true if the Pickupable is in the process of being destroyed.
187
188        // For implementing the Rewardable interface:
189        public:
190            virtual bool reward(PlayerInfo* player); //!< Method to transcribe a Pickupable as a Rewardable to the player.
191
192    };  // tolua_export
193
194    //! SUPER functions.
195    SUPER_FUNCTION(10, Pickupable, changedUsed, false);
196    SUPER_FUNCTION(12, Pickupable, changedCarrier, false);
197    SUPER_FUNCTION(13, Pickupable, changedPickedUp, false);
198}  // tolua_export
199
200#endif /* _Pickupable_H__ */
Note: See TracBrowser for help on using the repository browser.