Changeset 5938 for code/trunk/src/modules/questsystem/QuestEffectBeacon.cc

Timestamp:

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

Author:

dafrick

Message:

Some more updated documentation, this time in QuestEffectBeacon.

File:

• code/trunk/src/modules/questsystem/QuestEffectBeacon.cc (modified) (3 diffs)

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();