Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/questsystem/Quest.h @ 11396

Last change on this file since 11396 was 11071, checked in by landauf, 9 years ago

merged branch cpp11_v3 back to trunk

  • Property svn:eol-style set to native
File size: 7.7 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Damian 'Mozork' Frick
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file Quest.h
31    @brief Definition of the Quest class.
32        The Quest class is the parent class of @ref orxonox::LocalQuest "LocalQuest" and @ref orxonox::GlobalQuest "GlobalQuest".
33    @ingroup Questsystem
34*/
35
36#ifndef _Quest_H__
37#define _Quest_H__
38
39#include "questsystem/QuestsystemPrereqs.h"
40
41#include <list>
42#include "QuestItem.h"
43
44namespace orxonox // tolua_export
45{ // tolua_export
46
47    /**
48    @brief
49        Different states of a @ref orxonox::Quest "Quest".
50
51    @ingroup Questsystem
52    */
53    enum class QuestStatus
54    {
55        Inactive, //!< The @ref orxonox::Quest "Quest" is inactive.
56        Active, //!< The @ref orxonox::Quest "Quest" is active.
57        Failed, //!< The @ref orxonox::Quest "Quest" has been failed.
58        Completed //!< The @ref orxonox::Quest "Quest" has been completed.
59    };
60
61    /**
62    @brief
63        Represents a Quest in the game. A Quest is a task that the player can (or has to) fulfill upon which he will (possibly) receive some kind of reward.
64
65        A Quest can have a list of sub-quests and has a parent-quest (if it is not a root-quest).
66        Each Quest exists only once but it has a different status (inactive, active, failed or completed) for each player.
67        A Quest can have several hints (QuestHint) that can be unlocked through @ref orxonox::QuestEffect "QuestEffects" and then display aid in solving the Quest.
68        A Quest can have a list of @ref orxonox::QuestEffect "QuestEffects" that are invoked when the quest is failed and also a list of @ref orxonox::QuestEffect "QuestEffects" that are invoked, when the Quest is completed.
69
70        Quest itself should not be instantiated, if you want to create a quest either use LocalQuest or GlobalQuest, whichever suits you needs better.
71
72    @author
73        Damian 'Mozork' Frick
74
75    @ingroup Questsystem
76    */
77    class _QuestsystemExport Quest // tolua_export
78        : public QuestItem
79    { // tolua_export
80        public:
81            Quest(Context* context);
82            virtual ~Quest();
83
84            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override; //!< Method for creating a Quest object through XML.
85
86            /**
87            @brief Returns the parent-quest of the Quest.
88            @return Returns a pointer to the parent-quest of the Quest.
89            */
90            inline Quest* getParentQuest(void) const
91                { return this->parentQuest_; }
92
93            /**
94            @brief Returns the list of sub-quests.
95            @return Returns a reference to the list of sub-quests of the quest.
96            */
97            inline const std::list<Quest*> & getSubQuestList(void) const
98                { return this->subQuests_; }
99
100            /**
101            @brief Returns the list of all QuestHints of this Quest.
102            @return Returns a reference to the list of QuestHints of the Quest.
103            */
104            inline const std::list<QuestHint*> & getHintsList(void) const
105                { return this->hints_; }
106
107            bool isInactive(const PlayerInfo* player) const; //!< Returns true if the quest status for the specific player is 'inactive'.
108            bool isActive(const orxonox::PlayerInfo* player) const; // tolua_export //!< Returns true if the quest status for the specific player is 'active'.
109            bool isFailed(const orxonox::PlayerInfo* player) const; // tolua_export //!< Returns true if the quest status for the specific player is 'failed'.
110            bool isCompleted(const orxonox::PlayerInfo* player) const; // tolua_export //!< Returns true if the quest status for the specific player is 'completed'.
111
112            bool start(PlayerInfo* player); //!< Sets a Quest to active.
113            virtual bool fail(PlayerInfo* player); //!< Fails the Quest.
114            virtual bool complete(PlayerInfo* player); //!< Completes the Quest.
115
116            bool addListener(QuestListener* listener); //!< Adds a QuestListener to the list of QuestListeners listening to this Quest.
117
118        protected:
119            virtual bool isStartable(const PlayerInfo* player) const = 0; //!< Checks whether the Quest can be started.
120            virtual bool isFailable(const PlayerInfo* player) const = 0; //!< Checks whether the Quest can be failed.
121            virtual bool isCompletable(const PlayerInfo* player) const = 0; //!< Checks whether the Quest can be completed.
122
123            const Quest* getSubQuest(unsigned int index) const; //!<Returns the sub-quest at the given index.
124            const QuestHint* getHint(unsigned int index) const; //!< Returns the QuestHint at the given index.
125            const QuestEffect* getFailEffect(unsigned int index) const; //!< Returns the fail QuestEffect at the given index.
126            const QuestEffect* getCompleteEffect(unsigned int index) const; //!< Returns the complete QuestEffect at the given index.
127
128            /**
129            @brief Returns the list of fail QuestEffects.
130            @return Returns a reference to the list of fail QuestEffects.
131            */
132            inline std::list<QuestEffect*> & getFailEffectList(void)
133                { return this->failEffects_; }
134
135            /**
136            @brief Returns the list of complete QuestEffects.
137            @return Returns a reference to the list of complete QuestEffects.
138            */
139            inline std::list<QuestEffect*> & getCompleteEffectList(void)
140                { return this->completeEffects_; }
141
142            virtual QuestStatus getStatus(const PlayerInfo* player) const = 0; //!< Returns the status of the Quest for a specific player.
143            virtual bool setStatus(PlayerInfo* player, const QuestStatus & status) = 0; //!< Changes the status for a specific player.
144
145        private:
146            Quest* parentQuest_; //!< Pointer to the parent-quest.
147            std::list<Quest*> subQuests_; //!< List of all the sub-quests.
148
149            std::list<QuestHint*> hints_; //!< A list of all the QuestHints tied to this Quest.
150
151            std::list<QuestEffect*> failEffects_; //!< A list of all QuestEffects to be invoked, when the Quest has been failed.
152            std::list<QuestEffect*> completeEffects_; //!< A list of QuestEffects to be invoked, when the Quest has been completed.
153
154            std::list<QuestListener*> listeners_; //!< A list of QuestListeners, that listen to what exactly happens with this Quest.
155
156            bool setParentQuest(Quest* quest); //!< Sets the parent-quest of the Quest.
157            bool addSubQuest(Quest* quest); //!< Adds a sub-quest to the Quest.
158            bool addHint(QuestHint* hint); //!< Add a QuestHint to the list of QuestHints.
159            bool addFailEffect(QuestEffect* effect); //!< Adds an QuestEffect to the list of fail QuestEffects.
160            bool addCompleteEffect(QuestEffect* effect); //!< Adds an QuestEffect to the list of complete QuestEffects.
161
162    }; // tolua_export
163
164} // tolua_export
165
166#endif /* _Quest_H__ */
Note: See TracBrowser for help on using the repository browser.