source: code/branches/questsystem/src/orxonox/objects/QuestHint.cc @ 2021

/*
 *   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 "Quest.h"
#include "QuestHint.h"

namespace orxonox {

    CreateFactory(QuestHint);

    QuestHint::QuestHint() : QuestItem()
    {
        
    }

    /**
    @brief
        Constructor.  Needs as input a unique identifier to be able to identify different instances of this class (and subclasses).
    @param id
        The unique identifier.
    @param title
        The title of the hint.
    @param description
        The description of the hint, resp. the hint itself.
    */
    QuestHint::QuestHint(std::string id, std::string title, std::string description) : QuestItem(id, title, description)
    {
        RegisterObject(QuestHint);
    }
    
    /**
    @brief
        Destructor.
    */
    QuestHint::~QuestHint()
    {
        
    }
    
    /**
    @brief
        Checks whether the hint is active for a specific player.
    @param player
        The player.
    @return
        Returns 
    */
    bool QuestHint::isActive(Player* player)
    {
        std::map<Player*, questHintStatus::Enum>::iterator it = this->playerStatus_.find(player);
        if (it != this->playerStatus_.end())
        {
            return it->second;
        }
        return questStatus::inactive;
    }
    
    /**
    @brief
    @param player
    @return
    */
    bool QuestHint::activate(Player* player)
    {
        if(this->quest_->isActive(player) && !(this->isActive(player)))
        {
            this->playerStatus_[player] = questHintStatus::active;
            return true;
        }
        COUT(2) << "A hint of a non-active quest was trying to get activated." << std::endl;
        return false;
    }

    /**
    @brief
    @param quest
    @return
    */
    void QuestHint::setQuest(Quest* quest)
    {
        this->quest_ = quest;
    }

}