Changeset 2068 for code/branches/questsystem/src/orxonox/objects/LocalQuest.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/LocalQuest.cc (modified) (9 diffs)

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

@@ -28 +28 @@
 
 #include "core/CoreIncludes.h"
+#include "util/Exception.h"
 
 #include "LocalQuest.h"
@@ -37 +38 @@
     LocalQuest::LocalQuest() : Quest()
     {
-        
+        this->initialize();
     }
 
@@ -45 +46 @@
     @param id
         The unique identifier.
-    @param title
-        The title of the quest.
-    @param description
-        The description of the quest.
     */
-    LocalQuest::LocalQuest(std::string id, std::string title, std::string description) : Quest(id, title, description)
+    LocalQuest::LocalQuest(std::string id) : Quest(id)
     {
-        RegisterObject(LocalQuest);
+        this->initialize();
     }
     
@@ -64 +61 @@
     }
     
+    void LocalQuest::initialize(void)
+    {
+        RegisterObject(LocalQuest);
+    }
+    
     /**
     @brief
@@ -71 +73 @@
     @return
         Returns true if the quest can be started, false if not.
+    @throws
+        Throws an exception if isInactive(Player*) throws one.
     */
     bool LocalQuest::isStartable(const Player* player) const
@@ -84 +88 @@
     @return
         Returns true if the quest can be failed, false if not.
+    @throws
+        Throws an exception if isActive(Player*) throws one.
     */
     bool LocalQuest::isFailable(const Player* player) const
@@ -97 +103 @@
     @return
         Returns true if the quest can be completed, false if not.
+    @throws
+        Throws an exception if isInactive(Player*) throws one.
     */
     bool LocalQuest::isCompletable(const Player* player) const
@@ -110 +118 @@
     @return
         Returns the status of the quest for the input player.
+    @throws
+        Throws an Exception if player is NULL.
     */
     questStatus::Enum LocalQuest::getStatus(const Player* player) const
     {
+        if(player == NULL)
+        {
+            ThrowException(Argument, "The input Player* is NULL.");
+        }
+        
         std::map<Player*, questStatus::Enum>::const_iterator it = this->playerStatus_.find((Player*)(void*)player); //Thx. to x3n for the (Player*)(void*) 'hack'.
         if (it != this->playerStatus_.end())
@@ -124 +139 @@
     @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.
+    @return
+        Returns false if player is NULL.
     */
     bool LocalQuest::setStatus(Player* player, const questStatus::Enum & status)
     {
+        if(player == NULL)
+        {
+            return false;
+        }
         this->playerStatus_[player] = status;
         return true;