Changeset 5938 for code/trunk/src/modules

Timestamp:

Oct 13, 2009, 10:17:01 PM (15 years ago)

Author:

dafrick

Message:

Some more updated documentation, this time in QuestEffectBeacon.

Location:

code/trunk/src/modules/questsystem

Files:

• QuestEffectBeacon.cc (modified) (3 diffs)
• QuestEffectBeacon.h (modified) (1 diff)

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

@@ -90 +90 @@
     @brief
         Executes the QuestEffectBeacon.
-        This means extracting the ControllableEntity from the PlayerTrigger, provided by the Event causing the execution, and the extracting the PlayerInfo from the received ControllableEntity and invoking the QuestEffectbeacon's QuestEffects on the received PlayerInfo.
+        This means extracting the Pawn from the PlayerTrigger, provided by the Event causing the execution, and the extracting the PlayerInfo from the received Pawn and invoking the QuestEffectbeacon's QuestEffects on the received PlayerInfo.
     @param trigger
         Apointer to the PlayerTrigger that threw the Event.
@@ -108 +108 @@
         }
 
-        if(!trigger->isForPlayer()) //!< The PlayerTrigger is not exclusively for ControllableEntities which means we cannot extract one.
-        {
-            return false;
-        }
-
-        //! Extracting the ControllableEntity form the PlayerTrigger.
+        if(!trigger->isForPlayer()) //!< The PlayerTrigger is not exclusively for Pawns which means we cannot extract one.
+        {
+            return false;
+        }
+
+        //! Extracting the Pawn from the PlayerTrigger.
         Pawn* pawn = trigger->getTriggeringPlayer();
 
@@ -122 +122 @@
         }
 
-        //! Extract the PlayerInfo from the ControllableEntity.
+        //! Extract the PlayerInfo from the Pawn.
         PlayerInfo* player = pawn->getPlayer();
 

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

@@ -114 +114 @@
             std::list<QuestEffect*> effects_; //!< The list of QuestEffects to be invoked on the executing player.
             int times_; //!< Number of times the beacon can be exectued.
-            QuestEffectBeaconStatus::Value status_; //!< The status of the QUestEffectBeacon, Can be eighter active or inactive.
+            QuestEffectBeaconStatus::Value status_; //!< The status of the QuestEffectBeacon, Can be eighter active or inactive.
 
             bool setTimes(const int & n); //!< Set the number of times the QuestEffectBeacon can be executed.