Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/tutorial/src/modules/questsystem/QuestManager.h @ 11468

Last change on this file since 11468 was 7552, checked in by dafrick, 14 years ago

Resolving some TODOs and doing some additional cleanup. Almost done now…

  • Property svn:eol-style set to native
File size: 4.4 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            QuestDescription* getDescription(Quest* item);
84            QuestDescription* getDescription(QuestHint* item);
85            // tolua_end
86
87            bool registerQuest(Quest* quest); //!< Registers a Quest in the QuestManager.
88            bool unregisterQuest(Quest* quest); //!< Unregisters a Quest in the QuestManager.
89            bool registerHint(QuestHint* hint); //!< Registers a QuestHint in the QuestManager.
90            bool unregisterHint(QuestHint* hint); //!< Unregisters a QuestHint in the QuestManager.
91
92            Quest* findQuest(const std::string & questId); //!< Returns the Quest with the input id.
93            QuestHint* findHint(const std::string & hintId); //!< Returns the QuestHint with the input id.
94
95        protected:
96            std::map<std::string, Quest*> & getQuests(void); //!< Retrieve all Quests.
97
98        private:
99            static QuestManager* singletonPtr_s;
100            PlayerInfo* retrievePlayer(const std::string & guiName); //!< Retrieve the player for a certain GUI.
101
102            std::map<std::string, Quest*> questMap_; //!< All Quests registered by their id's.
103            std::map<std::string, QuestHint*> hintMap_; //!< All QuestHints registered by their id's.
104
105    }; // tolua_export
106
107} // tolua_export
108
109#endif /* _QuestManager_H__ */
Note: See TracBrowser for help on using the repository browser.