Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/pickup/CollectiblePickup.h @ 7474

Last change on this file since 7474 was 7456, checked in by dafrick, 14 years ago

Reviewing documentation fo Questsystem, moving documentation fully into doxygen.
Added some files to modules they belong to.

  • Property svn:eol-style set to native
File size: 3.0 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 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
42namespace orxonox {
43
44    /**
45    @brief
46        Collectible Pickup class. Any pickup inheriting from this class can be added to a PickupCollection and thus be part uf such.
47    @author
48        Damian 'Mozork' Frick
49    */
50    class _PickupExport CollectiblePickup : public Pickupable
51    {
52
53        public:
54            CollectiblePickup(); //!< Constructor.
55            virtual ~CollectiblePickup(); //! Destructor.
56
57            virtual void changedUsed(void); //!< Is called when the pickup has transited from used to unused or the other way around.
58            virtual void changedPickedUp(void); //!< Is called when the pickup has transited from picked up to dropped or the other way around.
59
60            /**
61            @brief Check whether the given CollectiblePickup is par of a PickupCollection.
62            @return Returns true if the ColelctiblePickup is part of a PickupCollection.
63            */
64            bool isInCollection(void)
65                { return this->isInCollection_; }
66           
67            bool addToCollection(PickupCollection* collection); //!< Adds this CollectiblePickup to the input PickupCollection.
68            bool removeFromCollection(void); //!< Removes this CollectiblePickup from its PickupCollection.
69
70            void carrierDestroyed(void); //!< Is called by the PickupCarrier when it is being destroyed.
71
72        protected:
73            virtual void preDestroy(void); //!< Is called by OrxonoxClass::destroy() before the object is actually destroyed.
74            virtual void destroyPickup(void); //!< //!< Destroys a Pickupable.
75
76        private:
77            bool isInCollection_; //!< True if the CollectiblePickup is in a PickupCollection.
78            PickupCollection* collection_; //!< A pointer to the PickupCollection this CollectiblePickup is in.
79
80    };
81}
82
83#endif // _CollectiblePickup_H__
Note: See TracBrowser for help on using the repository browser.