Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/questsystem/GlobalQuest.h @ 6438

Last change on this file since 6438 was 5781, checked in by rgrieder, 15 years ago

Reverted trunk again. We might want to find a way to delete these revisions again (x3n's changes are still available as diff in the commit mails).

  • Property svn:eol-style set to native
File size: 4.7 KB
RevLine 
[1992]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 */
[5693]28
[2261]29/**
[3196]30    @file
[2662]31    @brief Definition of the GlobalQuest class.
[2261]32*/
[1992]33
34#ifndef _GlobalQuest_H__
35#define _GlobalQuest_H__
36
[5722]37#include "questsystem/QuestsystemPrereqs.h"
[2095]38
[3196]39#include <list>
[1992]40#include <set>
41#include "Quest.h"
42
[2662]43namespace orxonox
44{
[1992]45    /**
46    @brief
[2261]47        GlobalQuests are Quests, that have the same status for all players.
48        This means, that when a player successfully completes a GlobalQuest, it is completed for all players that have it.
[5693]49
[2261]50        Creating a GlobalQuest through XML goes as follows:
[5693]51
[2261]52        <GlobalQuest id="questId"> //Where questId is a GUID, see http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure for more information
53            <QuestDescription title="Title" description="Description." /> //The description of the quest.
54            <subquests>
[2662]55                <Quest id ="questId1" /> //A list of n subquest, be aware, each of the <Quest /> tags must have a description and so on and so forth as well.
56                ...
57                <Quest id="questIdn" />
58            </subquests>
59            <hints>
60                <QuestHint id="hintId1" /> //A list of n QuestHints, see QuestHint for the full XML representation of those.
61                ...
62                <QuestHint id="hintIdn" />
63            </hints>
[2261]64            <fail-effects>
65                <QuestEffect /> //A list of QuestEffects, invoked on all players possessing this quest, when the Quest is failed, see QuestEffect for the full XML representation.
66                ...
67                <QuestEffect />
68            </fail-effects>
69            <complete-effects>
70                <QuestEffect /> //A list of QuestEffects, invoked on all players possessing this quest, when the Quest is completed, see QuestEffect for the full XML representation.
71                ...
72                <QuestEffect />
73            </complete-effects>
74            <reward-effects>
75                <QuestEffect /> //A list of QuestEffects, invoked on the player completing this quest. See QuestEffect for the full XML representation.
76                ...
77                <QuestEffect />
78            </reward-effects>
79        </GlobalQuest>
[1992]80    @author
81        Damian 'Mozork' Frick
82    */
[5722]83    class _QuestsystemExport GlobalQuest : public Quest
[1992]84    {
[2093]85        public:
[2092]86            GlobalQuest(BaseObject* creator);
[2093]87            virtual ~GlobalQuest();
[2092]88
[2261]89            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a GlobalQuest object through XML.
[5693]90
[2261]91            virtual bool fail(PlayerInfo* player); //!< Fails the Quest.
92            virtual bool complete(PlayerInfo* player); //!< Completes the Quest.
[2092]93
[2093]94        protected:
[2261]95            virtual bool isStartable(const PlayerInfo* player) const; //!< Checks whether the Quest can be started.
96            virtual bool isFailable(const PlayerInfo* player) const; //!< Checks whether the Quest can be failed.
97            virtual bool isCompletable(const PlayerInfo* player) const; //!< Checks whether the Quest can be completed.
[2092]98
[3280]99            virtual QuestStatus::Value getStatus(const PlayerInfo* player) const; //!< Returns the status of the Quest for a specific player.
[5693]100
[3280]101            virtual bool setStatus(PlayerInfo* player, const QuestStatus::Value & status); //!< Sets the status for a specific player.
[2092]102
[2093]103        private:
[2261]104            std::set<PlayerInfo*> players_; //!< The set of players which possess this Quest.
[3280]105            QuestStatus::Value status_; //!< The status of this Quest.
[2261]106            std::list<QuestEffect*> rewards_; //!< Reward QuestEffects only invoked on the player completing the Quest.
[5693]107
[2261]108            bool addRewardEffect(QuestEffect* effect); //!< Adds a reward QuestEffect to the list of reward QuestEffects.
109            const QuestEffect* getRewardEffects(unsigned int index) const; //!< Returns the reward QuestEffect at the given index.
[2092]110
[1992]111    };
112
113}
114
115#endif /* _GlobalQuest_H__ */
Note: See TracBrowser for help on using the repository browser.