source: code/trunk/src/modules/pickup/items/MunitionPickup.cc @ 11430

/*
 *   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:
 *      Fabien Vultier
 *   Co-authors:
 *      ...
 *
 */

/**
    @file MunitionPickup.cc
    @brief Implementation of the MunitionPickup class.
*/

#include "MunitionPickup.h"

#include <sstream>
#include "core/CoreIncludes.h"
#include "core/XMLPort.h"

#include "worldentities/pawns/Pawn.h"

namespace orxonox
{
    RegisterClass(MunitionPickup);

    /**
    @brief
        Constructor. Registers the object and initializes the member variables.
    */
    MunitionPickup::MunitionPickup(Context* context) : Pickup(context)
    {
        RegisterObject(MunitionPickup);

        this->initialize();
    }

    /**
    @brief
        Destructor.
    */
    MunitionPickup::~MunitionPickup()
    {
    }

    /**
    @brief
        Initializes the member variables.
    */
    void MunitionPickup::initialize(void)
    {
        //Defines who is allowed to pick up the pickup.
        this->addTarget(ClassIdentifier<Pawn>::getIdentifier());
    }

    /**
    @brief
        Method for creating a MunitionPickup object through XML.
    */
    void MunitionPickup::XMLPort(Element& xmlelement, orxonox::XMLPort::Mode mode)
    {
        SUPER(MunitionPickup, XMLPort, xmlelement, mode);

        XMLPortObject(MunitionPickup, MunitionContainer, "munitioncontainers", addMunitionContainer, getMunitionContainer, xmlelement, mode);
    }

    void MunitionPickup::addMunitionContainer(MunitionContainer* munitionContainer)
    {
        OrxAssert(munitionContainer != nullptr, "The munitionContainer cannot be nullptr.");
        this->munitionContainers_.push_back(munitionContainer);
    }

    MunitionContainer* MunitionPickup::getMunitionContainer(unsigned int index)
    {
        if(this->munitionContainers_.size() >= index)
            return nullptr;
        else
            return this->munitionContainers_[index];
    }

    /**
    @brief
        Is called when the pickup has transisted from used to unused or the other way around.
    */
    void MunitionPickup::changedUsed(void)
    {
        SUPER(MunitionPickup, changedUsed);

        Pawn* pawn = this->carrierToPawnHelper();

        if(pawn == nullptr) // If the PickupCarrier is no Pawn, then this pickup is useless and therefore is destroyed.
            this->Pickupable::destroy();

        // If the pickup has transited to used.
        if(this->isUsed())
        {
            for(MunitionContainer* container : this->munitionContainers_)
            {
                //Get pointer to the appropriate munition
                SubclassIdentifier<Munition> identifier = container->getMunitionType();
                Munition* munition = pawn->getMunition(&identifier);
                if (munition)
                {
                    // Add munition and magzines
                    munition->addMunition(container->getMunitionAmount());
                    munition->addMagazines(container->getMagazinesAmount());
                }
                container->destroy();
            }
            // This will destroy the pickp
            this->setUsed(false);
        }
        else
        {
            this->Pickupable::destroy();
        }
    }    

    /**
    @brief
        Helper to transform the PickupCarrier to a Pawn, and throw an error message if the conversion fails.
    @return
        A pointer to the Pawn, or nullptr if the conversion failed.
    */
    Pawn* MunitionPickup::carrierToPawnHelper(void)
    {
        PickupCarrier* carrier = this->getCarrier();
        Pawn* pawn = orxonox_cast<Pawn*>(carrier);

        if(pawn == nullptr)
        {
            orxout(internal_error, context::pickups) << "Invalid PickupCarrier in MunitionPickup." << endl;
        }
        return pawn;
    }      
}