Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/questsystem2/src/orxonox/objects/quest/QuestManager.h @ 2159

Last change on this file since 2159 was 2159, checked in by dafrick, 15 years ago

Completed documentation of finished classes.

File size: 2.3 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
32        Definition of the QuestManager class.
33*/
34
35#ifndef _QuestManager_H__
36#define _QuestManager_H__
37
38#include "OrxonoxPrereqs.h"
39
40#include <map>
41#include <string>
42
43#include "core/BaseObject.h"
44
45namespace orxonox {
46
47    /**
48    @brief
49        Is a static class and manages quests, by registering every quest/hint (through registerX()) and making them globally accessable (through findX()).
50        Quests (and Hints) are registered in the QuestManager with their id, and can be accessed in the same way.
51    @author
52        Damian 'Mozork' Frick
53    */
54    class _OrxonoxExport QuestManager : public BaseObject
55    {
56
57        public:
58            QuestManager(BaseObject* creator);
59            virtual ~QuestManager();
60
61            static bool registerQuest(Quest* quest); //!< Registers a quest in the QuestManager.
62            static bool registerHint(QuestHint* quest); //!< Registers a QuestHint in the QuestManager.
63
64            static Quest* findQuest(const std::string & questId); //!< Returns the quest with the input id.
65            static QuestHint* findHint(const std::string & hintId); //!< Returns the QuestHint with the input id.
66
67        private:
68            static std::map<std::string, Quest*> questMap_s; //!< All quests registered by their id's.
69            static std::map<std::string, QuestHint*> hintMap_s; //!< All hints registered by their id's.
70
71    };
72
73}
74
75#endif /* _QuestManager_H__ */
Note: See TracBrowser for help on using the repository browser.