PickupSpawner.h

Go to the documentation of this file.

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   This program is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU General Public License
 *   as published by the Free Software Foundation; either version 2
 *   of the License, or (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Daniel 'Huty' Haggenmueller
 *   Co-authors:
 *      Damian 'Mozork' Frick
 *
 */

#ifndef _PickupSpawner_H__
#define _PickupSpawner_H__

#include "PickupPrereqs.h"

#include <map>
#include <string>
#include "tools/Timer.h"

#include "interfaces/Pickupable.h"

#include "tools/interfaces/Tickable.h"
#include "worldentities/StaticEntity.h"

namespace orxonox
{
    class _PickupExport PickupSpawner : public StaticEntity, public Tickable
    {
        public:
            PickupSpawner(Context* context); 
            virtual ~PickupSpawner(); 

            static PickupSpawner* createDroppedPickup(Context* context, Pickupable* pickup, PickupCarrier* carrier, float triggerDistance = 10.0);

            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override;  
            virtual void tick(float dt) override; 

            inline float getTriggerDistance() const
                { return this->triggerDistance_; }
            inline void setTriggerDistance(float value)
                { this->triggerDistance_ = value; }
            inline float getRespawnTime() const
                { return this->respawnTime_; }
            inline void setRespawnTime(float time)
                { this->respawnTime_ = time; }
            inline int getMaxSpawnedItems(void) const
                { return this->maxSpawnedItems_; }
            void setMaxSpawnedItems(int items); 

            inline const std::string& getPickupTemplateName() const
                { return this->pickupTemplateName_; }
            inline Template* getPickupTemplate() const
                {return this->pickupTemplate_; }

            void setPickupTemplateName(const std::string& name);
            void setPickupTemplate(Template* temp);

        private:
            void initialize(void);

            void trigger(PickupCarrier* carrier); 
            void respawnTimerCallback(); 

            void decrementSpawnsRemaining(void); 
            void startRespawnTimer(void); 

            void block(PickupCarrier* carrier, unsigned int time = DEFAULT_BLOCKED_TIME)
                { this->blocked_.insert(std::pair<PickupCarrier*, std::time_t>(carrier, std::time(0)+time)); }

            Pickupable* createPickup(void); 
            void setPickupable(Pickupable* pickup); 

            Pickupable* pickup_; 
            StaticEntity* representation_; 
            std::string pickupTemplateName_; 
            Template* pickupTemplate_; 

            int maxSpawnedItems_; 
            int spawnsRemaining_; 

            float triggerDistance_; 

            float respawnTime_; 
            Timer respawnTimer_; 
            std::map<PickupCarrier*, std::time_t> blocked_;

            bool selfDestruct_; 

            static const int INF = -1; 
            static const unsigned int DEFAULT_BLOCKED_TIME = 5; 
    };
}

#endif /* _PickupSpawner_H__ */