Changeset 2530 for code/branches/bugger/src/orxonox/objects/quest/ChangeQuestStatus.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/ChangeQuestStatus.h (modified) (3 diffs, 1 prop)

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

@@ -27 +27 @@
  */
 
+/**
+    @file ChangeQuestStatus.h
+    @brief
+    Definition of the ChangeQuestStatus class.
+*/
+
 #ifndef _ChangeQuestStatus_H__
 #define _ChangeQuestStatus_H__
@@ -39 +45 @@
 namespace orxonox {
 
-    class Player; //Forward declaration, remove when fully integrated into the objecthirarchy.
-
     /**
     @brief
-        An effect which changes a quests status.
+        A QuestEffect which changes the status of a specified Quest for the player invoking the QuestEffect.
     @author
         Damian 'Mozork' Frick
@@ -53 +57 @@
             virtual ~ChangeQuestStatus();
 
-            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
+            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a ChangeQuestStatus object through XML.
 
-            virtual bool invoke(Player* player) = 0; //!< Invokes the effect.
+            virtual bool invoke(PlayerInfo* player) = 0; //!< Invokes the QuestEffect.
 
         protected:
-            inline const std::string & getQuestId(void) const //!< Returns the quest id.
+            /**
+                @brief Returns the id of the Quest.
+                @return Returns the id of the Quest.
+            */
+            inline const std::string & getQuestId(void) const
                 { return this->questId_; }
 
-            std::string questId_; //!< The id of the quest the status should be changed of.
-
         private:
-            void setQuestId(const std::string & id);
+            std::string questId_; //!< The id of the Quest the status should be changed of.
+            
+            bool setQuestId(const std::string & id); //!< Sets the id of the Quest.
 
     };