Changeset 2221 for code/branches/questsystem2/src/orxonox/objects/worldentities/triggers/PlayerTrigger.h

Timestamp:

Nov 19, 2008, 11:50:03 AM (15 years ago)

Author:

dafrick

Message:

Some tweaks and solved some bugs…

File:

• code/branches/questsystem2/src/orxonox/objects/worldentities/triggers/PlayerTrigger.h (modified) (3 diffs)

code/branches/questsystem2/src/orxonox/objects/worldentities/triggers/PlayerTrigger.h

@@ -26 +26 @@
  *
  */
- 
+
+/**
+    @file PlayerTrigger.h
+    @brief
+        Definition of the PlayerTrigger class.
+*/
+
 #ifndef _PlayerTrigger_H__
 #define _PlayerTrigger_H__
+
+#include "OrxonoxPrereqs.h"
 
 #include "Trigger.h"
@@ -36 +44 @@
     /**
     @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.
     @author
         Damian 'Mozork' Frick
@@ -46 +54 @@
             virtual ~PlayerTrigger();
             
-            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
+            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a PlayerTrigger object through XML.
             
+            /**
+            @brief Returns the player that triggered the PlayerTrigger.
+            @return Returns a pointer to the ControllableEntity that triggered the PlayerTrigger.
+            */
             inline ControllableEntity* getTriggeringPlayer(void) const
                 { return this->player_; }
+            
+            /**
+            @brief Checks whether the PlayerTrigger normally returns a ControllableEntity.
+            @return Returns true if the PlayerTrigger normally returns a ControllableEntity.
+            */
+            inline bool isForPlayer(void) const
+               { return this->isForPlayer_; }
             
         protected:
             virtual bool isTriggered(TriggerMode mode) = 0;
             
+            /**
+            @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.
+            */
             inline void setTriggeringPlayer(ControllableEntity* player)
                { this->player_ = player; }
-            inline bool isForPlayer(void) const
-               { return this->isForPlayer_; }
+
+            /**
+            @brief Set whether the PlayerTrigger normally is triggered by ControllableEntities.
+            @param isForPlayer Should be true when the PlayerTrigger schould be set to normally be triggered by ControllableEntities, false if not.
+            */
             inline void setForPlayer(bool isForPlayer)
                { this->isForPlayer_ = isForPlayer; }
             
         private:
-            ControllableEntity* player_;
-            bool isForPlayer_;
+            ControllableEntity* player_; //!< The player that triggered the PlayerTrigger.
+            bool isForPlayer_; //!< Is true when the PlayerTrigger schould be set to normally be triggered by ControllableEntities.
         
     };