Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/doc/src/modules/questsystem/QuestManager.h @ 7310

Last change on this file since 7310 was 7163, checked in by dafrick, 14 years ago

Merged presentation3 branch into trunk.

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