Changeset 2146 for code/branches/questsystem2/src/orxonox/objects/quest/Quest.cc

Timestamp:

Nov 6, 2008, 12:02:05 AM (16 years ago)

Author:

dafrick

Message:

Started implementation of QuestEffectBeacon.
Done some documentation of QuestItem and subclasses.

File:

• code/branches/questsystem2/src/orxonox/objects/quest/Quest.cc (modified) (25 diffs)

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

@@ -26 +26 @@
  *
  */
+ 
+/**
+    @file Quest.cc
+    @brief
+        Implementation of the Quest class.
+*/
 
 #include "OrxonoxStableHeaders.h"
@@ -32 +38 @@
 #include "core/CoreIncludes.h"
 
+#include "orxonox/objects/worldentities/ControllableEntity.h"
 #include "QuestManager.h"
 #include "QuestDescription.h"
@@ -39 +46 @@
 namespace orxonox {
 
+    /**
+    @brief
+        Constructor. Initializes object.
+    */
     Quest::Quest(BaseObject* creator) : QuestItem(creator)
     {
+        this->initialize();
+    }
+    
+    /**
+    @brief
+        Initializes the object. Needs to be called first in every constructor of this class.
+        Sets defaults.
+    */
+    void Quest::initialize(void)
+    {
         RegisterObject(Quest);
 
-        this->initialize();
+        this->parentQuest_ = NULL;
     }
 
@@ -55 +76 @@
     }
 
+    /**
+    @brief
+        Method for creating a Quest object through XML.
+    */
     void Quest::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     {
         SUPER(Quest, XMLPort, xmlelement, mode);
 
-        XMLPortObject(Quest, Quest, "", addSubQuest, getSubQuests, xmlelement, mode);
-        XMLPortObject(Quest, QuestHint, "", addHint, getHints, xmlelement, mode);
+        XMLPortObject(Quest, Quest, "subquests", addSubQuest, getSubQuests, xmlelement, mode);
+        XMLPortObject(Quest, QuestHint, "hints", addHint, getHints, xmlelement, mode);
         XMLPortObject(Quest, QuestEffect, "fail-effects", addFailEffect, getFailEffects, xmlelement, mode);
         XMLPortObject(Quest, QuestEffect, "complete-effects", addCompleteEffect, getCompleteEffects, xmlelement, mode);
 
         QuestManager::registerQuest(this); //Registers the quest with the QuestManager.
-    }
-
-    /**
-    @brief
-        Initializes the object. Needs to be called first in every constructor of this class.
-    */
-    void Quest::initialize(void)
-    {
-        RegisterObject(Quest);
-
-        this->parentQuest_ = NULL;
     }
 
@@ -88 +102 @@
     bool Quest::setParentQuest(Quest* quest)
     {
-        if(quest == NULL)
+        if(quest == NULL) //!< We don't want to set NULL-Pointers.
         {
             COUT(2) << "The parentquest to be added to quest {" << this->getId() << "} was NULL." << std::endl;
@@ -110 +124 @@
     bool Quest::addSubQuest(Quest* quest)
     {
-        if(quest == NULL)
+        if(quest == NULL) //!< We don't want to set NULL-Pointers.
         {
             COUT(2) << "The subquest to be added to quest {" << this->getId() << "} was NULL." << std::endl;
@@ -116 +130 @@
         }
 
-        quest->setParentQuest(this);
-        this->subQuests_.push_back(quest);
+        quest->setParentQuest(this); //!< Sets the current quest (this) as parent quest for the added subquest.
+        this->subQuests_.push_back(quest); //!< Adds the quest to the end of the list of subquests.
 
         COUT(3) << "Sub Quest {" << quest->getId() << "} was added to Quest {" << this->getId() << "}." << std::endl;
@@ -134 +148 @@
     bool Quest::addHint(QuestHint* hint)
     {
-        if(hint == NULL)
+        if(hint == NULL) //!< We don't want to set NULL-Pointers. Seriously!
         {
             COUT(2) << "A NULL-QuestHint was trying to be added." << std::endl;
@@ -140 +154 @@
         }
 
-        this->hints_.push_back(hint);
-        hint->setQuest(this);
+        hint->setQuest(this); //!< Sets the current quest (this) as quest for the added hint.
+        this->hints_.push_back(hint); //!< Adds the hint to the end of the list of hints.
 
         COUT(3) << "QuestHint {" << hint->getId() << "} was added to Quest {" << this->getId() << "}." << std::endl;
@@ -149 +163 @@
     /**
     @brief
-
+        Adds an effect to the list of failEffects.
+    @param effect
+        The QuestEffect to be added.
+    @return
+        Returns true if successful.
     */
     bool Quest::addFailEffect(QuestEffect* effect)
     {
-        if(effect == NULL)
+        if(effect == NULL) //!< We don't want to set NULL-Pointers.
         {
             COUT(2) << "A NULL-QuestEffect was trying to be added" << std::endl;
@@ -159 +177 @@
         }
 
-        this->failEffects_.push_back(effect);
+        this->failEffects_.push_back(effect); //!< Adds the effect to the end of the list of failEffects.
 
         COUT(3) << "A FailEffect was added to Quest {" << this->getId() << "}." << std::endl;
@@ -167 +185 @@
     /**
     @brief
-
+        Adds an effect to the list of completeEffects.
+    @param effect
+        The QuestEffect to be added.
+    @return
+        Returns true if successful.
     */
     bool Quest::addCompleteEffect(QuestEffect* effect)
     {
-        if(effect == NULL)
+        if(effect == NULL) //!< We don't want to set NULL-Pointers.
         {
             COUT(2) << "A NULL-QuestEffect was trying to be added" << std::endl;
@@ -177 +199 @@
         }
 
-        this->completeEffects_.push_back(effect);
+        this->completeEffects_.push_back(effect); //!< Adds the effect to the end of the list of completeEffects.
 
         COUT(3) << "A CompleteEffect was added to Quest {" << this->getId() << "}." << std::endl;
@@ -185 +207 @@
     /**
     @brief
-
+        Returns the parent quest of the quest.
+    @return
+        Returns the parent quest of the quest.
     */
     const Quest* Quest::getParentQuest(void)
@@ -194 +218 @@
     /**
     @brief
-
+        Returns the sub quest of the given index.
+    @param
+        The index.
+    @return
+        Returns the subquest of the given index. NULL if there is no element on the given index.
     */
     const Quest* Quest::getSubQuests(unsigned int index) const
     {
         int i = index;
+        
+        //! Iterate through all subquests.
         for (std::list<Quest*>::const_iterator subQuest = this->subQuests_.begin(); subQuest != this->subQuests_.end(); ++subQuest)
         {
-            if(i == 0)
+            if(i == 0) //!< We're counting down...
             {
                return *subQuest;
@@ -207 +237 @@
             i--;
         }
-        return NULL;
-    }
-
-    /**
-    @brief
-
+        
+        return NULL; //!< If the index is greater than the number of elements in the list.
+    }
+
+    /**
+    @brief
+        Returns the hint of the given index.
+    @param
+        The index.
+    @return
+        Returns the hint of the given index. NULL if there is no element on the given index.
     */
     const QuestHint* Quest::getHints(unsigned int index) const
     {
         int i = index;
+        
+        //! Iterate through all hints.
         for (std::list<QuestHint*>::const_iterator hint = this->hints_.begin(); hint != this->hints_.end(); ++hint)
         {
-            if(i == 0)
+            if(i == 0) //!< We're counting down...
             {
                return *hint;
@@ -225 +262 @@
             i--;
         }
-        return NULL;
-    }
-
-    /**
-    @brief
-
+        return NULL; //!< If the index is greater than the number of elements in the list.
+    }
+
+    /**
+    @brief
+        Returns the failEffect of the given index.
+    @param
+        The index.
+    @return
+        Returns the failEffect of the given index. NULL if there is no element on the given index.
     */
     const QuestEffect* Quest::getFailEffects(unsigned int index) const
     {
         int i = index;
+        
+        //! Iterate through all failEffects.
         for (std::list<QuestEffect*>::const_iterator effect = this->failEffects_.begin(); effect != this->failEffects_.end(); ++effect)
         {
-            if(i == 0)
+            if(i == 0) //!< We're counting down...
             {
                return *effect;
@@ -243 +286 @@
             i--;
         }
-        return NULL;
-    }
-
-    /**
-    @brief
-
+        return NULL; //!< If the index is greater than the number of elements in the list.
+    }
+
+    /**
+    @brief
+        Returns the completeEffect of the given index.
+    @param
+        The index.
+    @return
+        Returns the completeEffect of the given index. NULL if there is no element on the given index.
     */
     const QuestEffect* Quest::getCompleteEffects(unsigned int index) const
     {
         int i = index;
+        
+        //! Iterate through all completeEffects.
         for (std::list<QuestEffect*>::const_iterator effect = this->completeEffects_.begin(); effect != this->completeEffects_.end(); ++effect)
         {
-            if(i == 0)
+            if(i == 0) //!< We're counting down...
             {
                return *effect;
@@ -261 +310 @@
             i--;
         }
-        return NULL;
+        return NULL; //!< If the index is greater than the number of elements in the list.
     }
 
@@ -274 +323 @@
         Throws an exception if getStatus throws one.
     */
-    bool Quest::isInactive(const Player* player) const
+    bool Quest::isInactive(const ControllableEntity* player) const
     {
         return this->getStatus(player) == questStatus::inactive;
@@ -289 +338 @@
         Throws an exception if getStatus throws one.
     */
-    bool Quest::isActive(const Player* player) const
+    bool Quest::isActive(const ControllableEntity* player) const
     {
 
@@ -305 +354 @@
         Throws an exception if getStatus throws one.
     */
-    bool Quest::isFailed(const Player* player) const
+    bool Quest::isFailed(const ControllableEntity* player) const
     {
         return this->getStatus(player) == questStatus::failed;
@@ -320 +369 @@
         Throws an exception if getStatus throws one.
     */
-    bool Quest::isCompleted(const Player* player) const
+    bool Quest::isCompleted(const ControllableEntity* player) const
     {
         return this->getStatus(player) == questStatus::completed;
@@ -327 +376 @@
     /**
     @brief
-        Starts the quest.
+        Starts the quest for an input player.
     @param player
         The player.
@@ -333 +382 @@
         Returns true if the quest could be started, false if not.
     */
-    bool Quest::start(Player* player)
-    {
-        if(this->isStartable(player))
+    bool Quest::start(ControllableEntity* player)
+    {
+        if(this->isStartable(player)) //!< Checks whether the quest can be started.
         {
             this->setStatus(player, questStatus::active);
             return true;
         }
+        
         COUT(2) << "A non-startable quest was trying to be started." << std::endl;
         return false;
     }
 
-    /**
-    @brief
-        Fails the quest.
-    @param player
-        The player.
-    @return
-        Returns true if the quest could be failed, false if not.
-    */
-    bool Quest::fail(Player* player)
-    {
-        if(this->isFailable(player))
-        {
-            this->setStatus(player, questStatus::failed);
-            QuestEffect::invokeEffects(player, this->failEffects_);
-            return true;
-        }
-        COUT(2) << "A non-failable quest was trying to be failed." << std::endl;
-        return false;
-    }
-
-    /**
-    @brief
-        Completes the quest.
-    @param player
-        The player.
-    @return
-        Returns true if the quest could be completed, false if not.
-    */
-    bool Quest::complete(Player* player)
-    {
-        if(this->isCompletable(player))
-        {
-            this->setStatus(player, questStatus::completed);
-            QuestEffect::invokeEffects(player, this->completeEffects_);
-            return true;
-        }
-        COUT(2) << "A non-completable quest was trying to be completed." << std::endl;
-        return false;
-    }
-
 }