Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 12130 was 9667, checked in by landauf, 11 years ago

merged core6 back to trunk

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