Changeset 7456 for code/trunk/src/modules/questsystem/QuestListener.h

Timestamp:

Sep 15, 2010, 7:29:16 PM (15 years ago)

Author:

dafrick

Message:

Reviewing documentation fo Questsystem, moving documentation fully into doxygen.
Added some files to modules they belong to.

File:

• code/trunk/src/modules/questsystem/QuestListener.h (modified) (5 diffs)

code/trunk/src/modules/questsystem/QuestListener.h

@@ -28 +28 @@
 
 /**
-    @file
+    @file QuestListener.h
     @brief Definition of the QuestListener class.
+    @ingroup Questsystem
 */
 
@@ -45 +46 @@
     namespace QuestListenerMode
     {
-        //! The mode of the QuestListener.
+        //! The mode of the @ref orxonox::QuestListener "QuestListener".
         enum Value
         {
@@ -57 +58 @@
     /**
     @brief
-        Provides a way to react to the starting, completing and failing of Quests.
+        Provides a way to react to the starting, completing and failing of @ref orxonox::Quest "Quests".
 
         The XML representation goes as follows:
-        You can use the QuestListener as if it were a Trigger or EventListener, that fires an Event when the status (depending on the set mode) of the given Quest changes.
-
         @code
         <BaseObject> // The object that should react to the status change of a Quest.
@@ -71 +70 @@
         </BaseObject>
         @endcode
+
+        You can use the QuestListener as if it were a @ref orxonox::Trigger "Trigger" or @ref orxonox::EventListener "EventListener", that fires an Event when the status (depending on the set mode) of the given @ref orxonox::Quest "Quest" changes.
     @author
     Damian 'Mozork' Frick
@@ -76 +77 @@
     class _QuestsystemExport QuestListener : public BaseObject
     {
-    public:
-        QuestListener(BaseObject* creator);
-        virtual ~QuestListener();
 
-        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a QuestListener object through XML.
+        public:
+            QuestListener(BaseObject* creator);
+            virtual ~QuestListener();
 
-        static void advertiseStatusChange(std::list<QuestListener*> & listeners, const std::string & status); //!< Makes all QuestListener in the list aware that a certain status change has occured.
+            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a QuestListener object through XML.
 
-        bool setQuestId(const std::string & id); //!< Sets the questId of the Quest the QuestListener reacts to.
-        bool setMode(const std::string & mode); //!< Sets the mode of the QuestListener.
+            static void advertiseStatusChange(std::list<QuestListener*> & listeners, const std::string & status); //!< Makes all QuestListener in the list aware that a certain status change has occured.
 
-        std::string getMode(void); //!< Get the mode of the QuestListener.
+            bool setQuestId(const std::string & id); //!< Sets the questId of the Quest the QuestListener reacts to.
+            bool setMode(const std::string & mode); //!< Sets the mode of the QuestListener.
 
-        const std::string & getQuestId(void);
-        bool execute(void); //!< Executes the QuestListener, resp. fires an Event.
+            std::string getMode(void); //!< Get the mode of the QuestListener.
 
-    private:
-        QuestListenerMode::Value mode_; //!< The mode of the QuestListener.
-        Quest* quest_; //!< A pointer to the Quest the QuestListener is reacting to.
+            const std::string & getQuestId(void);
+            bool execute(void); //!< Executes the QuestListener, resp. fires an Event.
+
+        private:
+            QuestListenerMode::Value mode_; //!< The mode of the QuestListener.
+            Quest* quest_; //!< A pointer to the Quest the QuestListener is reacting to.
+
+            //! Static variables for the modes as strings.
+            static const std::string ALL;
+            static const std::string START;
+            static const std::string FAIL;
+            static const std::string COMPLETE;
 
     };