Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/tutorial/src/modules/pickup/PickupSpawner.h @ 11468

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

Resolving some more TODO's.

  • Property svn:eol-style set to native
File size: 7.3 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 *      Daniel 'Huty' Haggenmueller
24 *   Co-authors:
25 *      Damian 'Mozork' Frick
26 *
27 */
28
29/**
30    @file PickupSpawner.h
31    @brief Definition of the PickupSpawner class.
32    @ingroup Pickup
33*/
34
35#ifndef _PickupSpawner_H__
36#define _PickupSpawner_H__
37
38#include "PickupPrereqs.h"
39
40#include <map>
41#include <string>
42#include "tools/Timer.h"
43
44#include "interfaces/Pickupable.h"
45
46#include "tools/interfaces/Tickable.h"
47#include "worldentities/StaticEntity.h"
48
49namespace orxonox
50{
51    /**
52        @brief
53            The PickupSpawner class is responsible for spawning @ref orxonox::Pickupable "Pickupables" of a specific type.
54            Furthermore it can be specified how long the time interval between spawning two items is and how many @ref orxonox::Pickupable "Pickupables" are spawned at maximum, amongst other things. The parameters that can be used to further specify the behaviour of the PickupSpawner are:
55            - The <b>triggerDistance</b> can be used to specify how far away an entity has to be to still trigger the PickupSPawner (and thus receive a @ref orxonox::Pickupable "Pickupable" form it). The default is 10.
56            - The <b>respawnTime</b> is the time in seconds that passes until the PickupSpawner is enabled again, after having spawned a @ref orxonox::Pickupable "Pickupable". The default is 0.
57            - The <b>maxSpawnedItems</b> is the number of @ref orxonox::Pickupable "Pickupables" that are spawned by this PickupSpawner at the most. The default is -1, which denotes infinity.
58
59            A PickupSpawner is created in XML, which can be done in the following fashion:
60            @code
61            <PickupSpawner position="-100,0,-100" respawnTime="30" maxSpawnedItems="10">
62                <pickup>
63                    <SomePickup >
64                </pickup>
65            </PickupSpawner>
66            @endcode
67            As we can see, since the PickupSpawner is a StaticEntity, it also has spatial coordinates. We can also see, that the type of @ref orxonox::Pickupable "Pickupable" which is spawned hast to be specified as well.
68
69        @author
70            Daniel 'Huty' Haggenmueller
71        @author
72            Damian 'Mozork' Frick
73
74        @ingroup Pickup
75    */
76    class _PickupExport PickupSpawner : public StaticEntity, public Tickable
77    {
78        public:
79            PickupSpawner(BaseObject* creator); //!< Default Constructor.
80            PickupSpawner(BaseObject* creator, Pickupable* pickup, float triggerDistance, float respawnTime, int maxSpawnedItems); //!< Constructor.
81            virtual ~PickupSpawner(); //!< Destructor.
82
83            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);  //!< Method for creating a PickupSpawner through XML.
84            virtual void changedActivity(); //!< Invoked when activity has changed (set visibilty).
85            virtual void tick(float dt); //!< Tick, checks if any Pawn is close enough to trigger.
86
87            /**
88            @brief Get the distance in which to trigger.
89            @return Returns the distance in which this gets triggered.
90            */
91            inline float getTriggerDistance() const
92                { return this->triggerDistance_; }
93            /**
94            @brief Get the time to respawn.
95            @returns Returns the time after which this gets re-actived.
96            */
97            inline float getRespawnTime() const
98                { return this->respawnTime_; }
99            /**
100            @brief Get the maximum number of items that will be spawned by this PickupSpawner.
101            @return Returns the maximum number of items spawned by this PickupSpawner.
102            */
103            inline int getMaxSpawnedItems(void) const
104                { return this->maxSpawnedItems_; }
105
106        protected:
107            void decrementSpawnsRemaining(void); //!< Decrements the number of remaining spawns.
108            void startRespawnTimer(void); //!< Invoked by the timer, re-activates the PickupSpawner.
109
110            /**
111            @brief Helper method. Adds a PickupCarrier to the list of PickupCarrier that are blocked form getting a Pickupable from the PickupSpawner for a specified time.
112            @param carrier A pointer to the PickupCarrier to be blocked.
113            @param time The time for which the Pawn is blocked. Default is 5.
114            */
115            void block(PickupCarrier* carrier, unsigned int time = DEFAULT_BLOCKED_TIME)
116                { this->blocked_.insert(std::pair<PickupCarrier*, std::time_t>(carrier, std::time(0)+time)); }
117
118            /**
119            @brief Set the distance in which to trigger.
120            @param value The new distance in which to trigger.
121            */
122            inline void setTriggerDistance(float value)
123                { this->triggerDistance_ = value; }
124            /**
125            @brief Set the time to respawn.
126            @param time New time after which this gets re-actived.
127            */
128            inline void setRespawnTime(float time)
129                { this->respawnTime_ = time; }
130            void setMaxSpawnedItems(int items); //!< Sets the maximum number of spawned items.
131
132            virtual Pickupable* getPickup(void); //!< Creates a new Pickupable.
133
134            void setPickupable(Pickupable* pickup); //!< Sets a Pickupable for the PickupSpawner to spawn.
135            const Pickupable* getPickupable(void) const; //!< Get the Pickupable that is spawned by this PickupSpawner.
136
137            Pickupable* pickup_; //!< The pickup to be spawned.
138
139        private:
140            void initialize(void);
141
142            void trigger(Pawn* pawn); //!< Method called when a Pawn is close enough.
143            void respawnTimerCallback(); //!< Method called when the timer runs out.
144
145            int maxSpawnedItems_; //!< Maximum number of items spawned by this PickupSpawner.
146            int spawnsRemaining_; //!< Number of items that can be spawned by this PickupSpawner until it selfdestructs.
147
148            float triggerDistance_; //!< Distance in which this gets triggered.
149
150            float respawnTime_; //!< Time after which this gets re-actived.
151            Timer respawnTimer_; //!< Timer used for re-activating.
152            std::map<PickupCarrier*, std::time_t> blocked_;
153
154            bool selfDestruct_; //!< True if the PickupSpawner is selfdestructing.
155
156            static const int INF = -1; //!< Constant for infinity.
157            static const unsigned int DEFAULT_BLOCKED_TIME = 5; //!< The default time a PickupCarrier is blocked after picking up a Pickupable.
158    };
159}
160
161#endif /* _PickupSpawner_H__ */
Note: See TracBrowser for help on using the repository browser.