Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/pickup/items/DronePickup.h @ 7536

Last change on this file since 7536 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: 2.5 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 *      Lukas Gasser
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file DronePickup.h
31    @brief Declaration of the DronePickup class.
32    @ingroup PickupItems
33*/
34
35#ifndef _DronePickup_H__
36#define _DronePickup_H__
37
38#include "pickup/PickupPrereqs.h"
39
40#include <string>
41#include <worldentities/pawns/Pawn.h>
42#include <worldentities/Drone.h>
43
44#include "worldentities/StaticEntity.h"
45
46#include "pickup/Pickup.h"
47#include "tools/interfaces/Tickable.h"
48
49namespace orxonox {
50
51
52    class _PickupExport DronePickup : public Pickup, public Tickable
53    {
54        public:
55
56            DronePickup(BaseObject* creator); //!< Constructor.
57            virtual ~DronePickup(); //!< Destructor.
58
59            virtual void XMLPort(Element& xmlelement, orxonox::XMLPort::Mode mode); //!< Method for creating a DronePickup object through XML.
60
61            virtual void changedUsed(void); //!< Is called when the pickup has transited from used to unused or the other way around.
62            virtual void clone(OrxonoxClass*& item); //!< Creates a duplicate of the input OrxonoxClass.
63
64            void setDroneTemplate(std::string templatename);
65            const std::string& getDroneTemplate() const;
66
67        protected:
68            void initializeIdentifier(void); //!< Initializes the PickupIdentifier of this pickup.
69
70        private:
71            void initialize(void); //!< Initializes the member variables.
72            std::string droneTemplate_;
73            Pawn* carrierToPawnHelper(void); //!< Helper to transform the PickupCarrier to a Pawn, and throw an error message if the conversion fails.
74
75
76
77    };
78}
79
80#endif // _DronePickup_H__
Note: See TracBrowser for help on using the repository browser.