Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/pickup/PickupSpawner.h @ 12054

Last change on this file since 12054 was 11783, checked in by landauf, 7 years ago

merged Presentation_HS17_merge back to trunk

  • Property svn:eol-style set to native
File size: 7.9 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/**
[6540]30    @file PickupSpawner.h
31    @brief Definition of the PickupSpawner class.
[7456]32    @ingroup Pickup
[2917]33*/
34
35#ifndef _PickupSpawner_H__
36#define _PickupSpawner_H__
37
[6466]38#include "PickupPrereqs.h"
[2917]39
[7549]40#include <map>
[3196]41#include <string>
42#include "tools/Timer.h"
[6475]43
[7540]44#include "interfaces/Pickupable.h"
45
[5693]46#include "tools/interfaces/Tickable.h"
[5735]47#include "worldentities/StaticEntity.h"
[2917]48
49namespace orxonox
50{
51    /**
[6475]52        @brief
[7540]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.
[7494]58
[7540]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
[6475]69        @author
70            Daniel 'Huty' Haggenmueller
[7494]71        @author
[6475]72            Damian 'Mozork' Frick
[7540]73
74        @ingroup Pickup
[2917]75    */
[6496]76    class _PickupExport PickupSpawner : public StaticEntity, public Tickable
[2917]77    {
[5947]78        public:
[9667]79            PickupSpawner(Context* context); //!< Default Constructor.
[6475]80            virtual ~PickupSpawner(); //!< Destructor.
[2917]81
[9667]82            static PickupSpawner* createDroppedPickup(Context* context, Pickupable* pickup, PickupCarrier* carrier, float triggerDistance = 10.0);
[9348]83
[11071]84            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override;  //!< Method for creating a PickupSpawner through XML.
85            virtual void tick(float dt) override; //!< Tick, checks if any Pawn is close enough to trigger.
[2917]86
[5947]87            /**
[6475]88            @brief Get the distance in which to trigger.
89            @return Returns the distance in which this gets triggered.
[5947]90            */
91            inline float getTriggerDistance() const
92                { return this->triggerDistance_; }
93            /**
[11783]94            @brief Set the distance in which to trigger.
95            @param value The new distance in which to trigger.
96            */
97            inline void setTriggerDistance(float value)
98                { this->triggerDistance_ = value; }
99            /**
[6475]100            @brief Get the time to respawn.
101            @returns Returns the time after which this gets re-actived.
[5947]102            */
103            inline float getRespawnTime() const
104                { return this->respawnTime_; }
105            /**
[11783]106            @brief Set the time to respawn.
107            @param time New time after which this gets re-actived.
108            */
109            inline void setRespawnTime(float time)
110                { this->respawnTime_ = time; }
111            /**
[6475]112            @brief Get the maximum number of items that will be spawned by this PickupSpawner.
113            @return Returns the maximum number of items spawned by this PickupSpawner.
[6421]114            */
[7547]115            inline int getMaxSpawnedItems(void) const
[5953]116                { return this->maxSpawnedItems_; }
[11783]117            void setMaxSpawnedItems(int items); //!< Sets the maximum number of spawned items.
118
[9348]119            /**
120            @brief Returns the name of the template which is used to create a pickup for this spawner.
121            */
122            inline const std::string& getPickupTemplateName() const
123                { return this->pickupTemplateName_; }
124            /**
125            @brief Returns the template which is used to create a pickup for this spawner.
126            */
127            inline Template* getPickupTemplate() const
128                {return this->pickupTemplate_; }
[5953]129
[11783]130            void setPickupTemplateName(const std::string& name);
131            void setPickupTemplate(Template* temp);
132
[9348]133        private:
134            void initialize(void);
135
136            void trigger(PickupCarrier* carrier); //!< Method called when a carrier is close enough.
137            void respawnTimerCallback(); //!< Method called when the timer runs out.
138
[6475]139            void decrementSpawnsRemaining(void); //!< Decrements the number of remaining spawns.
[7549]140            void startRespawnTimer(void); //!< Invoked by the timer, re-activates the PickupSpawner.
[7163]141
[7547]142            /**
[7549]143            @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.
144            @param carrier A pointer to the PickupCarrier to be blocked.
145            @param time The time for which the Pawn is blocked. Default is 5.
146            */
147            void block(PickupCarrier* carrier, unsigned int time = DEFAULT_BLOCKED_TIME)
148                { this->blocked_.insert(std::pair<PickupCarrier*, std::time_t>(carrier, std::time(0)+time)); }
149
[9348]150            Pickupable* createPickup(void); //!< Creates a new Pickupable.
[6475]151            void setPickupable(Pickupable* pickup); //!< Sets a Pickupable for the PickupSpawner to spawn.
[7163]152
[6421]153            Pickupable* pickup_; //!< The pickup to be spawned.
[9348]154            StaticEntity* representation_; //!< The active representation of the spawner.
155            std::string pickupTemplateName_; //!< The name of the pickup template.
156            Template* pickupTemplate_; //!< The template to be used to create a pickupable.
[5953]157
[6475]158            int maxSpawnedItems_; //!< Maximum number of items spawned by this PickupSpawner.
159            int spawnsRemaining_; //!< Number of items that can be spawned by this PickupSpawner until it selfdestructs.
[5953]160
[6475]161            float triggerDistance_; //!< Distance in which this gets triggered.
[2917]162
[6475]163            float respawnTime_; //!< Time after which this gets re-actived.
164            Timer respawnTimer_; //!< Timer used for re-activating.
[7549]165            std::map<PickupCarrier*, std::time_t> blocked_;
[3046]166
[7163]167            bool selfDestruct_; //!< True if the PickupSpawner is selfdestructing.
168
[6475]169            static const int INF = -1; //!< Constant for infinity.
[7549]170            static const unsigned int DEFAULT_BLOCKED_TIME = 5; //!< The default time a PickupCarrier is blocked after picking up a Pickupable.
[2917]171    };
172}
173
174#endif /* _PickupSpawner_H__ */
Note: See TracBrowser for help on using the repository browser.