Quest.h

Go to the documentation of this file.

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

#ifndef _Quest_H__
#define _Quest_H__

#include "questsystem/QuestsystemPrereqs.h"

#include <list>
#include "QuestItem.h"

namespace orxonox // tolua_export
{ // tolua_export

    enum class QuestStatus
    {
        Inactive, 
        Active, 
        Failed, 
        Completed 
    };

    class _QuestsystemExport Quest // tolua_export
        : public QuestItem
    { // tolua_export
        public:
            Quest(Context* context);
            virtual ~Quest();

            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override; 

            inline Quest* getParentQuest(void) const
                { return this->parentQuest_; }

            inline const std::list<Quest*> & getSubQuestList(void) const
                { return this->subQuests_; }

            inline const std::list<QuestHint*> & getHintsList(void) const
                { return this->hints_; }

            bool isInactive(const PlayerInfo* player) const; 
            bool isActive(const orxonox::PlayerInfo* player) const; // tolua_export //!< Returns true if the quest status for the specific player is 'active'.
            bool isFailed(const orxonox::PlayerInfo* player) const; // tolua_export //!< Returns true if the quest status for the specific player is 'failed'.
            bool isCompleted(const orxonox::PlayerInfo* player) const; // tolua_export //!< Returns true if the quest status for the specific player is 'completed'.

            bool start(PlayerInfo* player); 
            virtual bool fail(PlayerInfo* player); 
            virtual bool complete(PlayerInfo* player); 

            bool addListener(QuestListener* listener); 

        protected:
            virtual bool isStartable(const PlayerInfo* player) const = 0; 
            virtual bool isFailable(const PlayerInfo* player) const = 0; 
            virtual bool isCompletable(const PlayerInfo* player) const = 0; 

            const Quest* getSubQuest(unsigned int index) const; 
            const QuestHint* getHint(unsigned int index) const; 
            const QuestEffect* getFailEffect(unsigned int index) const; 
            const QuestEffect* getCompleteEffect(unsigned int index) const; 

            inline std::list<QuestEffect*> & getFailEffectList(void)
                { return this->failEffects_; }

            inline std::list<QuestEffect*> & getCompleteEffectList(void)
                { return this->completeEffects_; }

            virtual QuestStatus getStatus(const PlayerInfo* player) const = 0; 
            virtual bool setStatus(PlayerInfo* player, const QuestStatus & status) = 0; 

        private:
            Quest* parentQuest_; 
            std::list<Quest*> subQuests_; 

            std::list<QuestHint*> hints_; 

            std::list<QuestEffect*> failEffects_; 
            std::list<QuestEffect*> completeEffects_; 

            std::list<QuestListener*> listeners_; 

            bool setParentQuest(Quest* quest); 
            bool addSubQuest(Quest* quest); 
            bool addHint(QuestHint* hint); 
            bool addFailEffect(QuestEffect* effect); 
            bool addCompleteEffect(QuestEffect* effect); 

    }; // tolua_export

} // tolua_export

#endif /* _Quest_H__ */