Changeset 2068 for code/branches/questsystem/src/orxonox/objects/QuestHint.cc

Timestamp:

Oct 30, 2008, 9:52:12 AM (16 years ago)

Author:

dafrick

Message:

Started with XMLPort…

File:

• code/branches/questsystem/src/orxonox/objects/QuestHint.cc (modified) (7 diffs)

code/branches/questsystem/src/orxonox/objects/QuestHint.cc

@@ -28 +28 @@
 
 #include "core/CoreIncludes.h"
+#include "util/Exception.h"
 
 #include "Quest.h"
@@ -36 +37 @@
     CreateFactory(QuestHint);
 
+    /**
+    @brief
+        Constructor.
+    */
     QuestHint::QuestHint() : QuestItem()
     {
-        
+        this->initialize();
     }
 
@@ -51 +56 @@
         The description of the hint, resp. the hint itself.
     */
-    QuestHint::QuestHint(std::string id, std::string title, std::string description) : QuestItem(id, title, description)
+    QuestHint::QuestHint(std::string id) : QuestItem(id)
     {
-        RegisterObject(QuestHint);
+        this->initialize();
     }
     
@@ -65 +70 @@
     }
     
+    void QuestHint::initialize(void)
+    {
+        RegisterObject(QuestHint);
+    }
+    
+    void QuestHint::XMLPort(Element& xmlelement, XMLPort::Mode mode)
+    {
+        SUPER(QuestHint, XMLPort, xmlelement, mode);
+    }
+
+    
     /**
     @brief
@@ -70 +86 @@
     @param player
         The player.
+    @throws
+        Throws an Argument Exception if the input Player-pointer is NULL.
     @return
-        Returns 
+        Returns true if the hint is active for the specified player.
     */
     bool QuestHint::isActive(Player* player)
     {
+        if(player == NULL)
+        {
+            ThrowException(Argument, "The input Player* is NULL.");
+            return false;
+        }
+        
         std::map<Player*, questHintStatus::Enum>::iterator it = this->playerStatus_.find(player);
         if (it != this->playerStatus_.end())
@@ -85 +109 @@
     /**
     @brief
+        Activates a QuestHint for a given player.
     @param player
+        The player.
     @return
+        Returns true if the activation was successful, false if there were problems.
     */
     bool QuestHint::activate(Player* player)
     {
-        if(this->quest_->isActive(player) && !(this->isActive(player)))
+        if(this->quest_->isActive(player))
         {
-            this->playerStatus_[player] = questHintStatus::active;
-            return true;
+            if(!(this->isActive(player)))
+            {
+                this->playerStatus_[player] = questHintStatus::active;
+                return true;
+            }
+            else
+            {
+                COUT(2) << "An already active questHint was trying to get activated." << std::endl;
+                return false;
+            }
         }
         COUT(2) << "A hint of a non-active quest was trying to get activated." << std::endl;
@@ -101 +136 @@
     /**
     @brief
+        Sets the quest the QuestHitn belongs to.
     @param quest
     @return
     */
-    void QuestHint::setQuest(Quest* quest)
+    bool QuestHint::setQuest(Quest* quest)
     {
+        if(quest == NULL)
+        {
+            COUT(2) << "The input Quest* is NULL." << std::endl;
+            return false;
+        }
+        
         this->quest_ = quest;
+        return true;
     }