Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 7400 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
RevLine 
[1996]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
[2261]29/**
[3196]30    @file
[2662]31    @brief Definition of the QuestManager class.
[2261]32*/
33
[1996]34#ifndef _QuestManager_H__
35#define _QuestManager_H__
36
[5722]37#include "questsystem/QuestsystemPrereqs.h"
[2095]38
[3196]39#include <list>
[1996]40#include <map>
41#include <string>
[3370]42
[5929]43#include "util/Singleton.h"
[2911]44#include "core/OrxonoxClass.h"
[1996]45
[2960]46// tolua_begin
[2662]47namespace orxonox
48{
[1996]49    /**
50    @brief
[6536]51        Is a Singleton and manages Quests, by registering every Quest/QuestHint (through registerX()) and making them globally accessible (through findX()).
[2261]52        Quests (and QuestHints) are registered in the QuestManager with their id, and can be accessed in the same way.
[1996]53    @author
54        Damian 'Mozork' Frick
55    */
[5929]56    class _QuestsystemExport QuestManager
[2960]57// tolua_end
[5929]58        : public Singleton<QuestManager>, public orxonox::OrxonoxClass
59    { // tolua_export
[5745]60
[5929]61            friend class Singleton<QuestManager>;
[5745]62
[2093]63        public:
[2911]64            QuestManager();
[2093]65            virtual ~QuestManager();
[2092]66
[3370]67            //! Returns a reference to the single instance of the Quest Manager.
[5929]68            static QuestManager& getInstance() { return Singleton<QuestManager>::getInstance(); } // tolua_export
[2092]69
[7163]70            // tolua_begin
71            int getNumParentQuests(orxonox::PlayerInfo* player);
72            Quest* getParentQuest(orxonox::PlayerInfo* player, int index);
[5745]73
[7163]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
[2911]84            bool registerQuest(Quest* quest); //!< Registers a Quest in the QuestManager.
[7163]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.
[2092]88
[2911]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
[5745]92        protected:
[6536]93            std::map<std::string, Quest*> & getQuests(void); //!< Retrieve all Quests.
[2960]94
[2093]95        private:
[3370]96            static QuestManager* singletonPtr_s;
[6536]97            PlayerInfo* retrievePlayer(const std::string & guiName); //!< Retrieve the player for a certain GUI.
[2092]98
[2911]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
[2960]102    }; // tolua_export
[1996]103
[2960]104} // tolua_export
[1996]105
106#endif /* _QuestManager_H__ */
Note: See TracBrowser for help on using the repository browser.