Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 8620 was 7547, checked in by dafrick, 14 years ago

Documenting and cleanup.

  • Property svn:eol-style set to native
File size: 2.9 KB
RevLine 
[6782]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.
[7456]32    @ingroup PickupItems
[6782]33*/
34
35#ifndef _DronePickup_H__
36#define _DronePickup_H__
37
38#include "pickup/PickupPrereqs.h"
39
40#include <string>
41
42#include "pickup/Pickup.h"
43#include "tools/interfaces/Tickable.h"
44
45namespace orxonox {
46
[7541]47    /**
48    @brief
49        The DronePickup adds a Drone to the Pawn upon being picked up.
[7547]50
[7541]51        It can be used in XML as follows:
52        @code
53        <DronePickup droneTemplate="myDroneTemplate" />
54        @endcode
55        Where <em>droneTemplate</em> specifies a @ref orxonox::Template "Template" based on which the Drone is created.
[7127]56
[7541]57    @author
58        Lukas Gassner
59
60    @ingroup PickupItems
61    */
[6782]62    class _PickupExport DronePickup : public Pickup, public Tickable
63    {
64        public:
[7127]65
[6782]66            DronePickup(BaseObject* creator); //!< Constructor.
67            virtual ~DronePickup(); //!< Destructor.
[7127]68
[6782]69            virtual void XMLPort(Element& xmlelement, orxonox::XMLPort::Mode mode); //!< Method for creating a DronePickup object through XML.
[7127]70
[6782]71            virtual void changedUsed(void); //!< Is called when the pickup has transited from used to unused or the other way around.
72            virtual void clone(OrxonoxClass*& item); //!< Creates a duplicate of the input OrxonoxClass.
73
[7541]74            const std::string& getDroneTemplate() const; //!< Get the name of the droneTemplate.
[7127]75
[6782]76        protected:
77            void initializeIdentifier(void); //!< Initializes the PickupIdentifier of this pickup.
[7127]78
[7547]79            void setDroneTemplate(std::string templatename); //!< Set the droneTemplate.
80
[6782]81        private:
82            void initialize(void); //!< Initializes the member variables.
[7541]83            std::string droneTemplate_; //!< The name of the template, based upon which the Drone is created.
[6782]84            Pawn* carrierToPawnHelper(void); //!< Helper to transform the PickupCarrier to a Pawn, and throw an error message if the conversion fails.
85
[7127]86
87
[6782]88    };
89}
90
91#endif // _DronePickup_H__
Note: See TracBrowser for help on using the repository browser.