Pickup.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:
 *      Damian 'Mozork' Frick
 *   Co-authors:
 *      ...
 *
*/

#ifndef _Pickup_H__
#define _Pickup_H__

#include "pickup/PickupPrereqs.h"

#include "core/BaseObject.h"
#include "core/XMLPort.h"
#include "tools/Timer.h"

#include "CollectiblePickup.h"

namespace orxonox
{

    enum class PickupActivationType
    {
        immediate, 
        onUse, 
    };

    enum class PickupDurationType
    {
        once, 
        continuous, 
    };

    class _PickupExport Pickup : public CollectiblePickup, public BaseObject
    {

        public:
            Pickup(Context* context); 
            virtual ~Pickup(); 

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

            virtual const std::string& getRepresentationName() const override
                { return this->representationName_; }

            inline PickupActivationType getActivationType(void) const
                { return this->activationType_; }
            inline PickupDurationType getDurationType(void) const
                { return this->durationType_; }

            const std::string& getActivationTypeAsString(void) const; 
            const std::string& getDurationTypeAsString(void) const; 

            inline bool isImmediate(void) const
                { return this->getActivationType() == PickupActivationType::immediate; }
            inline bool isOnUse(void) const
                { return this->getActivationType() == PickupActivationType::onUse; }
            inline bool isOnce(void) const
                { return this->getDurationType() == PickupDurationType::once; }
            inline bool isContinuous(void) const
                { return this->getDurationType() == PickupDurationType::continuous; }

            virtual void changedPickedUp(void) override; 

        protected:
            virtual bool createSpawner(void) override; 

            inline void setRepresentationName(const std::string& name)
                { this->representationName_ = name; }

            inline void setActivationType(PickupActivationType type)
                { this->activationType_ = type; }
            inline void setDurationType(PickupDurationType type)
                { this->durationType_ = type; }

            void setActivationTypeAsString(const std::string& type); 
            void setDurationTypeAsString(const std::string& type); 

        private:
            void initialize(void); 

            std::string representationName_; 
            PickupActivationType activationType_; 
            PickupDurationType durationType_; 

            static const std::string activationTypeImmediate_s;
            static const std::string activationTypeOnUse_s;
            static const std::string durationTypeOnce_s;
            static const std::string durationTypeContinuous_s;
    };

}
#endif // _Pickup_H__