[2072] | 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 | * Fabian 'x3n' Landau |
---|
| 24 | * Co-authors: |
---|
[7802] | 25 | * Damian 'Mozork' Frick |
---|
[2072] | 26 | * |
---|
| 27 | */ |
---|
| 28 | |
---|
[7804] | 29 | /** |
---|
| 30 | @file LevelManager.h |
---|
| 31 | @brief Definition of the LevelManager singleton. |
---|
| 32 | @ingroup Orxonox |
---|
| 33 | */ |
---|
| 34 | |
---|
[2072] | 35 | #ifndef _LevelManager_H__ |
---|
| 36 | #define _LevelManager_H__ |
---|
| 37 | |
---|
| 38 | #include "OrxonoxPrereqs.h" |
---|
| 39 | |
---|
[3196] | 40 | #include <cassert> |
---|
[2072] | 41 | #include <list> |
---|
[7648] | 42 | #include <map> |
---|
[3304] | 43 | #include <string> |
---|
[3370] | 44 | |
---|
[7802] | 45 | #include "LevelInfo.h" |
---|
| 46 | |
---|
[3370] | 47 | #include "util/Singleton.h" |
---|
[9667] | 48 | #include "core/config/Configurable.h" |
---|
[2072] | 49 | |
---|
[3280] | 50 | // tolua_begin |
---|
[2072] | 51 | namespace orxonox |
---|
| 52 | { |
---|
[7802] | 53 | |
---|
| 54 | /** |
---|
| 55 | @brief |
---|
[7803] | 56 | The LevelManager keeps track of @ref orxonox::Level "Levels" whose activity has been requested and activates the @ref orxonox::Level "Levels" in the list in a FIFO manner with exactly one Level (the first in the list) being active at all times (unless the list is empty). |
---|
| 57 | It also serves as an access point to get a list of all available @ref orxonox::Level "Levels" (or rather their respective @ref orxonox::LevelInfoItem "LevelInfoItems"). |
---|
[7802] | 58 | |
---|
| 59 | @author |
---|
| 60 | Fabian 'x3n' Landau |
---|
| 61 | |
---|
| 62 | @author |
---|
| 63 | Damian 'Mozork' Frick |
---|
[7804] | 64 | |
---|
| 65 | @ingroup Orxonox |
---|
[7802] | 66 | */ |
---|
[2171] | 67 | class _OrxonoxExport LevelManager |
---|
[3280] | 68 | // tolua_end |
---|
[9667] | 69 | : public Singleton<LevelManager>, public Configurable |
---|
[3280] | 70 | { // tolua_export |
---|
[3370] | 71 | friend class Singleton<LevelManager>; |
---|
[2072] | 72 | public: |
---|
| 73 | LevelManager(); |
---|
| 74 | virtual ~LevelManager(); |
---|
| 75 | |
---|
[7802] | 76 | void setConfigValues(); //!< Set the config values for this object. |
---|
[3280] | 77 | |
---|
[7802] | 78 | void requestActivity(Level* level); //!< Request activity for the input Level. |
---|
| 79 | void releaseActivity(Level* level); //!< Release activity for the input Level. |
---|
| 80 | Level* getActiveLevel(); //!< Get the currently active Level. |
---|
[2072] | 81 | |
---|
[7802] | 82 | // tolua_begin |
---|
| 83 | void setDefaultLevel(const std::string& levelName); //!< Set the default Level. |
---|
| 84 | /** |
---|
| 85 | @brief Get the default level. |
---|
| 86 | @return Returns the filename of the default level. |
---|
| 87 | */ |
---|
| 88 | const std::string& getDefaultLevel() const |
---|
| 89 | { return defaultLevelName_; } |
---|
| 90 | unsigned int getNumberOfLevels(void); |
---|
| 91 | LevelInfoItem* getAvailableLevelListItem(unsigned int index); //!< Get the LevelInfoItem at the given index in the list of available Levels. |
---|
[3280] | 92 | |
---|
[10255] | 93 | void setLastFinishedCampaignMission(const std::string& lastFinishedCampaignMission); |
---|
| 94 | inline const std::string& getLastFinishedCampaignMission() const |
---|
| 95 | { return this->lastFinishedCampaignMission_; } |
---|
| 96 | |
---|
| 97 | inline unsigned int getNumberOfCampaignMissions() |
---|
| 98 | { return this->campaignMissions_.size(); } |
---|
| 99 | inline const std::string& getCampaignMission(unsigned int index) |
---|
| 100 | { return this->campaignMissions_[index]; } |
---|
| 101 | |
---|
[7802] | 102 | /** |
---|
| 103 | @brief Get the instance of the LevelManager. |
---|
| 104 | @return Returns the instance of the LevelManager. |
---|
| 105 | */ |
---|
| 106 | static LevelManager& getInstance() |
---|
| 107 | { return Singleton<LevelManager>::getInstance(); } |
---|
| 108 | // tolua_end |
---|
[2072] | 109 | |
---|
| 110 | private: |
---|
| 111 | LevelManager(const LevelManager&); |
---|
| 112 | |
---|
[7802] | 113 | void activateNextLevel(); //!< Activate the next level. |
---|
[2072] | 114 | |
---|
[7802] | 115 | void compileAvailableLevelList(void); //!< Compile the list of available Levels. |
---|
| 116 | void updateAvailableLevelList(void); //!< Update the list of available Levels. |
---|
[7648] | 117 | |
---|
[7802] | 118 | std::list<Level*> levels_; //!< A list of all the Levels whose activity has been requested, in the order in which they will become active. |
---|
| 119 | std::set<LevelInfoItem*, LevelInfoCompare> availableLevels_; //!< The set of available Levels sorted alphabetically according to the name of the Level. |
---|
[3196] | 120 | |
---|
[7802] | 121 | // Helpers to allow fast access to the availableLevels list. |
---|
| 122 | unsigned int nextIndex_; //! The next expected index to be accessed. |
---|
[8079] | 123 | std::set<LevelInfoItem*, LevelInfoCompare>::iterator nextLevel_; //! The next expected Level to be accessed. |
---|
[7802] | 124 | |
---|
[3280] | 125 | // config values |
---|
| 126 | std::string defaultLevelName_; |
---|
[10255] | 127 | std::string lastFinishedCampaignMission_; |
---|
| 128 | std::vector<std::string> campaignMissions_; |
---|
[3280] | 129 | |
---|
[3370] | 130 | static LevelManager* singletonPtr_s; |
---|
[3280] | 131 | }; // tolua_export |
---|
| 132 | } // tolua_export |
---|
[2072] | 133 | |
---|
| 134 | #endif /* _LevelManager_H__ */ |
---|