Changeset 7456 for code/trunk/src/modules/questsystem/QuestEffectBeacon.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/QuestEffectBeacon.cc (modified) (14 diffs)

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

@@ -28 +28 @@
 
 /**
-    @file
+    @file QuestEffectBeacon.cc
     @brief Implementation of the QuestEffectBeacon class.
 */
@@ -37 +37 @@
 #include "core/XMLPort.h"
 #include "core/EventIncludes.h"
+
+#include "interfaces/PlayerTrigger.h"
 #include "worldentities/pawns/Pawn.h"
-#include "interfaces/PlayerTrigger.h"
+
 #include "objects/triggers/MultiTriggerContainer.h"
 #include "QuestEffect.h"
@@ -50 +52 @@
         Constructor. Registers the object and initializes defaults.
     */
+    //TODO: Make just BaseObject?
     QuestEffectBeacon::QuestEffectBeacon(BaseObject* creator) : StaticEntity(creator)
     {
@@ -99 +102 @@
         Returns true if successfully executed, false if not.
     */
+    //TODO: Eliminate MultiTriggerContainer stuff, since they are now PlayerTriggers as well.
     bool QuestEffectBeacon::execute(bool bTriggered, BaseObject* trigger)
     {
@@ -105 +109 @@
             return false;
         }
-        if(!(this->isActive())) //!< If the QuestEffectBeacon is inactive it cannot be executed.
+        if(!(this->isActive())) // If the QuestEffectBeacon is inactive it cannot be executed.
         {
             COUT(4) << "The QuestEffectBeacon is inactive." << std::endl;
@@ -115 +119 @@
         Pawn* pawn = NULL;
 
-        //! If the trigger is neither a Playertrigger nor a MultiTrigger (i.e. a MultitriggerContainer) we can do anything with it.
+        // If the trigger is neither a Playertrigger nor a MultiTrigger (i.e. a MultitriggerContainer) we can do anything with it.
         if(pTrigger == NULL && mTrigger == NULL)
             return false;
@@ -122 +126 @@
         if(pTrigger != NULL)
         {
-            if(!pTrigger->isForPlayer())  //!< The PlayerTrigger is not exclusively for Pawns which means we cannot extract one.
+            if(!pTrigger->isForPlayer())  // The PlayerTrigger is not exclusively for Pawns which means we cannot extract one.
                 return false;
             else
@@ -140 +144 @@
         }
 
-        //! Extract the PlayerInfo from the Pawn.
+        // Extract the PlayerInfo from the Pawn.
         PlayerInfo* player = pawn->getPlayer();
 
@@ -151 +155 @@
         COUT(4) << "QuestEffectBeacon executed on player: " << player << " ." << std::endl;
 
-        bool check = QuestEffect::invokeEffects(player, this->effects_); //!< Invoke the QuestEffects on the PlayerInfo.
+        bool check = QuestEffect::invokeEffects(player, this->effects_); // Invoke the QuestEffects on the PlayerInfo.
         if(check)
         {
-            this->decrementTimes(); //!< Decrement the number of times the beacon can be used.
+            this->decrementTimes(); // Decrement the number of times the beacon can be used.
             return true;
         }
@@ -171 +175 @@
     bool QuestEffectBeacon::setActive(bool activate)
     {
-        if(this->getTimes() == 0 && activate) //!< A QuestEffectBeacon that can be executed only 0 times is always inactive.
-        {
-            return false;
-        }
+        if(this->getTimes() == 0 && activate) // A QuestEffectBeacon that can be executed only 0 times is always inactive.
+            return false;
 
         if(activate)
         {
-        this->status_ = QuestEffectBeaconStatus::Active;
-        return true;
+            this->status_ = QuestEffectBeaconStatus::Active;
+            return true;
         }
 
@@ -194 +196 @@
     bool QuestEffectBeacon::decrementTimes(void)
     {
-        if(!(this->isActive())) //!< The QuestEffectBeacon mus be active to decrement the number of times it can be executed.
-        {
-            return false;
-        }
-        if(this->getTimes() == INFINITE_TIME) //!< If times is infinity the QuestEffectBeacon can be executed an infinite number fo times.
-        {
+        if(!(this->isActive())) // The QuestEffectBeacon mus be active to decrement the number of times it can be executed.
+            return false;
+
+        if(this->getTimes() == INFINITE_TIME) // If times is infinity the QuestEffectBeacon can be executed an infinite number fo times.
             return true;
-        }
-
-        this->times_ = this->times_ - 1; //!< Decrement number of times the QuestEffectBeacon can be executed.
-        if(this->getTimes() == 0) //!< Set the QuestEffectBeacon to inactive when the number of times it can be executed is reduced to 0.
-        {
+
+        this->times_ = this->times_ - 1; // Decrement number of times the QuestEffectBeacon can be executed.
+        if(this->getTimes() == 0) // Set the QuestEffectBeacon to inactive when the number of times it can be executed is reduced to 0.
             this->status_ = QuestEffectBeaconStatus::Inactive;
-        }
 
         return true;
@@ -225 +222 @@
     {
         if(n < 0 && n != INFINITE_TIME)
-        {
-            return false;
-        }
+            return false;
 
         this->times_ = n;
@@ -243 +238 @@
     bool QuestEffectBeacon::addEffect(QuestEffect* effect)
     {
-        if(effect == NULL) //!< NULL-pointers are not well liked here...
+        //TODO: Replace with assert.
+        if(effect == NULL) // NULL-pointers are not well liked here...
         {
             COUT(2) << "A NULL-QuestEffect was trying to be added" << std::endl;
@@ -269 +265 @@
         {
             if(i == 0)
-            {
                return *effect;
-            }
+
             i--;
         }