source: code/branches/questsystem/src/orxonox/objects/GlobalQuest.cc @ 2255

/*
 *   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:
 *      ...
 *
 */

#include "core/CoreIncludes.h"
#include "util/Exception.h"

#include "GlobalQuest.h"

namespace orxonox {

    CreateFactory(GlobalQuest);

    /**
    @brief
        Constructor.
    */
    GlobalQuest::GlobalQuest() : Quest()
    {
        this->initialize();
    }
    
    /**
    @brief
        Destructor.
    */
    GlobalQuest::~GlobalQuest()
    {
        
    }
    
    void GlobalQuest::XMLPort(Element& xmlelement, XMLPort::Mode mode)
    {
        SUPER(GlobalQuest, XMLPort, xmlelement, mode);

        COUT(3) << "New GlobalQuest {" << this->getId() << "} created." << std::endl;
    }
    
    void GlobalQuest::initialize(void)
    {
        RegisterObject(GlobalQuest);
    }
    
    /**
    @brief
        Checks whether the quest can be started.
    @param player
        The player for whom is to be checked.
    @return
        Returns true if the quest can be started, false if not.
    @throws
        Throws an exception if either isInactive() of isActive() throws one.
    */
    bool GlobalQuest::isStartable(const Player* player) const
    {
        return this->isInactive(player) ||  this->isActive(player);
    }
    
    /**
    @brief
        Checks whether the quest can be failed.
    @param player
        The player for whom is to be checked.
    @return
        Returns true if the quest can be failed, false if not.
    @throws
        Throws an Exception if isActive() throws one.
    */
    bool GlobalQuest::isFailable(const Player* player) const
    {
        return this->isActive(player);

    }
    
    /**
    @brief
        Checks whether the quest can be completed.
    @param player
        The player for whom is to be checked.
    @return
        Returns true if the quest can be completed, false if not.
    @throws
        Throws an Exception if isActive() throws one.
    */
    bool GlobalQuest::isCompletable(const Player* player) const
    {
        return this->isActive(player);
    }

    /**
    @brief
        Returns the status of the quest for a specific player.
    @param player
        The player.
    @throws
        Throws an Exception if player is NULL.
    */
    questStatus::Enum GlobalQuest::getStatus(const Player* player) const
    {
        if(player == NULL)
        {
            ThrowException(Argument, "The input Player* is NULL.");
        }
        
        //TDO: Does this really work???
        std::set<Player*>::const_iterator it = this->players_.find((Player*)(void*)player);
        if (it != this->players_.end())
        {
            return this->status_;
        }
        else
        {
           return questStatus::inactive;
        }

    }
    
    /**
    @brief
        Sets the status for a specific player.
        But be careful wit this one, the status will just be set without checking for its validity. You have to know what you're doing.
    @param player
        The player.
    @param status
        The status to be set.
    @return
        Returns false if player is NULL.
    */
    bool GlobalQuest::setStatus(Player* player, const questStatus::Enum & status)
    {
        if(player == NULL)
        {
            return false;
        }
        
        std::set<Player*>::const_iterator it = this->players_.find(player);
        if (it == this->players_.end()) //!< Player is not yet in the list.
        {
            this->players_.insert(player);
        }
        this->status_ = status;
        return true;
    }


}