Changeset 2530 for code/branches/bugger/src/orxonox/objects/quest/Rewardable.h

Timestamp:

Dec 23, 2008, 10:40:38 PM (17 years ago)

Author:

rgrieder

Message:

merged revisions 2260 - 2508 from trunk to buggy.
I'm sorry that I have to commit every merge. But otherwise I get tons of conflicts I have to solve ten times over.
Note: did not merge deletion of src/util/testing, tortoise wasn't very friendly with that.

Location:

code/branches/bugger

Files:

• . (modified) (1 prop)
• src/orxonox/objects/quest/Rewardable.h (modified) (3 diffs, 1 prop)

code/branches/bugger/src/orxonox/objects/quest/Rewardable.h

@@ -27 +27 @@
  */
 
+/**
+    @file Rewardable.h
+    @brief
+    Definition of the Rewardable class.
+*/
+
 #ifndef _Rewardable_H__
 #define _Rewardable_H__
@@ -36 +42 @@
 namespace orxonox {
 
-    class Player; //Forward declaration, remove when fully integrated in objecthirarchy.
-
     /**
     @brief
-        Rewardable is an Interface, that can be implemented by any object to enable it to be given as reward to a player through QuestEffects.
+        Rewardable is an Interface, that can be implemented by any object to enable it to be given as reward to a player through QuestEffects. (With the AddReward effect.)
+        
+        It just needs to inherit form Rewardable, and implement the reward() method.
     @author
         Damian 'Mozork' Frick
@@ -51 +57 @@
             virtual ~Rewardable();
 
-            virtual bool reward(Player* player) = 0; //!<Method to transcribe a rewardable object to the player.
+            /**
+            @brief
+                Method to transcribe a rewardable object to the player.
+                Must be implemented by every class inheriting from Rewardable.
+        @param player
+                A pointer to the ControllableEntity, do whatever you want with it.
+        @return
+                Return true if successful.
+            */
+            virtual bool reward(PlayerInfo* player) = 0; //!<
 
     };