Pickupable.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 _Pickupable_H__
#define _Pickupable_H__

#include "OrxonoxPrereqs.h"

#include <list>
#include "core/class/Super.h"

#include "core/class/OrxonoxInterface.h"
#include "Rewardable.h"

namespace orxonox
{

    class _OrxonoxExport Pickupable : virtual public OrxonoxInterface, public Rewardable
    {
        friend class PickupCarrier;

        protected:
            Pickupable(); 

        public:
            virtual ~Pickupable(); 

            virtual const std::string& getRepresentationName() const = 0;

            inline bool isUsed(void) const
                { return this->used_; }
            virtual void changedUsed(void) {}

            inline PickupCarrier* getCarrier(void)
                { return this->carrier_; }
            virtual void changedCarrier(void) {}

            inline bool isPickedUp(void) const
                { return this->pickedUp_; }
            virtual void changedPickedUp(void) {}

            inline bool isUsable(void) const
                { return this->enabled_; }

            inline bool isUnusable(void) const
                { return this->enabled_; }

            inline bool isEnabled(void) const
                { return this->enabled_; }

            bool pickup(PickupCarrier* carrier); 
            bool drop(bool createSpawner = true); 

            virtual bool isTarget(const PickupCarrier* carrier) const; 
            bool isTarget(const Identifier* identifier) const; 
            bool addTarget(PickupCarrier* target); 
            bool addTarget(Identifier* identifier); 

            bool setUsed(bool used); 
            bool setPickedUp(bool pickedUp); 
            bool setCarrier(PickupCarrier* carrier, bool tell = true); 

            void destroy(void); 

        protected:
            virtual void preDestroy(void) override; 
            virtual void destroyPickup(void); 
            virtual void carrierDestroyed(void); 

            inline void setDisabled(void)
                { this->enabled_ = false; }

            inline bool isBeingDestroyed(void)
                { return this->beingDestroyed_; }

            virtual bool createSpawner(void) = 0;

        private:

            bool used_; 
            bool pickedUp_; 

            bool enabled_; 

            PickupCarrier* carrier_; 
            std::list<Identifier*> targets_; 

            bool beingDestroyed_; 

        // For implementing the Rewardable interface:
        public:
            virtual bool reward(PlayerInfo* player) override; 

    };

    SUPER_FUNCTION(9, Pickupable, changedUsed, false);
    SUPER_FUNCTION(10, Pickupable, changedCarrier, false);
    SUPER_FUNCTION(11, Pickupable, changedPickedUp, false);
}

#endif /* _Pickupable_H__ */