Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 11242 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
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/**
[7456]30    @file QuestManager.h
[2662]31    @brief Definition of the QuestManager class.
[7456]32    @ingroup Questsystem
[2261]33*/
34
[1996]35#ifndef _QuestManager_H__
36#define _QuestManager_H__
37
[5722]38#include "questsystem/QuestsystemPrereqs.h"
[2095]39
[3196]40#include <list>
[1996]41#include <map>
42#include <string>
[3370]43
[5929]44#include "util/Singleton.h"
[1996]45
[7456]46namespace orxonox  // tolua_export
47{  // tolua_export
[7552]48
[1996]49    /**
50    @brief
[7456]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()).
[7484]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.
[7552]53
[1996]54    @author
55        Damian 'Mozork' Frick
[7552]56
57    @ingroup Questsystem
[1996]58    */
[7456]59    class _QuestsystemExport QuestManager  // tolua_export
[9667]60        : public Singleton<QuestManager>
[5929]61    { // tolua_export
[5745]62
[5929]63            friend class Singleton<QuestManager>;
[5745]64
[2093]65        public:
[2911]66            QuestManager();
[2093]67            virtual ~QuestManager();
[2092]68
[7456]69            //! Returns a reference to the single instance of the QuestManager.
[5929]70            static QuestManager& getInstance() { return Singleton<QuestManager>::getInstance(); } // tolua_export
[2092]71
[7163]72            // tolua_begin
[7456]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.
[5745]75
[7456]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.
[7163]78
[7456]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.
[7163]81
[8706]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.
[7163]89            // tolua_end
90
[2911]91            bool registerQuest(Quest* quest); //!< Registers a Quest in the QuestManager.
[7163]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.
[2092]95
[2911]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
[5745]99        protected:
[6536]100            std::map<std::string, Quest*> & getQuests(void); //!< Retrieve all Quests.
[2960]101
[2093]102        private:
[3370]103            static QuestManager* singletonPtr_s;
[6536]104            PlayerInfo* retrievePlayer(const std::string & guiName); //!< Retrieve the player for a certain GUI.
[2092]105
[2911]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
[2960]109    }; // tolua_export
[1996]110
[2960]111} // tolua_export
[1996]112
113#endif /* _QuestManager_H__ */
Note: See TracBrowser for help on using the repository browser.