Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/mainmenu/src/modules/questsystem/LocalQuest.h @ 5804

Last change on this file since 5804 was 5738, checked in by landauf, 15 years ago

merged libraries2 back to trunk

  • Property svn:eol-style set to native
File size: 4.1 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
31    @brief Definition of the LocalQuest class.
32*/
33
34#ifndef _LocalQuest_H__
35#define _LocalQuest_H__
36
37#include "questsystem/QuestsystemPrereqs.h"
38
39#include <map>
40#include "Quest.h"
41
42namespace orxonox
43{
44    /**
45    @brief
46        Handles Quests which have different states for different players.
47        LocalQuests have (as opposed to GlobalQuests) a different state for each player, that means if for one player the status of the Quest changes it does not for all the other players which also possess this quest.
48
49        Creating a LocalQuest through XML goes as follows:
50
51        <LocalQuest id="questId"> //Where questId is a GUID, see http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure for more information
52            <QuestDescription title="Title" description="Description." /> //The description of the quest.
53            <subquests>
54                <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.
55                ...
56                <Quest id="questIdn" />
57                </subquests>
58                <hints>
59                <QuestHint id="hintId1" /> //A list of n QuestHints, see QuestHint for the full XML representation of those.
60                ...
61                <QuestHint id="hintIdn" />
62                </hints>
63            <fail-effects>
64                <QuestEffect /> //A list of QuestEffects, invoked when the Quest is failed, see QuestEffect for the full XML representation.
65                ...
66                <QuestEffect />
67            </fail-effects>
68            <complete-effects>
69                <QuestEffect /> //A list of QuestEffects, invoked when the Quest is completed, see QuestEffect for the full XML representation.
70                ...
71                <QuestEffect />
72            </complete-effects>
73        </LocalQuest>
74    @author
75        Damian 'Mozork' Frick
76    */
77    class _QuestsystemExport LocalQuest : public Quest
78    {
79        public:
80            LocalQuest(BaseObject* creator);
81            virtual ~LocalQuest();
82
83            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a LocalQuest object through XML.
84
85            virtual bool fail(PlayerInfo* player); //!< Fails the Quest.
86            virtual bool complete(PlayerInfo* player); //!< Completes the Quest.
87
88        protected:
89            virtual bool isStartable(const PlayerInfo* player) const; //!< Checks whether the Quest can be started.
90            virtual bool isFailable(const PlayerInfo* player) const; //!< Checks whether the Quest can be failed.
91            virtual bool isCompletable(const PlayerInfo* player) const; //!< Checks whether the Quest can be completed.
92
93            virtual QuestStatus::Value getStatus(const PlayerInfo* player) const; //!< Returns the status of the Quest for a specific player.
94            virtual bool setStatus(PlayerInfo* player, const QuestStatus::Value & status); //!< Sets the status for a specific player.
95
96        private:
97            std::map<const PlayerInfo*, QuestStatus::Value> playerStatus_; //!< List of the status for each player, with the Player-pointer as key.
98
99    };
100
101}
102
103#endif /* _LocalQuest_H__ */
Note: See TracBrowser for help on using the repository browser.