source: code/branches/soundEffects/src/modules/pickup/items/DamageBoostPickup.h @ 10422

/*
 *   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:
 *      Kevin Lengauer
 *   Co-authors:
 *      ...
 *
 */

/**
    @file DamageBoostPickup.h
    @brief Declaration of the DamageBoostPickup class.
    @ingroup PickupItems
*/

#ifndef _DamageBoostPickup_H__
#define _DamageBoostPickup_H__

#include "pickup/PickupPrereqs.h"

#include <string>

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

namespace orxonox {

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

            DamageBoostPickup(BaseObject* creator); //!< Constructor.
            virtual ~DamageBoostPickup(); //!< Destructor.

            virtual void XMLPort(Element& xmlelement, orxonox::XMLPort::Mode mode); //!< Method for creating a DamageBoostPickup object through XML.

            virtual void changedUsed(void); //!< Is called when the pickup has transited from used to unused or the other way around.

            /**
            @brief Get the time the DamagePickup lasts.
            @return Returns the time in seconds the DamagePickup lasts.
            */
            inline float getDuration(void) const
                { return this->duration_; }

            inline void setDuration( float duration );



            /**
             @brief set Damage multiplier
             @param multiplier The default damage multiplier to set
             */
            inline float getDamageMultiplier()
                { return this->damageMultiplier_; }




        protected:
            void setDamageMultiplier(float damageMultiplier); //!< Sets the DamageMultiplier according to the XML.


        private:
            void initialize(void); //!< Initializes the member variables.
            Pawn* carrierToPawnHelper(void); //!< Helper to transform the PickupCarrier to a Pawn, and throw an error message if the conversion fails.
            SpaceShip* carrierToSpaceShipHelper(void); //!< Helper to transform the PickupCarrier to a SpaceShip, and throw an error message if the conversion fails.
            void pickupTimerCallback(void);



            float damageMultiplier_; //!< The damage boost that is transferred to the Pawn.
            float olddamageMultiplier_; //!< Helper to remember what the actual damage of the Pawn was before we changed it.

            Timer durationTimer_; //!< Timer.
            float duration_; //! Duration of damage boost.

    };
}

#endif // _DamageBoostPickup_H__