Changeset 2191 for code/branches/questsystem2/src/orxonox/objects/quest/AddReward.h

Timestamp:

Nov 12, 2008, 1:29:33 PM (15 years ago)

Author:

dafrick

Message:

Just changed some small stuff…

File:

• code/branches/questsystem2/src/orxonox/objects/quest/AddReward.h (modified) (2 diffs)

code/branches/questsystem2/src/orxonox/objects/quest/AddReward.h

@@ -47 +47 @@
     /**
     @brief
-        Adds a list of rewards to a player.
+        Adds a list of Rewardables to a player.
     @author
         Damian 'Mozork' Frick
@@ -59 +59 @@
             virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a AddReward object through XML.
 
-            virtual bool invoke(ControllableEntity* player); //!< Invokes the effect.
+            virtual bool invoke(ControllableEntity* player); //!< Invokes the QuestEffect.
 
         private:
-            std::list<Rewardable*> rewards_; //!< A list of rewards to be added to the player invoking the effect.
+            std::list<Rewardable*> rewards_; //!< A list of Rewardables to be added to the player invoking the QuestEffect.
 
-            inline void addRewardable(Rewardable* reward) //!< Add a rewardable object to the list of objects to be awarded to the player invoking the effect.
+            /**
+            @brief Add a Rewardable object to the list of objects to be awarded to the player invoking the QuestEffect.
+            @param reward Pointer to the Rewardable to be added.
+            */
+            inline void addRewardable(Rewardable* reward)
                 { this->rewards_.push_back(reward); }
-            const Rewardable* getRewardables(unsigned int index) const; //!< Returns the rewardable object at the given index.
+            const Rewardable* getRewardables(unsigned int index) const; //!< Returns the Rewardable object at the given index.
 
     };