Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/pickup3/src/modules/pickup/DroppedPickup.h @ 6475

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

Additional documentation, code niceifying and potential bug fixing. Also: Renamed DroppedItem to DroppedPickup.

  • Property svn:eol-style set to native
File size: 2.1 KB
RevLine 
[2917]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 *      Daniel 'Huty' Haggenmueller
24 *   Co-authors:
[6475]25 *      Damian 'Mozork' Frick
[2917]26 *
27 */
28
29/**
30    @file
[6475]31    @brief Definition of the DroppedPickup class.
[2917]32*/
33
[6475]34#ifndef _DroppedPickup_H__
35#define _DroppedPickup_H__
[2917]36
[6466]37#include "PickupPrereqs.h"
[2917]38
[5953]39#include "PickupSpawner.h"
[2917]40
41namespace orxonox
42{
[6475]43   
44    /**
45    @brief
46        Special PickupSpawner that is created whe a Pickupable is dropped. It just spawns one pickup, the one that was dropped.
47    @author
48        Daniel 'Huty' Haggenmueller
49        Damian 'Mozork' Frick
50    */
51    class _OrxonoxExport DroppedPickup : public PickupSpawner
[2917]52    {
[5953]53        public:
[6475]54            DroppedPickup(BaseObject* creator); //!< Default constructor.
55            DroppedPickup(BaseObject* creator, Pickupable* pickup, const Vector3& position, float triggerDistance = 10.0); //!< Constructor.
56            virtual ~DroppedPickup(); //!< Destructor.
[2917]57
[5953]58        protected:
[6475]59            virtual Pickupable* getPickup(void); //!< Creates the Pickupable that is going to get picked up.
[6421]60           
[5953]61        private:
[6475]62            void initialize(void); //!< Initializes the member variables of the object.
[6421]63           
[6475]64            bool gotPickedUp_; //!< Whether the pickup got picked up or not.
[2917]65
66    };
67}
68
[6475]69#endif /* _DroppedPickup_H__ */
Note: See TracBrowser for help on using the repository browser.