Changeset 2911 for code/trunk/src/orxonox/objects/quest

Timestamp:

Apr 8, 2009, 2:58:40 AM (16 years ago)

Author:

landauf

Message:

Merged r1-2096 of questsystem5 back to trunk

I hope there weren't more "hidden merge changes" in r2909 than the one in OverlayGroup (removeElement) (and related to this the adjustments in NotificationQueue).

The corresponding media commit seems not yet to be done, but it doesn't break the build.

Location:

code/trunk

Files:

• . (modified) (1 prop)
• src/orxonox/objects/quest/AddQuest.cc (modified) (4 diffs, 1 prop)
• src/orxonox/objects/quest/AddQuest.h (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/AddQuestHint.cc (modified) (2 diffs, 1 prop)
• src/orxonox/objects/quest/AddQuestHint.h (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/AddReward.cc (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/AddReward.h (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/CMakeLists.txt (modified) (1 diff)
• src/orxonox/objects/quest/ChangeQuestStatus.cc (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/ChangeQuestStatus.h (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/CompleteQuest.cc (modified) (2 diffs, 1 prop)
• src/orxonox/objects/quest/CompleteQuest.h (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/FailQuest.cc (modified) (2 diffs, 1 prop)
• src/orxonox/objects/quest/FailQuest.h (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/GlobalQuest.cc (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/GlobalQuest.h (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/LocalQuest.cc (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/LocalQuest.h (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/Quest.cc (modified) (2 diffs, 1 prop)
• src/orxonox/objects/quest/Quest.h (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/QuestDescription.cc (modified) (5 diffs, 1 prop)
• src/orxonox/objects/quest/QuestDescription.h (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/QuestEffect.cc (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/QuestEffect.h (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/QuestEffectBeacon.cc (modified) (1 diff)
• src/orxonox/objects/quest/QuestEffectBeacon.h (modified) (1 diff)
• src/orxonox/objects/quest/QuestHint.cc (modified) (2 diffs, 1 prop)
• src/orxonox/objects/quest/QuestHint.h (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/QuestItem.cc (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/QuestItem.h (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/QuestListener.cc (modified) (2 diffs)
• src/orxonox/objects/quest/QuestListener.h (modified) (1 diff)
• src/orxonox/objects/quest/QuestManager.cc (modified) (11 diffs, 1 prop)
• src/orxonox/objects/quest/QuestManager.h (modified) (3 diffs, 1 prop)
• src/orxonox/objects/quest/QuestNotification.cc (copied) (copied from code/branches/questsystem5/src/orxonox/objects/quest/QuestNotification.cc)
• src/orxonox/objects/quest/QuestNotification.h (copied) (copied from code/branches/questsystem5/src/orxonox/objects/quest/QuestNotification.h)
• src/orxonox/objects/quest/Rewardable.cc (modified) (1 diff, 1 prop)
• src/orxonox/objects/quest/Rewardable.h (modified) (1 diff, 1 prop)

code/trunk/src/orxonox/objects/quest/AddQuest.cc

@@ -28 +28 @@
 
 /**
-    @file
+    @file AddQuest.cc
     @brief Implementation of the AddQuest class.
 */
@@ -42 +42 @@
 #include "orxonox/objects/infos/PlayerInfo.h"
 #include "QuestManager.h"
+#include "QuestDescription.h"
 #include "Quest.h"
 
@@ -72 +73 @@
     {
         SUPER(AddQuest, XMLPort, xmlelement, mode);
-        
+
         COUT(3) << "New AddQuest, with target Quest {" << this->getQuestId() << "}, created." << std::endl;
     }
@@ -96 +97 @@
         try
         {
-            Quest* quest = QuestManager::findQuest(this->getQuestId());
+            Quest* quest = QuestManager::getInstance().findQuest(this->getQuestId());
             if(quest == NULL || !quest->start(player))
             {

code/trunk/src/orxonox/objects/quest/AddQuest.h

@@ -28 +28 @@
 
 /**
-    @file
+    @file AddQuest.h
     @brief Definition of the AddQuest class.
 */

code/trunk/src/orxonox/objects/quest/AddQuestHint.cc

@@ -28 +28 @@
 
 /**
-    @file
+    @file AddQuestHint.cc
     @brief Implementation of the AddQuestHint class.
 */
@@ -117 +117 @@
         try
         {
-            QuestHint* hint = QuestManager::findHint(this->hintId_);
+            QuestHint* hint = QuestManager::getInstance().findHint(this->hintId_);
             if(hint == NULL || !hint->setActive(player))
             {

code/trunk/src/orxonox/objects/quest/AddQuestHint.h

@@ -28 +28 @@
 
 /**
-    @file
+    @file AddQuestHint.h
     @brief Definition of the AddQuestHint class.
 */

code/trunk/src/orxonox/objects/quest/AddReward.cc

@@ -28 +28 @@
 
 /**
-    @file
+    @file AddReward.cc
     @brief Implementation of the AddReward class.
 */

code/trunk/src/orxonox/objects/quest/AddReward.h

@@ -28 +28 @@
 
 /**
-    @file
+    @file AddReward.h
     @brief Definition of the AddReward class.
 */

code/trunk/src/orxonox/objects/quest/CMakeLists.txt

@@ -16 +16 @@
   QuestListener.cc
   QuestManager.cc
+  QuestNotification.cc
   Rewardable.cc
 )

code/trunk/src/orxonox/objects/quest/ChangeQuestStatus.cc

@@ -28 +28 @@
 
 /**
-    @file
+    @file ChangeQuestStatus.cc
     @brief Implementation of the ChangeQuestStatus class.
 */

code/trunk/src/orxonox/objects/quest/ChangeQuestStatus.h

@@ -28 +28 @@
 
 /**
-    @file
+    @file ChangeQuestStatus.h
     @brief Definition of the ChangeQuestStatus class.
 */

code/trunk/src/orxonox/objects/quest/CompleteQuest.cc

@@ -28 +28 @@
  
 /**
-    @file
+    @file CompleteQuest.cc
     @brief Implementation of the CompleteQuest class.
 */
@@ -96 +96 @@
         try
         {
-            quest = QuestManager::findQuest(this->getQuestId());
+            quest = QuestManager::getInstance().findQuest(this->getQuestId());
             if(quest == NULL || !quest->complete(player))
             {

code/trunk/src/orxonox/objects/quest/CompleteQuest.h

@@ -28 +28 @@
 
 /**
-    @file
+    @file CompleteQuest.h
     @brief Definition of the CompleteQuest class.
 */

code/trunk/src/orxonox/objects/quest/FailQuest.cc

@@ -28 +28 @@
  
 /**
-    @file
+    @file FailQuest.cc
     @brief Implementation of the FailQuest class.
 */
@@ -95 +95 @@
         try
         {
-            quest = QuestManager::findQuest(this->getQuestId());
+            quest = QuestManager::getInstance().findQuest(this->getQuestId());
             if(quest == NULL || !quest->fail(player))
             {

code/trunk/src/orxonox/objects/quest/FailQuest.h

@@ -28 +28 @@
 
 /**
-    @file
+    @file FailQuest.h
     @brief Definition of the FailQuest class.
 */

code/trunk/src/orxonox/objects/quest/GlobalQuest.cc

@@ -28 +28 @@
  
 /**
-    @file
+    @file GlobalQuest.cc
     @brief Implementation of the GlobalQuest class.
 */

code/trunk/src/orxonox/objects/quest/GlobalQuest.h

@@ -28 +28 @@
  
 /**
-    @file
+    @file GlobalQuest.h
     @brief Definition of the GlobalQuest class.
 */

code/trunk/src/orxonox/objects/quest/LocalQuest.cc

@@ -28 +28 @@
 
 /**
-    @file
+    @file LocalQuest.cc
     @brief Implementation of the LocalQuest class.
 */

code/trunk/src/orxonox/objects/quest/LocalQuest.h

@@ -28 +28 @@
  
 /**
-    @file
+    @file LocalQuest.h
     @brief Definition of the LocalQuest class.
 */

code/trunk/src/orxonox/objects/quest/Quest.cc

@@ -28 +28 @@
  
 /**
-    @file
+    @file Quest.cc
     @brief Implementation of the Quest class.
 */
@@ -79 +79 @@
         XMLPortObject(Quest, QuestEffect, "complete-effects", addCompleteEffect, getCompleteEffect, xmlelement, mode);
 
-        QuestManager::registerQuest(this); //!<Registers the Quest with the QuestManager.
+        QuestManager::getInstance().registerQuest(this); //!<Registers the Quest with the QuestManager.
     }
 

code/trunk/src/orxonox/objects/quest/Quest.h

@@ -28 +28 @@
  
 /**
-    @file
+    @file Quest.h
     @brief Definition of the Quest class.
         The Quest is the parent class of LocalQuest and GlobalQuest.

code/trunk/src/orxonox/objects/quest/QuestDescription.cc

@@ -28 +28 @@
 
 /**
-    @file
+    @file QuestDescription.cc
     @brief Implementation of the QuestDescription class.
 */
@@ -37 +37 @@
 
 #include "core/CoreIncludes.h"
-#include "orxonox/overlays/notifications/Notification.h"
+#include "QuestNotification.h"
 
 namespace orxonox
@@ -89 +89 @@
     @return
         Returns true if successful.
+    @todo
+        Make sure the messages meet the conditions.
     */
     bool QuestDescription::notificationHelper(const std::string & item, const std::string & status) const
     {
         std::string message = "";
-        std::string title = "";
         if(item == "hint")
         {
-            title = "You received a hint: '" + this->title_ + "'";
-            message = this->description_;
+            message = "You received a hint: '" + this->title_ + "'";
         }
         else if(item == "quest")
@@ -103 +103 @@
             if(status == "start")
             {
-                title = "You received a new quest: '" + this->title_ + "'";
-                message = this->description_;
+                message = "You received a new quest: '" + this->title_ + "'";
             }
             else if(status == "fail")
             {
-                title = "You failed the quest: '" + this->title_ + "'";
-                message = this->failMessage_;
+                message = "You failed the quest: '" + this->title_ + "'";
             }
             else if(status == "complete")
             {
-                title = "You successfully completed the quest: '" + this->title_ + "'";
-                message = this->completeMessage_;
+                message = "You successfully completed the quest: '" + this->title_ + "'";
             }
             else
@@ -128 +125 @@
         }
         
-        Notification* notification = new Notification(0, message, title, 30);
+        QuestNotification* notification = new QuestNotification(message);
         notification->send();
         return true;

code/trunk/src/orxonox/objects/quest/QuestDescription.h

@@ -28 +28 @@
 
 /**
-    @file
+    @file QuestDescription.h
     @brief Definition of the QuestDescription class.
 */

code/trunk/src/orxonox/objects/quest/QuestEffect.cc

@@ -28 +28 @@
 
 /**
-    @file
+    @file QuestEffect.cc
     @brief Implementation of the QuestEffect class.
 */

code/trunk/src/orxonox/objects/quest/QuestEffect.h

@@ -28 +28 @@
  
 /**
-    @file
+    @file QuestEffect.h
     @brief Definition of the QuestEffect class.
 */

code/trunk/src/orxonox/objects/quest/QuestEffectBeacon.cc

@@ -28 +28 @@
 
 /**
-    @file
+    @file QuestEffectBeacon.cc
     @brief Implementation of the QuestEffectBeacon class.
 */

code/trunk/src/orxonox/objects/quest/QuestEffectBeacon.h

@@ -28 +28 @@
 
 /**
-    @file
+    @file QuestEffectBeacon.h
     @brief Definition of the QuestEffectBeacon class.
 */

code/trunk/src/orxonox/objects/quest/QuestHint.cc

@@ -28 +28 @@
  
 /**
-    @file
+    @file QuestHint.cc
     @brief Implementation of the QuestHint class.
 */
@@ -73 +73 @@
         SUPER(QuestHint, XMLPort, xmlelement, mode);
 
-        QuestManager::registerHint(this); //!< Registers the QuestHint with the QuestManager.
+        QuestManager::getInstance().registerHint(this); //!< Registers the QuestHint with the QuestManager.
         
         COUT(3) << "New QuestHint {" << this->getId() << "} created." << std::endl;

code/trunk/src/orxonox/objects/quest/QuestHint.h

@@ -28 +28 @@
  
 /**
-    @file
+    @file QuestHint.h
     @brief Definition of the QuestHint class.
 */

code/trunk/src/orxonox/objects/quest/QuestItem.cc

@@ -28 +28 @@
  
 /**
-    @file
+    @file QuestItem.cc
     @brief Implementation of the QuestItem class.
 */

code/trunk/src/orxonox/objects/quest/QuestItem.h

@@ -28 +28 @@
  
 /**
-    @file
+    @file QuestItem.h
     @brief Definition of the QuestItem class.
         The QuestItem is the parent class of Quest and QuestHint.

code/trunk/src/orxonox/objects/quest/QuestListener.cc

@@ -28 +28 @@
 
 /**
-    @file
+    @file QuestListener.cc
     @brief Implementation of the QuestListener class.
 */
@@ -112 +112 @@
     bool QuestListener::setQuestId(const std::string & id)
     {
-        this->quest_ = QuestManager::findQuest(id); //!< Find the Quest corresponding to the given questId.
+        this->quest_ = QuestManager::getInstance().findQuest(id); //!< Find the Quest corresponding to the given questId.
         
         if(this->quest_ == NULL) //!< If there is no such Quest.

code/trunk/src/orxonox/objects/quest/QuestListener.h

@@ -28 +28 @@
 
 /**
-    @file
+    @file QuestListener.h
     @brief Definition of the QuestListener class.
 */

code/trunk/src/orxonox/objects/quest/QuestManager.cc

@@ -28 +28 @@
 
 /**
-    @file
+    @file QuestManager.cc
     @brief Implementation of the QuestManager class.
 */
@@ -43 +43 @@
 namespace orxonox
 {
-    //! All Quests registered by their id's.
-    std::map<std::string, Quest*> QuestManager::questMap_s;
-    //! All QuestHints registered by their id's.
-    std::map<std::string, QuestHint*> QuestManager::hintMap_s;
+    //! Pointer to the current (and single) instance of this class.
+    QuestManager* QuestManager::singletonRef_s = NULL;
 
     /**
     @brief
         Constructor. Registers the object.
-    */
-    QuestManager::QuestManager(BaseObject* creator) : BaseObject(creator)
-    {
-        RegisterObject(QuestManager);
+    @todo
+        Is inheriting from BaseObject proper?
+    */
+    QuestManager::QuestManager()
+    {
+        RegisterRootObject(QuestManager);
+
+        assert(singletonRef_s == 0);
+        singletonRef_s = this;
     }
 
@@ -64 +67 @@
     {
 
+    }
+
+    /**
+    @brief
+        Returns a reference to the current (and single) instance of the QuestManager, and creates one if there isn't one to begin with.
+    @return
+        Returns a reference to the single instance of the Quest Manager.
+    */
+    /*static*/ QuestManager & QuestManager::getInstance()
+    {
+        assert(singletonRef_s);
+        return *singletonRef_s;
     }
 
@@ -75 +90 @@
         Returns true if successful, false if not.
     */
-    /*static*/ bool QuestManager::registerQuest(Quest* quest)
+    bool QuestManager::registerQuest(Quest* quest)
     {
         if(quest == NULL) //!< Doh! Just as if there were actual quests behind NULL-pointers.
@@ -84 +99 @@
 
         std::pair<std::map<std::string, Quest*>::iterator,bool> result;
-        result = questMap_s.insert( std::pair<std::string,Quest*>(quest->getId(),quest) ); //!< Inserting the Quest.
+        result = this->questMap_.insert( std::pair<std::string,Quest*>(quest->getId(),quest) ); //!< Inserting the Quest.
 
         if(result.second) //!< If inserting was a success.
@@ -107 +122 @@
         Returns true if successful, false if not.
     */
-    /*static*/ bool QuestManager::registerHint(QuestHint* hint)
+    bool QuestManager::registerHint(QuestHint* hint)
     {
         if(hint == NULL) //!< Still not liking NULL-pointers.
@@ -116 +131 @@
 
         std::pair<std::map<std::string, QuestHint*>::iterator,bool> result;
-        result = hintMap_s.insert ( std::pair<std::string,QuestHint*>(hint->getId(),hint) ); //!< Inserting the QuestHSint.
+        result = this->hintMap_.insert ( std::pair<std::string,QuestHint*>(hint->getId(),hint) ); //!< Inserting the QuestHSint.
 
         if(result.second) //!< If inserting was a success.
@@ -141 +156 @@
         Throws an exception if the given questId is invalid.
     */
-    /*static*/ Quest* QuestManager::findQuest(const std::string & questId)
+    Quest* QuestManager::findQuest(const std::string & questId)
     {
         if(!QuestItem::isId(questId)) //!< Check vor validity of the given id.
@@ -149 +164 @@
 
         Quest* quest;
-        std::map<std::string, Quest*>::iterator it = questMap_s.find(questId);
-        if (it != questMap_s.end()) //!< If the Quest is registered.
+        std::map<std::string, Quest*>::iterator it = this->questMap_.find(questId);
+        if (it != this->questMap_.end()) //!< If the Quest is registered.
         {
             quest = it->second;
@@ -175 +190 @@
         Throws an exception if the given hintId is invalid.
     */
-    /*static*/ QuestHint* QuestManager::findHint(const std::string & hintId)
+    QuestHint* QuestManager::findHint(const std::string & hintId)
     {
         if(!QuestItem::isId(hintId)) //!< Check vor validity of the given id.
@@ -183 +198 @@
 
         QuestHint* hint;
-        std::map<std::string, QuestHint*>::iterator it = hintMap_s.find(hintId);
-        if (it != hintMap_s.end()) //!< If the QuestHint is registered.
+        std::map<std::string, QuestHint*>::iterator it = this->hintMap_.find(hintId);
+        if (it != this->hintMap_.end()) //!< If the QuestHint is registered.
         {
             hint = it->second;

code/trunk/src/orxonox/objects/quest/QuestManager.h

@@ -28 +28 @@
 
 /**
-    @file
+    @file QuestManager.h
     @brief Definition of the QuestManager class.
 */
@@ -40 +40 @@
 #include <string>
 
-#include "core/BaseObject.h"
+#include "core/OrxonoxClass.h"
 
 namespace orxonox
@@ -46 +46 @@
     /**
     @brief
-        Is a static class and manages Quests, by registering every Quest/QuestHint (through registerX()) and making them globally accessable (through findX()).
+        Is a Singleton and manages Quests, by registering every Quest/QuestHint (through registerX()) and making them globally accessable (through findX()).
         Quests (and QuestHints) are registered in the QuestManager with their id, and can be accessed in the same way.
     @author
         Damian 'Mozork' Frick
     */
-    class _OrxonoxExport QuestManager : public BaseObject
+    class _OrxonoxExport QuestManager : public OrxonoxClass
     {
-
         public:
-            QuestManager(BaseObject* creator);
+            QuestManager();
             virtual ~QuestManager();
 
-            static bool registerQuest(Quest* quest); //!< Registers a Quest in the QuestManager.
-            static bool registerHint(QuestHint* quest); //!< Registers a QuestHint in the QuestManager.
+            static QuestManager& getInstance(); //!< Returns a reference to the single instance of the Quest Manager.
 
-            static Quest* findQuest(const std::string & questId); //!< Returns the Quest with the input id.
-            static QuestHint* findHint(const std::string & hintId); //!< Returns the QuestHint with the input id.
+            bool registerQuest(Quest* quest); //!< Registers a Quest in the QuestManager.
+            bool registerHint(QuestHint* quest); //!< Registers a QuestHint in the QuestManager.
+
+            Quest* findQuest(const std::string & questId); //!< Returns the Quest with the input id.
+            QuestHint* findHint(const std::string & hintId); //!< Returns the QuestHint with the input id.
 
         private:
-            static std::map<std::string, Quest*> questMap_s; //!< All Quests registered by their id's.
-            static std::map<std::string, QuestHint*> hintMap_s; //!< All QuestHints registered by their id's.
+            static QuestManager* singletonRef_s;
+
+            std::map<std::string, Quest*> questMap_; //!< All Quests registered by their id's.
+            std::map<std::string, QuestHint*> hintMap_; //!< All QuestHints registered by their id's.
 
     };

code/trunk/src/orxonox/objects/quest/Rewardable.cc

@@ -28 +28 @@
 
 /**
-    @file
+    @file Rewardable.cc
     @brief Implementation of the Rewardable class.
 */

code/trunk/src/orxonox/objects/quest/Rewardable.h

@@ -28 +28 @@
 
 /**
-    @file
+    @file Rewardable.h
     @brief Definition of the Rewardable class.
 */