source: code/trunk/src/modules/questsystem/Quest.cc @ 11860

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

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

#include "Quest.h"

#include "core/CoreIncludes.h"
#include "core/XMLPort.h"

#include "QuestDescription.h"
#include "QuestEffect.h"
#include "QuestHint.h"
#include "QuestListener.h"
#include "QuestManager.h"

namespace orxonox
{
    RegisterAbstractClass(Quest).inheritsFrom<QuestItem>();

    /**
    @brief
        Constructor. Registers and initializes object.
    */
    Quest::Quest(Context* context) : QuestItem(context)
    {
        RegisterObject(Quest);

        this->parentQuest_ = nullptr;
    }

    /**
    @brief
        Destructor.
    */
    Quest::~Quest()
    {
        if(this->isRegistered())
            QuestManager::getInstance().unregisterQuest(this);
    }

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

        XMLPortObject(Quest, Quest, "subquests", addSubQuest, getSubQuest, xmlelement, mode);
        XMLPortObject(Quest, QuestHint, "hints", addHint, getHint, xmlelement, mode);
        XMLPortObject(Quest, QuestEffect, "fail-effects", addFailEffect, getFailEffect, xmlelement, mode);
        XMLPortObject(Quest, QuestEffect, "complete-effects", addCompleteEffect, getCompleteEffect, xmlelement, mode);

        QuestManager::getInstance().registerQuest(this); // Registers the Quest with the QuestManager.
    }

    /**
    @brief
        Sets the parent-quest of the Quest.
    @param quest
        A pointer to the Quest to be set as parent-quest.
    @return
        Returns true if the parent-quest could be set.
    */
    bool Quest::setParentQuest(Quest* quest)
    {
        assert(quest);

        this->parentQuest_ = quest;

        orxout(verbose, context::quests) << "Parent Quest {" << quest->getId() << "} was added to Quest {" << this->getId() << "}." << endl;
        return true;
    }

    /**
    @brief
        Adds a sub-quest to the Quest.
    @param quest
        A pointer to the Quest to be set as sub-quest.
    @return
        Returns true if the sub-quest could be set.
    */
    bool Quest::addSubQuest(Quest* quest)
    {
        assert(quest);

        quest->setParentQuest(this); // Sets the currentQuest (this) as parent-quest for the added sub-quest.
        this->subQuests_.push_back(quest); // Adds the Quest to the end of the list of sub-quests.

        orxout(verbose, context::quests) << "Sub Quest {" << quest->getId() << "} was added to Quest {" << this->getId() << "}." << endl;
        return true;
    }


    /**
    @brief
        Adds a QuestHint to the list of QuestHints
    @param hint
        The QuestHint that should be added to the list of QuestHints.
    @return
        Returns true if the hint was successfully added.
    */
    bool Quest::addHint(QuestHint* hint)
    {
        assert(hint);

        hint->setQuest(this); // Sets the current Quest (this) as Quest for the added QuestHint.
        this->hints_.push_back(hint); // Adds the QuestHint to the end of the list of QuestHints.

        orxout(verbose, context::quests) << "QuestHint {" << hint->getId() << "} was added to Quest {" << this->getId() << "}." << endl;
        return true;
    }

    /**
    @brief
        Adds an QuestEffect to the list of fail QuestEffects.
    @param effect
        The QuestEffect to be added.
    @return
        Returns true if successful.
    */
    bool Quest::addFailEffect(QuestEffect* effect)
    {
        assert(effect);

        this->failEffects_.push_back(effect); // Adds the QuestEffect to the end of the list of fail QuestEffects.

        orxout(verbose, context::quests) << "A FailEffect was added to Quest {" << this->getId() << "}." << endl;
        return true;
    }

    /**
    @brief
        Adds an QuestEffect to the list of complete QuestEffects.
    @param effect
        The QuestEffect to be added.
    @return
        Returns true if successful.
    */
    bool Quest::addCompleteEffect(QuestEffect* effect)
    {
        assert(effect);

        this->completeEffects_.push_back(effect); // Adds the QuestEffect to the end of the list of complete QuestEffects.

        orxout(verbose, context::quests) << "A CompleteEffect was added to Quest {" << this->getId() << "}." << endl;
        return true;
    }

    /**
    @brief
        Returns the sub-quest at the given index.
    @param index
        The index.
    @return
        Returns a pointer to the sub-quest at the given index. nullptr if there is no element at the given index.
    */
    const Quest* Quest::getSubQuest(unsigned int index) const
    {
        int i = index;

        // Iterate through all subquests.
        for (Quest* quest : this->subQuests_)
        {
            if(i == 0) // We're counting down...
               return quest;

            i--;
        }

        return nullptr; // If the index is greater than the number of elements in the list.
    }

    /**
    @brief
        Returns the QuestHint at the given index.
    @param index
        The index.
    @return
        Returns a pointer to the QuestHint at the given index. nullptr if there is no element at the given index.
    */
    const QuestHint* Quest::getHint(unsigned int index) const
    {
        int i = index;

        // Iterate through all QuestHints.
        for (QuestHint* hint : this->hints_)
        {
            if(i == 0) // We're counting down...
               return hint;

            i--;
        }
        return nullptr; // If the index is greater than the number of elements in the list.
    }

    /**
    @brief
        Returns the fail QuestEffect at the given index.
    @param index
        The index.
    @return
        Returns a pointer to the fail QuestEffect at the given index. nullptr if there is no element at the given index.
    */
    const QuestEffect* Quest::getFailEffect(unsigned int index) const
    {
        int i = index;

        // Iterate through all fail QuestEffects.
        for (QuestEffect* effect : this->failEffects_)
        {
            if(i == 0) // We're counting down...
               return effect;

            i--;
        }
        return nullptr; // If the index is greater than the number of elements in the list.
    }

    /**
    @brief
        Returns the complete QuestEffect at the given index.
    @param index
        The index.
    @return
        Returns a pointer to the complete QuestEffect at the given index. nullptr if there is no element at the given index.
    */
    const QuestEffect* Quest::getCompleteEffect(unsigned int index) const
    {
        int i = index;

        // Iterate through all complete QuestEffects.
        for (QuestEffect* effect : this->completeEffects_)
        {
            if(i == 0) // We're counting down...
               return effect;

            i--;
        }
        return nullptr; // If the index is greater than the number of elements in the list.
    }

    /**
    @brief
        Returns true if the quest status for the specific player is 'inactive'.
    @param player
        The player.
    @return
        Returns true if the quest status for the specific player is 'inactive'.
    */
    bool Quest::isInactive(const PlayerInfo* player) const
    {
        if(player == nullptr)
            return true;
        return this->getStatus(player) == QuestStatus::Inactive;
    }

    /**
    @brief
        Returns true if the quest status for the specific player is 'active'.
    @param player
        The player.
    @return
        Returns true if the quest status for the specific player is 'active'.
    */
    bool Quest::isActive(const PlayerInfo* player) const
    {
        if(player == nullptr)
            return false;
        return this->getStatus(player) == QuestStatus::Active;
    }

    /**
    @brief
        Returns true if the quest status for the specific player is 'failed'.
    @param player
        The player.
    @return
        Returns true if the quest status for the specific player is 'failed'.
    */
    bool Quest::isFailed(const PlayerInfo* player) const
    {
        if(player == nullptr)
            return false;
        return this->getStatus(player) == QuestStatus::Failed;
    }

    /**
    @brief
        Returns true if the quest status for the specific player is 'completed'.
    @param player
        The player.
    @return
        Returns true if the quest status for the specific player is 'completed'.
    */
    bool Quest::isCompleted(const PlayerInfo* player) const
    {
        if(player == nullptr)
            return false;
        return this->getStatus(player) == QuestStatus::Completed;
    }

    /**
    @brief
        Fails the Quest for an input player.
    @param player
        The player.
    @return
        Returns true if the Quest could be failed, false if not.
    */
    bool Quest::fail(PlayerInfo* player)
    {
        QuestListener::advertiseStatusChange(this->listeners_, "fail"); // Tells the QuestListeners, that the status has changed to failed.
        this->setStatus(player, QuestStatus::Failed);

        orxout(verbose, context::quests) << "Quest {" << this->getId() << "} is failed for player: " << player << " ." << endl;

        this->getDescription()->sendFailQuestNotification(player);
        return true;
    }

    /**
    @brief
        Completes the Quest for an input player.
    @param player
        The player.
    @return
        Returns true if the Quest could be completed, false if not.
    */
    bool Quest::complete(PlayerInfo* player)
    {
        QuestListener::advertiseStatusChange(this->listeners_, "complete"); // Tells the QuestListeners, that the status has changed to completed.
        this->setStatus(player, QuestStatus::Completed);

        orxout(verbose, context::quests) << "Quest {" << this->getId() << "} is completed for player: " << player << " ." << endl;

        this->getDescription()->sendCompleteQuestNotification(player);
        return true;
    }

    /**
    @brief
        Starts the Quest for an input player.
    @param player
        The player.
    @return
        Returns true if the Quest could be started, false if not.
    */
    bool Quest::start(PlayerInfo* player)
    {
        if(!this->isStartable(player)) // Checks whether the quest can be started.
        {
            orxout(verbose, context::quests) << "A non-startable quest was trying to be started." << endl;
            return false;
        }

        orxout(verbose, context::quests) << "Quest {" << this->getId() << "} is started for player: " << player << " ." << endl;

        QuestListener::advertiseStatusChange(this->listeners_, "start"); // Tells the QuestListeners, that the status has changed to active.

        this->setStatus(player, QuestStatus::Active);

        this->getDescription()->sendAddQuestNotification(player);
        return true;
    }

    /**
    @brief
        Adds a QuestListener to the list of QuestListeners listening to this Quest.
    @param listener
        The QuestListener to be added.
    @return
        Returns true if successful, false if not.
    */
    bool Quest::addListener(QuestListener* listener)
    {
        assert(listener);

        this->listeners_.push_back(listener);
        return true;
    }

}