Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/questsystem/QuestManager.h @ 9138

Last change on this file since 9138 was 8706, checked in by dafrick, 13 years ago

Merging presentation branch back into trunk.
There are many new features and also a lot of other changes and bugfixes, if you want to know, digg through the svn log.
Not everything is yet working as it should, but it should be fairly stable. If you habe any bug reports, just send me an email.

  • Property svn:eol-style set to native
File size: 4.8 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 QuestManager.h
31    @brief Definition of the QuestManager class.
32    @ingroup Questsystem
33*/
34
35#ifndef _QuestManager_H__
36#define _QuestManager_H__
37
38#include "questsystem/QuestsystemPrereqs.h"
39
40#include <list>
41#include <map>
42#include <string>
43
44#include "util/Singleton.h"
45#include "core/OrxonoxClass.h"
46
47namespace orxonox  // tolua_export
48{  // tolua_export
49
50    /**
51    @brief
52        Is a Singleton and manages @ref orxonox::Quest "Quests", by registering every @ref orxonox::Quest "Quest" / @ref orxonox::QuestHint "QuestHint" (through registerX()) and making them globally accessible (through findX()).
53        @ref orxonox::Quest "Quests" (and @ref orxonox::QuestHint "QuestHints") are registered in the QuestManager with their id, and can be accessed in the same way.
54
55    @author
56        Damian 'Mozork' Frick
57
58    @ingroup Questsystem
59    */
60    class _QuestsystemExport QuestManager  // tolua_export
61        : public Singleton<QuestManager>, public orxonox::OrxonoxClass
62    { // tolua_export
63
64            friend class Singleton<QuestManager>;
65
66        public:
67            QuestManager();
68            virtual ~QuestManager();
69
70            //! Returns a reference to the single instance of the QuestManager.
71            static QuestManager& getInstance() { return Singleton<QuestManager>::getInstance(); } // tolua_export
72
73            // tolua_begin
74            int getNumRootQuests(orxonox::PlayerInfo* player); //!< Get the number of Quests the input player has, that are root quests.
75            Quest* getRootQuest(orxonox::PlayerInfo* player, int index); //!< Get the index-th root quest of the input player.
76
77            int getNumSubQuests(Quest* quest, orxonox::PlayerInfo* player); //!< Get the number of sub-quest of an input Quest for an input player.
78            Quest* getSubQuest(Quest* quest, orxonox::PlayerInfo* player, int index); //!< Get the index-th sub-quest of the input Quest for the input player.
79
80            int getNumHints(Quest* quest, orxonox::PlayerInfo* player); //!< Get the number of QuestHints of the input Quest for the input player.
81            QuestHint* getHints(Quest* quest, orxonox::PlayerInfo* player, int index); //!< Get the index-th QuestHint of the input Quest for the input player.
82
83            Quest* getParentQuest(Quest* quest); //!< Get the parent-quest of the input Quest.
84
85            QuestDescription* getDescription(Quest* item); //!< Get the QuestDescription of the input Quest.
86            QuestDescription* getDescription(QuestHint* item); //!< Get the QuestDescription of the input QuestHint.
87
88            const std::string getId(Quest* item) const; //!< Get the id of the input Quest.
89            const std::string getId(QuestHint* item) const; //!< Get the id of the input QuestHint.
90            // tolua_end
91
92            bool registerQuest(Quest* quest); //!< Registers a Quest in the QuestManager.
93            bool unregisterQuest(Quest* quest); //!< Unregisters a Quest in the QuestManager.
94            bool registerHint(QuestHint* hint); //!< Registers a QuestHint in the QuestManager.
95            bool unregisterHint(QuestHint* hint); //!< Unregisters a QuestHint in the QuestManager.
96
97            Quest* findQuest(const std::string & questId); //!< Returns the Quest with the input id.
98            QuestHint* findHint(const std::string & hintId); //!< Returns the QuestHint with the input id.
99
100        protected:
101            std::map<std::string, Quest*> & getQuests(void); //!< Retrieve all Quests.
102
103        private:
104            static QuestManager* singletonPtr_s;
105            PlayerInfo* retrievePlayer(const std::string & guiName); //!< Retrieve the player for a certain GUI.
106
107            std::map<std::string, Quest*> questMap_; //!< All Quests registered by their id's.
108            std::map<std::string, QuestHint*> hintMap_; //!< All QuestHints registered by their id's.
109
110    }; // tolua_export
111
112} // tolua_export
113
114#endif /* _QuestManager_H__ */
Note: See TracBrowser for help on using the repository browser.