Changeset 2146 for code/branches/questsystem2/src/orxonox/objects/quest/QuestHint.cc

Timestamp:

Nov 6, 2008, 12:02:05 AM (16 years ago)

Author:

dafrick

Message:

Started implementation of QuestEffectBeacon.
Done some documentation of QuestItem and subclasses.

File:

• code/branches/questsystem2/src/orxonox/objects/quest/QuestHint.cc (modified) (8 diffs)

code/branches/questsystem2/src/orxonox/objects/quest/QuestHint.cc

@@ -26 +26 @@
  *
  */
+ 
+/**
+    @file QuestHint.cc
+    @brief
+        Implementation of the QuestHint class.
+*/
 
 #include "OrxonoxStableHeaders.h"
@@ -33 +39 @@
 #include "util/Exception.h"
 
+#include "orxonox/objects/worldentities/ControllableEntity.h"
 #include "Quest.h"
 
@@ -41 +48 @@
     /**
     @brief
-        Constructor.
+        Constructor. Initializes the object.
     */
     QuestHint::QuestHint(BaseObject* creator) : QuestItem(creator)
     {
+        this->initialize();
+    }
+    
+    /**
+    @brief
+        Initialize the object.
+    */
+    void QuestHint::initialize(void)
+    {
         RegisterObject(QuestHint);
-
-        this->initialize();
     }
 
@@ -59 +73 @@
     }
 
-    void QuestHint::initialize(void)
-    {
-        RegisterObject(QuestHint);
-    }
-
+    /**
+    @brief
+        Method for creating a QuestHint object through XML.
+    */
     void QuestHint::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     {
@@ -82 +95 @@
         Returns true if the hint is active for the specified player.
     */
-    bool QuestHint::isActive(Player* player)
+    bool QuestHint::isActive(ControllableEntity* player)
     {
-        if(player == NULL)
+        if(player == NULL) //!< NULL-Pointers are ugly!
         {
-            ThrowException(Argument, "The input Player* is NULL.");
+            ThrowException(Argument, "The input ControllableEntity* is NULL.");
             return false;
         }
 
-        std::map<Player*, questHintStatus::Enum>::iterator it = this->playerStatus_.find(player);
-        if (it != this->playerStatus_.end())
+        //! Find the player.
+        std::map<ControllableEntity*, questHintStatus::Enum>::iterator it = this->playerStatus_.find(player);
+        if (it != this->playerStatus_.end()) //!< If the player is in the map.
         {
             return it->second;
         }
+        
         return questStatus::inactive;
     }
@@ -106 +121 @@
         Returns true if the activation was successful, false if there were problems.
     */
-    bool QuestHint::activate(Player* player)
+    bool QuestHint::setActive(ControllableEntity* player)
     {
-        if(this->quest_->isActive(player))
+        if(this->quest_->isActive(player)) //!< For a hint to get activated the quest must be active.
         {
-            if(!(this->isActive(player)))
+            if(!(this->isActive(player)))  //!< If the hint is already active, activation is pointless.
             {
                 this->playerStatus_[player] = questHintStatus::active;
@@ -121 +136 @@
             }
         }
+        
         COUT(2) << "A hint of a non-active quest was trying to get activated." << std::endl;
         return false;
@@ -129 +145 @@
         Sets the quest the QuestHitn belongs to.
     @param quest
+        The quest to be set as quest the hint is attached to.
     @return
+        Returns true if successful.
     */
     bool QuestHint::setQuest(Quest* quest)
     {
-        if(quest == NULL)
+        if(quest == NULL) //!< NULL-Pointer. Again..?
         {
             COUT(2) << "The input Quest* is NULL." << std::endl;