Changeset 7456 for code/trunk/src/modules/questsystem/LocalQuest.cc

Timestamp:

Sep 15, 2010, 7:29:16 PM (14 years ago)

Author:

dafrick

Message:

Reviewing documentation fo Questsystem, moving documentation fully into doxygen.
Added some files to modules they belong to.

File:

• code/trunk/src/modules/questsystem/LocalQuest.cc (modified) (9 diffs)

code/trunk/src/modules/questsystem/LocalQuest.cc

@@ -28 +28 @@
 
 /**
-    @file
+    @file LocalQuest.cc
     @brief Implementation of the LocalQuest class.
 */
@@ -36 +36 @@
 #include "core/CoreIncludes.h"
 #include "core/XMLPort.h"
+
 #include "QuestEffect.h"
 
@@ -82 +83 @@
     bool LocalQuest::fail(PlayerInfo* player)
     {
-        if(!this->isFailable(player)) //!< Checks whether the quest can be failed.
+        if(!this->isFailable(player)) // Checks whether the quest can be failed.
         {
             COUT(4) << "A non-failable quest was trying to be failed." << std::endl;
@@ -90 +91 @@
         Quest::fail(player);
 
-        QuestEffect::invokeEffects(player, this->getFailEffectList()); //!< Invoke the failEffects.
+        QuestEffect::invokeEffects(player, this->getFailEffectList()); // Invoke the failEffects.
         return true;
     }
@@ -105 +106 @@
     bool LocalQuest::complete(PlayerInfo* player)
     {
-        if(!this->isCompletable(player)) //!< Checks whether the Quest can be completed.
+        if(!this->isCompletable(player)) // Checks whether the Quest can be completed.
         {
             COUT(4) << "A non-completable quest was trying to be completed." << std::endl;
@@ -113 +114 @@
         Quest::complete(player);
 
-        QuestEffect::invokeEffects(player, this->getCompleteEffectList()); //!< Invoke the complete QuestEffects.
+        QuestEffect::invokeEffects(player, this->getCompleteEffectList()); // Invoke the complete QuestEffects.
         return true;
     }
@@ -130 +131 @@
     {
         if(!(this->getParentQuest() == NULL || this->getParentQuest()->isActive(player)))
-        {
-            return false;
-        }
+            return false;
+
         return this->isInactive(player);
     }
@@ -178 +178 @@
     QuestStatus::Value LocalQuest::getStatus(const PlayerInfo* player) const
     {
-        if(player == NULL) //!< No player has no defined status.
-        {
+        //TODO: Replace with assert.
+        if(player == NULL) // No player has no defined status.
             ThrowException(Argument, "The input PlayerInfo* is NULL.");
-        }
 
         std::map<const PlayerInfo*, QuestStatus::Value>::const_iterator it = this->playerStatus_.find(player);
-        if (it != this->playerStatus_.end()) //!< If there is a player in the map.
-        {
+        if (it != this->playerStatus_.end()) // If there is a player in the map.
             return it->second;
-        }
-
-        return QuestStatus::Inactive; //!< If the player is not yet in the map, that means the status of the quest form him is 'inactive'.
+
+        return QuestStatus::Inactive; // If the player is not yet in the map, that means the status of the quest form him is 'inactive'.
     }
 
@@ -205 +202 @@
     bool LocalQuest::setStatus(PlayerInfo* player, const QuestStatus::Value & status)
     {
-        if(player == NULL) //!< We can't set a status for no player.
-        {
-            return false;
-        }
+        //TODO: Replace with assert.
+        if(player == NULL) // We can't set a status for no player.
+            return false;
 
         this->playerStatus_[player] = status;