HealthPickup.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 _HealthPickup_H__
#define _HealthPickup_H__

#include "pickup/PickupPrereqs.h"

#include <string>

#include "pickup/Pickup.h"
#include "tools/interfaces/Tickable.h"

namespace orxonox {

    enum class PickupHealthType
    {
        limited, 
        temporary, 
        permanent 
    };

    class _PickupExport HealthPickup : public Pickup, public Tickable
    {
        public:

            HealthPickup(Context* context); 
            virtual ~HealthPickup(); 

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

            virtual void changedUsed(void); 

            inline float getHealth(void) const
                { return this->health_; }
            inline float getHealthRate(void) const
                { return this->healthRate_; }

            inline PickupHealthType getHealthType(void) const
                { return this->healthType_; }
            const std::string& getHealthTypeAsString(void) const; 

        protected:
            void setHealth(float health); 
            void setHealthRate(float speed); 

            inline void setHealthType(PickupHealthType type)
                { this->healthType_ = type; }
            void setHealthTypeAsString(const std::string& type); 

        private:
            void initialize(void); 
            Pawn* carrierToPawnHelper(void); 

            float health_; 
            float healthRate_; 
            float maxHealthSave_; 
            float maxHealthOverwrite_; 
            PickupHealthType healthType_; 

            static const std::string healthTypeLimited_s;
            static const std::string healthTypeTemporary_s;
            static const std::string healthTypePermanent_s;

    };
}

#endif // _HealthPickup_H__