Changeset 2261 for code/trunk/src/orxonox/objects/quest/AddQuest.h

Timestamp:

Nov 25, 2008, 11:56:40 PM (15 years ago)

Author:

landauf

Message:

merged questsystem2 back to trunk

Location:

code/trunk

Files:

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

code/trunk/src/orxonox/objects/quest/AddQuest.h

@@ -27 +27 @@
  */
 
+/**
+    @file AddQuest.h
+    @brief
+    Definition of the AddQuest class.
+*/
+
 #ifndef _AddQuest_H__
 #define _AddQuest_H__
@@ -39 +45 @@
 namespace orxonox {
 
-    class Player; //Forward declaration, remove when fully integrated into the objecthirarchy.
-
     /**
     @brief
-        Adds a quest, resp. changes the quests status to active.
+        Adds a Quest, resp. changes the quests status to active for the player invoking the Quest.
+        
+        Creating a AddQuest through XML goes as follows:
+        
+        <AddQuest questId="id" />  //Where id is a GUID, see http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure for more information, and identifies the Quest that should be added.
     @author
         Damian 'Mozork' Frick
@@ -53 +61 @@
             virtual ~AddQuest();
 
-            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
+            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a AddQuest object through XML.
 
-            virtual bool invoke(Player* player); //!< Invokes the effect.
+            virtual bool invoke(PlayerInfo* player); //!< Invokes the QuestEffect.
 
     };