Changeset 2068 for code/branches/questsystem/src/orxonox/objects/GlobalQuest.cc

Timestamp:

Oct 30, 2008, 9:52:12 AM (16 years ago)

Author:

dafrick

Message:

Started with XMLPort…

File:

• code/branches/questsystem/src/orxonox/objects/GlobalQuest.cc (modified) (9 diffs)

code/branches/questsystem/src/orxonox/objects/GlobalQuest.cc

@@ -28 +28 @@
 
 #include "core/CoreIncludes.h"
+#include "util/Exception.h"
 
 #include "GlobalQuest.h"
@@ -35 +36 @@
     CreateFactory(GlobalQuest);
 
+    /**
+    @brief
+        Constructor.
+    */
     GlobalQuest::GlobalQuest() : Quest()
     {
-        
+        this->initialize();
     }
 
@@ -50 +55 @@
         The description of the quest.
     */
-    GlobalQuest::GlobalQuest(std::string id, std::string title, std::string description) : Quest(id, title, description)
+    GlobalQuest::GlobalQuest(std::string id) : Quest(id)
     {
-        RegisterObject(GlobalQuest);
+        this->initialize();
     }
     
@@ -64 +69 @@
     }
     
+    void GlobalQuest::initialize(void)
+    {
+        RegisterObject(GlobalQuest);
+    }
+    
     /**
     @brief
@@ -71 +81 @@
     @return
         Returns true if the quest can be started, false if not.
+    @throws
+        Throws an exception if either isInactive() of isActive() throws one.
     */
     bool GlobalQuest::isStartable(const Player* player) const
     {
-        return this->isInactive(player) || this->isActive(player);
+        return this->isInactive(player) ||  this->isActive(player);
     }
     
@@ -84 +96 @@
     @return
         Returns true if the quest can be failed, false if not.
+    @throws
+        Throws an Exception if isActive() throws one.
     */
     bool GlobalQuest::isFailable(const Player* player) const
     {
         return this->isActive(player);
+
     }
     
@@ -97 +112 @@
     @return
         Returns true if the quest can be completed, false if not.
+    @throws
+        Throws an Exception if isActive() throws one.
     */
     bool GlobalQuest::isCompletable(const Player* player) const
@@ -108 +125 @@
     @param player
         The player.
+    @throws
+        Throws an Exception if player is NULL.
     */
     questStatus::Enum GlobalQuest::getStatus(const Player* player) const
     {
+        if(player == NULL)
+        {
+            ThrowException(Argument, "The input Player* is NULL.");
+        }
+        
         //TDO: Does this really work???
         std::set<Player*>::const_iterator it = this->players_.find((Player*)(void*)player);
@@ -127 +151 @@
     @brief
         Sets the status for a specific player.
+        But be careful wit this one, the status will just be set without checking for its validity. You have to know what you're doing.
     @param player
         The player.
     @param status
         The status to be set.
+    @return
+        Returns false if player is NULL.
     */
     bool GlobalQuest::setStatus(Player* player, const questStatus::Enum & status)
     {
+        if(player == NULL)
+        {
+            return false;
+        }
+        
         std::set<Player*>::const_iterator it = this->players_.find(player);
         if (it == this->players_.end()) //!< Player is not yet in the list.