Changeset 5936

Timestamp:

Oct 13, 2009, 9:49:54 PM (15 years ago)

Author:

dafrick

Message:

Updated documentation in PlayerTrigger.

File:

• code/trunk/src/orxonox/interfaces/PlayerTrigger.h (modified) (6 diffs)

code/trunk/src/orxonox/interfaces/PlayerTrigger.h

@@ -43 +43 @@
     /**
     @brief
-        A PlayerTrigger is a trigger which is normally triggered by ControllableEntities and can as such return a pointer to the ControllableEntity which triggered it.
+        A PlayerTrigger is a trigger which is normally triggered by Pawns and can as such return a pointer to the Pawn which triggered it.
     @author
         Damian 'Mozork' Frick
@@ -55 +55 @@
         /**
         @brief Returns the player that triggered the PlayerTrigger.
-        @return Returns a pointer to the ControllableEntity that triggered the PlayerTrigger.
+        @return Returns a pointer to the Pawn that triggered the PlayerTrigger.
         */
         inline Pawn* getTriggeringPlayer(void) const
@@ -61 +61 @@
 
         /**
-        @brief Checks whether the PlayerTrigger normally returns a ControllableEntity.
-        @return Returns true if the PlayerTrigger normally returns a ControllableEntity.
+        @brief Checks whether the PlayerTrigger normally returns a Pawn.
+        @return Returns true if the PlayerTrigger normally returns a Pawn.
         */
         inline bool isForPlayer(void) const
@@ -70 +70 @@
         /**
         @brief Set the player that triggered the PlayerTrigger. This is normally done by classes inheriting vom PlayerTrigger.
-        @param player A pointer to the ControllableEntity that triggered the PlayerTrigger.
+        @param player A pointer to the Pawn that triggered the PlayerTrigger.
         */
         inline void setTriggeringPlayer(Pawn* player)
@@ -76 +76 @@
 
             /**
-            @brief Set whether the PlayerTrigger normally is triggered by ControllableEntities.
-            @param isForPlayer Should be true when the PlayerTrigger should be set to normally be triggered by ControllableEntities, false if not.
+            @brief Set whether the PlayerTrigger normally is triggered by Pawns.
+            @param isForPlayer Should be true when the PlayerTrigger should be set to normally be triggered by Pawns, false if not.
             */
         inline void setForPlayer(bool isForPlayer)
@@ -84 +84 @@
     private:
         Pawn* player_; //!< The player that triggered the PlayerTrigger.
-        bool isForPlayer_; //!< Is true when the PlayerTrigger should be set to normally be triggered by ControllableEntities.
+        bool isForPlayer_; //!< Is true when the PlayerTrigger should be set to normally be triggered by Pawns.
 
     };