Changeset 2251

Timestamp:

Nov 23, 2008, 4:31:36 PM (16 years ago)

Author:

dafrick

Message:

Some cleanup…

Location:

code/branches/questsystem2/src/orxonox/objects/quest

Files:

• AddQuest.cc (modified) (1 diff)
• AddQuest.h (modified) (1 diff)
• AddQuestHint.cc (modified) (1 diff)
• AddQuestHint.h (modified) (2 diffs)
• AddReward.cc (modified) (1 diff)
• AddReward.h (modified) (1 diff)
• ChangeQuestStatus.cc (modified) (1 diff)
• ChangeQuestStatus.h (modified) (1 diff)
• CompleteQuest.cc (modified) (1 diff)
• CompleteQuest.h (modified) (1 diff)
• FailQuest.cc (modified) (1 diff)
• FailQuest.h (modified) (1 diff)
• GlobalQuest.cc (modified) (4 diffs)
• GlobalQuest.h (modified) (2 diffs)
• LocalQuest.cc (modified) (4 diffs)
• LocalQuest.h (modified) (2 diffs)
• Quest.cc (modified) (2 diffs)
• Quest.h (modified) (5 diffs)
• QuestDescription.cc (modified) (1 diff)
• QuestDescription.h (modified) (3 diffs)
• QuestEffect.cc (modified) (1 diff)
• QuestEffect.h (modified) (1 diff)
• QuestEffectBeacon.cc (modified) (6 diffs)
• QuestEffectBeacon.h (modified) (4 diffs)
• QuestHint.cc (modified) (1 diff)
• QuestHint.h (modified) (1 diff)
• QuestItem.cc (modified) (2 diffs)
• QuestItem.h (modified) (2 diffs)
• QuestManager.cc (modified) (1 diff)
• QuestManager.h (modified) (1 diff)
• Rewardable.cc (modified) (1 diff)
• Rewardable.h (modified) (2 diffs)

code/branches/questsystem2/src/orxonox/objects/quest/AddQuest.cc

@@ -30 +30 @@
     @file AddQuest.cc
     @brief
-        Implementation of the AddQuest class.
+    Implementation of the AddQuest class.
 */
 

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

@@ -30 +30 @@
     @file AddQuest.h
     @brief
-        Definition of the AddQuest class.
+    Definition of the AddQuest class.
 */
 

code/branches/questsystem2/src/orxonox/objects/quest/AddQuestHint.cc

@@ -30 +30 @@
     @file AddQuestHint.cc
     @brief
-        Implementation of the AddQuestHint class.
+    Implementation of the AddQuestHint class.
 */
 

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

@@ -30 +30 @@
     @file AddQuestHint.h
     @brief
-        Definition of the AddQuestHint class.
+    Definition of the AddQuestHint class.
 */
 
@@ -48 +48 @@
         Adds a QuestHint, resp. activates the QuestHint of the given id for the player the QuestEffect is invoked on.
         
-        Creating a AddQuestHint through XML goes as follows:
+    Creating a AddQuestHint through XML goes as follows:
         
         <AddQuestHint hintId="id" />  //Where id is a GUID, see http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure for more information, and identifies the QuestHint that should be added.

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

@@ -30 +30 @@
     @file AddReward.cc
     @brief
-        Implementation of the AddReward class.
+    Implementation of the AddReward class.
 */
 

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

@@ -30 +30 @@
     @file AddReward.h
     @brief
-        Definition of the AddReward class.
+    Definition of the AddReward class.
 */
 

code/branches/questsystem2/src/orxonox/objects/quest/ChangeQuestStatus.cc

@@ -30 +30 @@
     @file ChangeQuestStatus.cc
     @brief
-        Implementation of the ChangeQuestStatus class.
+    Implementation of the ChangeQuestStatus class.
 */
 

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

@@ -30 +30 @@
     @file ChangeQuestStatus.h
     @brief
-        Definition of the ChangeQuestStatus class.
+    Definition of the ChangeQuestStatus class.
 */
 

code/branches/questsystem2/src/orxonox/objects/quest/CompleteQuest.cc

@@ -30 +30 @@
     @file CompleteQuest.cc
     @brief
-        Implementation of the CompleteQuest class.
+    Implementation of the CompleteQuest class.
 */
 

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

@@ -30 +30 @@
     @file CompleteQuest.h
     @brief
-        Definition of the CompleteQuest class.
+    Definition of the CompleteQuest class.
 */
 

code/branches/questsystem2/src/orxonox/objects/quest/FailQuest.cc

@@ -30 +30 @@
     @file FailQuest.cc
     @brief
-        Implementation of the FailQuest class.
+    Implementation of the FailQuest class.
 */
 

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

@@ -30 +30 @@
     @file FailQuest.h
     @brief
-        Definition of the FailQuest class.
+    Definition of the FailQuest class.
 */
 

code/branches/questsystem2/src/orxonox/objects/quest/GlobalQuest.cc

@@ -30 +30 @@
     @file GlobalQuest.cc
     @brief
-        Implementation of the GlobalQuest class.
+    Implementation of the GlobalQuest class.
 */
 
@@ -101 +101 @@
         }
         
-        COUT(2) << "A non-completable quest was trying to be failed." << std::endl;
+        COUT(4) << "A non-completable quest was trying to be failed." << std::endl;
         return false;
     }
@@ -131 +131 @@
         }
         
-        COUT(2) << "A non-completable quest was trying to be completed." << std::endl;
+        COUT(4) << "A non-completable quest was trying to be completed." << std::endl;
         return false;
     }
@@ -203 +203 @@
         }
 
-        return questStatus::inactive;
+    return questStatus::inactive;
     }
 

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

@@ -30 +30 @@
     @file GlobalQuest.h
     @brief
-        Definition of the GlobalQuest class.
+    Definition of the GlobalQuest class.
 */
 
@@ -56 +56 @@
             <QuestDescription title="Title" description="Description." /> //The description of the quest.
             <subquests>
-                <Quest id ="questId1" /> //A list of n subquest, be aware, each of the <Quest /> tags must have a description and so on and so forth as well.
-                ...
-                <Quest id="questIdn" />
-            </subquests>
-            <hints>
-                <QuestHint id="hintId1" /> //A list of n QuestHints, see QuestHint for the full XML representation of those.
-                ...
-                <QuestHint id="hintIdn" />
-            </hints>
+        <Quest id ="questId1" /> //A list of n subquest, be aware, each of the <Quest /> tags must have a description and so on and so forth as well.
+        ...
+        <Quest id="questIdn" />
+        </subquests>
+        <hints>
+        <QuestHint id="hintId1" /> //A list of n QuestHints, see QuestHint for the full XML representation of those.
+        ...
+        <QuestHint id="hintIdn" />
+        </hints>
             <fail-effects>
                 <QuestEffect /> //A list of QuestEffects, invoked on all players possessing this quest, when the Quest is failed, see QuestEffect for the full XML representation.

code/branches/questsystem2/src/orxonox/objects/quest/LocalQuest.cc

@@ -30 +30 @@
     @file LocalQuest.cc
     @brief
-        Implementation of the LocalQuest class.
+    Implementation of the LocalQuest class.
 */
 
@@ -93 +93 @@
         }
         
-        COUT(2) << "A non-failable quest was trying to be failed." << std::endl;
+        COUT(4) << "A non-failable quest was trying to be failed." << std::endl;
         return false;
     }
@@ -100 +100 @@
     @brief
         Completes the Quest for a given player.
-        Invokes all the complete QuestEffects on the player.
+    Invokes all the complete QuestEffects on the player.
     @param player
         The player.
@@ -115 +115 @@
         }
         
-        COUT(2) << "A non-completable quest was trying to be completed." << std::endl;
+        COUT(4) << "A non-completable quest was trying to be completed." << std::endl;
         return false;
     }

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

@@ -30 +30 @@
     @file LocalQuest.h
     @brief
-        Definition of the LocalQuest class.
+    Definition of the LocalQuest class.
 */
 
@@ -56 +56 @@
             <QuestDescription title="Title" description="Description." /> //The description of the quest.
             <subquests>
-                <Quest id ="questId1" /> //A list of n subquest, be aware, each of the <Quest /> tags must have a description and so on and so forth as well.
-                ...
-                <Quest id="questIdn" />
-            </subquests>
-            <hints>
-                <QuestHint id="hintId1" /> //A list of n QuestHints, see QuestHint for the full XML representation of those.
-                ...
-                <QuestHint id="hintIdn" />
-            </hints>
+        <Quest id ="questId1" /> //A list of n subquest, be aware, each of the <Quest /> tags must have a description and so on and so forth as well.
+        ...
+        <Quest id="questIdn" />
+        </subquests>
+        <hints>
+        <QuestHint id="hintId1" /> //A list of n QuestHints, see QuestHint for the full XML representation of those.
+        ...
+        <QuestHint id="hintIdn" />
+        </hints>
             <fail-effects>
                 <QuestEffect /> //A list of QuestEffects, invoked when the Quest is failed, see QuestEffect for the full XML representation.

code/branches/questsystem2/src/orxonox/objects/quest/Quest.cc

@@ -30 +30 @@
     @file Quest.cc
     @brief
-        Implementation of the Quest class.
+    Implementation of the Quest class.
 */
 
@@ -380 +380 @@
         }
         
-        COUT(2) << "A non-startable quest was trying to be started." << std::endl;
+        COUT(4) << "A non-startable quest was trying to be started." << std::endl;
         return false;
     }

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

@@ -30 +30 @@
     @file Quest.h
     @brief
-        Definition of the Quest class.
-        
-        The Quest is the parent class of LocalQuest and GlobalQuest.
+    Definition of the Quest class.
+    
+    The Quest is the parent class of LocalQuest and GlobalQuest.
 */
  
@@ -90 +90 @@
                 { return this->parentQuest_; }
                 
-            /**
-            @brief Returns the list of subquests.
-            @return Returns a reference to the list of subquests of the quest.
-            */
+        /**
+        @brief Returns the list of subquests.
+        @return Returns a reference to the list of subquests of the quest.
+        */
             inline const std::list<Quest*> & getSubQuestList(void) const
                 { return this->subQuests_; }
                 
-            /**
-            @brief Returns the list of all QuestHints of this Quest.
-            @return Returns a reference to the list of QuestHints of the Quest.
-            */
-            inline const std::list<QuestHint*> & getHintsList(void) const
+        /**
+        @brief Returns the list of all QuestHints of this Quest.
+        @return Returns a reference to the list of QuestHints of the Quest.
+        */
+        inline const std::list<QuestHint*> & getHintsList(void) const
                 { return this->hints_; }
 
@@ -110 +110 @@
 
             bool start(PlayerInfo* player); //!< Sets a Quest to active.
-            virtual bool fail(PlayerInfo* player) = 0; //!< Fails the Quest.
+        virtual bool fail(PlayerInfo* player) = 0; //!< Fails the Quest.
             virtual bool complete(PlayerInfo* player) = 0; //!< Completes the Quest.
 
@@ -131 +131 @@
                 { return this->failEffects_; }
                 
-            /**
-            @brief Returns the list of complete QuestEffects.
-            @return Returns a reference to the list of complete QuestEffects.
-            */
-            inline std::list<QuestEffect*> & getCompleteEffectList(void)
+        /**
+        @brief Returns the list of complete QuestEffects.
+        @return Returns a reference to the list of complete QuestEffects.
+        */
+        inline std::list<QuestEffect*> & getCompleteEffectList(void)
                 { return this->completeEffects_; }
 
@@ -141 +141 @@
             virtual bool setStatus(PlayerInfo* player, const questStatus::Enum & status) = 0; //!< Changes the status for a specific player.
             
-        private:
+    private:
             Quest* parentQuest_; //!< Pointer to the parentquest.
             std::list<Quest*> subQuests_; //!< List of all the subquests.

code/branches/questsystem2/src/orxonox/objects/quest/QuestDescription.cc

@@ -30 +30 @@
     @file QuestDescription.cc
     @brief
-        Implementation of the QuestDescription class.
+    Implementation of the QuestDescription class.
 */
 

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

@@ -30 +30 @@
     @file QuestDescription.h
     @brief
-        Definition of the QuestDescription class.
+    Definition of the QuestDescription class.
 */
 
@@ -64 +64 @@
             virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a QuestDescription object through XML.
 
-            /**
-            @brief Returns the title.
-            @return Returns a string containing the title of the QuestDescription.
-            */
+        /**
+        @brief Returns the title.
+        @return Returns a string containing the title of the QuestDescription.
+        */
             inline const std::string & getTitle(void) const
                 { return this->title_; }
-            
-            /**
-            @brief Returns the description text.
-            @return Returns a string containing the description text of the QuestDescription.
-            */
+        
+        /**
+        @brief Returns the description text.
+        @return Returns a string containing the description text of the QuestDescription.
+        */
             inline const std::string & getDescription(void) const
                 { return this->description_; }
@@ -89 +89 @@
                 { this->title_ = title; }
                 
-            /**
+        /**
             @brief Sets the description text.
             @param description The description text to be set.

code/branches/questsystem2/src/orxonox/objects/quest/QuestEffect.cc

@@ -30 +30 @@
     @file QuestEffect.cc
     @brief
-        Implementation of the QuestEffect class.
+    Implementation of the QuestEffect class.
 */
 

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

@@ -30 +30 @@
     @file QuestEffect.h
     @brief
-        Definition of the QuestEffect class.
+    Definition of the QuestEffect class.
 */
 

code/branches/questsystem2/src/orxonox/objects/quest/QuestEffectBeacon.cc

@@ -30 +30 @@
     @file QuestEffectBeacon.cc
     @brief
-        Implementation of the QuestEffectBeacon class.
+    Implementation of the QuestEffectBeacon class.
 */
 
@@ -91 +91 @@
         SUPER(QuestEffectBeacon, processEvent, event);
     
-        SetSubclassEvent(QuestEffectBeacon, "execute", execute, event, PlayerTrigger);
+    SetSubclassEvent(QuestEffectBeacon, "execute", execute, event, PlayerTrigger);
     }
     
@@ -98 +98 @@
         Executes the QuestEffectBeacon.
         This means extracting the ControllableEntity from the PlayerTrigger, provided by the Event causing the execution, and the extracting the PlayerInfo from the received ControllableEntity and invoking the QuestEffectbeacon's QuestEffects on the received PlayerInfo.
-    @param b
-        TDO: What is this???
     @param trigger
         Apointer to the PlayerTrigger that threw the Event.
@@ -147 +145 @@
             this->decrementTimes(); //!< Decrement the number of times the beacon can be used.
             return true;
-        }
-
-        return false;
+    }
+
+    return false;
     }
     
@@ -169 +167 @@
         if(activate)
         {
-            this->status_ = QuestEffectBeaconStatus::active;
-            return true;
+        this->status_ = QuestEffectBeaconStatus::active;
+        return true;
         }
         
@@ -195 +193 @@
         
         this->times_ = this->times_ - 1; //!< Decrement number of times the QuestEffectBeacon can be executed.
-        if(this->getTimes() == 0) //!< Set the QuestEffectBeacon to inactive when the number of times it can be executed is reduced to 0.
-        {
+    if(this->getTimes() == 0) //!< Set the QuestEffectBeacon to inactive when the number of times it can be executed is reduced to 0.
+    {
             this->status_ = QuestEffectBeaconStatus::inactive;
-        }
+    }
         
         return true;

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

@@ -30 +30 @@
     @file QuestEffectBeacon.h
     @brief
-        Definition of the QuestEffectBeacon class.
+    Definition of the QuestEffectBeacon class.
 */
 
@@ -61 +61 @@
         A QuestEffectBeacon can be inactive or active.
         
-        Creating a QuestEffectBeacon through XML goes as follows:
-        
-        <QuestEffectBeacon times=n> //Where 'n' is eighter a number >= 0, which means the QuestEffectBeacon can be executed n times. Or n = -1, which means the QuestEffectBeacon can be executed an infinite number of times.
+    Creating a QuestEffectBeacon through XML goes as follows:
+    
+    <QuestEffectBeacon times=n> //Where 'n' is eighter a number >= 0, which means the QuestEffectBeacon can be executed n times. Or n = -1, which means the QuestEffectBeacon can be executed an infinite number of times.
             <effects>
                 <QuestEffect /> //A list of QuestEffects, invoked when the QuestEffectBeacon is executed, see QuestEffect for the full XML representation.
@@ -70 +70 @@
             </effects>
             <events>
-                <execute>
-                    <EventListener event=eventIdString />
-                </execute>
-            </events>
-            <attached>
-               <PlayerTrigger name=eventIdString /> //A PlayerTrigger triggering the execution of the QuestEffectBeacon.
-            </attached>
-        </QuestEffectBeacon>
+        <execute>
+            <EventListener event=eventIdString />
+        </execute>
+        </events>
+        <attached>
+           <PlayerTrigger name=eventIdString /> //A PlayerTrigger triggering the execution of the QuestEffectBeacon.
+        </attached>
+    </QuestEffectBeacon>
     @author
         Damian 'Mozork' Frick
@@ -83 +83 @@
     class _OrxonoxExport QuestEffectBeacon : public PositionableEntity
     {
-        public:
-            QuestEffectBeacon(BaseObject* creator);
-            virtual ~QuestEffectBeacon();
-            
-            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a QuestEffectBeacon object through XML.
-            
-            virtual void processEvent(Event& event); //!< Processes an event for this QuestEffectBeacon.
-            
-            bool execute(bool b, PlayerTrigger* trigger); //!< Executes the QuestEffects of the QuestEffectBeacon.
-            
-            /**
-            @brief Tests whether the QuestEffectBeacon is active.
-            @return Returns true if the QuestEffectBeacon is active, fals if not.
-            */
-            inline bool isActive(void)
-               { return this->status_ == QuestEffectBeaconStatus::active; }
-            
-            bool setActive(bool activate); //!< Set the status of the QuestEffectBeacon.
-            
-        protected:
+    public:
+        QuestEffectBeacon(BaseObject* creator);
+        virtual ~QuestEffectBeacon();
+        
+        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a QuestEffectBeacon object through XML.
+        
+        virtual void processEvent(Event& event); //!< Processes an event for this QuestEffectBeacon.
+        
+        bool execute(bool b, PlayerTrigger* trigger); //!< Executes the QuestEffects of the QuestEffectBeacon.
+        
+        /**
+        @brief Tests whether the QuestEffectBeacon is active.
+        @return Returns true if the QuestEffectBeacon is active, fals if not.
+        */
+        inline bool isActive(void)
+           { return this->status_ == QuestEffectBeaconStatus::active; }
+        
+        bool setActive(bool activate); //!< Set the status of the QuestEffectBeacon.
+        
+    protected:
             bool decrementTimes(void); //!< Decrement the number of times the QuestEffectBeacon can still be executed.
             

code/branches/questsystem2/src/orxonox/objects/quest/QuestHint.cc

@@ -30 +30 @@
     @file QuestHint.cc
     @brief
-        Implementation of the QuestHint class.
+    Implementation of the QuestHint class.
 */
 

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

@@ -30 +30 @@
     @file QuestHint.h
     @brief
-        Definition of the QuestHint class.
+    Definition of the QuestHint class.
 */
 

code/branches/questsystem2/src/orxonox/objects/quest/QuestItem.cc

@@ -30 +30 @@
     @file QuestItem.cc
     @brief
-        Implementation of the QuestItem class.
+    Implementation of the QuestItem class.
 */
 
@@ -77 +77 @@
     @brief
         Sets the id of the QuestItem.
-        The id must be of GUID form. See 'http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure' for more information.
+    The id must be of GUID form. See 'http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure' for more information.
     @param id
         The id to be set.

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

@@ -30 +30 @@
     @file QuestItem.h
     @brief
-        Definition of the QuestItem class.
-        
-        The QuestItem is the parent class of Quest and QuestHint.
+    Definition of the QuestItem class.
+    
+    The QuestItem is the parent class of Quest and QuestHint.
 */
 
@@ -67 +67 @@
             /**
             @brief Returns the id of this QuestItem.
-            @return Returns the id of the QuestItem.
+        @return Returns the id of the QuestItem.
             */
             inline const std::string & getId(void) const
                 { return this->id_; }
-            /**
-            @brief Returns the QuestDescription of the QuestItem.
-            @return Returns a pointer to the QuestDescription object of the QuestItem.
-            */
+        /**
+        @brief Returns the QuestDescription of the QuestItem.
+        @return Returns a pointer to the QuestDescription object of the QuestItem.
+        */
             inline const QuestDescription* getDescription(void) const
                 { return this->description_; }

code/branches/questsystem2/src/orxonox/objects/quest/QuestManager.cc

@@ -30 +30 @@
     @file QuestManager.cc
     @brief
-        Implementation of the QuestManager class.
+    Implementation of the QuestManager class.
 */
 

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

@@ -30 +30 @@
     @file QuestManager.h
     @brief
-        Definition of the QuestManager class.
+    Definition of the QuestManager class.
 */
 

code/branches/questsystem2/src/orxonox/objects/quest/Rewardable.cc

@@ -30 +30 @@
     @file Rewardable.cc
     @brief
-        Implementation of the Rewardable class.
+    Implementation of the Rewardable class.
 */
 

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

@@ -30 +30 @@
     @file Rewardable.h
     @brief
-        Definition of the Rewardable class.
+    Definition of the Rewardable class.
 */
 
@@ -61 +61 @@
                 Method to transcribe a rewardable object to the player.
                 Must be implemented by every class inheriting from Rewardable.
-            @param player
+        @param player
                 A pointer to the ControllableEntity, do whatever you want with it.
-            @return
+        @return
                 Return true if successful.
             */