Changeset 7552 for code/trunk/src/modules/questsystem/effects

Timestamp:

Oct 17, 2010, 10:50:43 PM (14 years ago)

Author:

dafrick

Message:

Resolving some TODOs and doing some additional cleanup. Almost done now…

Location:

code/trunk/src/modules/questsystem/effects

Files:

• AddQuest.cc (modified) (1 diff)
• AddQuest.h (modified) (2 diffs)
• AddQuestHint.cc (modified) (1 diff)
• AddQuestHint.h (modified) (2 diffs)
• AddReward.h (modified) (2 diffs)
• ChangeQuestStatus.h (modified) (1 diff)
• CompleteQuest.cc (modified) (1 diff)
• CompleteQuest.h (modified) (2 diffs)
• FailQuest.cc (modified) (1 diff)
• FailQuest.h (modified) (2 diffs)

code/trunk/src/modules/questsystem/effects/AddQuest.cc

@@ -83 +83 @@
     bool AddQuest::invoke(PlayerInfo* player)
     {
-        //TODO: Replace with assert?
-        if(player == NULL) // Null-pointers are badass.
-        {
-            COUT(2) << "Input player is NULL." << std::endl;
-            return false;
-        }
+        assert(player);
 
         COUT(5) << "AddQuest on player: " << player << " ." << std::endl;

code/trunk/src/modules/questsystem/effects/AddQuest.h

@@ -41 +41 @@
 namespace orxonox
 {
+
     /**
     @brief
@@ -49 +50 @@
         <AddQuest questId="id" />  //Where id identifies the Quest that should be added.
         @endcode
+
     @author
         Damian 'Mozork' Frick
+
+    @ingroup QuestEffects
     */
     class _QuestsystemExport AddQuest : public ChangeQuestStatus

code/trunk/src/modules/questsystem/effects/AddQuestHint.cc

@@ -106 +106 @@
     bool AddQuestHint::invoke(PlayerInfo* player)
     {
-        //TODO: Replace with assert?
-        if(player == NULL) // NULL-pointers are evil!
-        {
-            COUT(2) << "The input player is NULL." << std::endl;
-            return false;
-        }
+        assert(player);
 
         COUT(5) << "AddQuestHint on player: " << player << " ." << std::endl;

code/trunk/src/modules/questsystem/effects/AddQuestHint.h

@@ -43 +43 @@
 namespace orxonox
 {
+
     /**
     @brief
@@ -51 +52 @@
         <AddQuestHint hintId="id" />  //Where id identifies the QuestHint that should be added.
         @endcode
+
     @author
         Damian 'Mozork' Frick
+
+    @ingroup QuestEffects
     */
     class _QuestsystemExport AddQuestHint : public QuestEffect

code/trunk/src/modules/questsystem/effects/AddReward.h

@@ -43 +43 @@
 namespace orxonox
 {
+    
     /**
     @brief
@@ -55 +56 @@
         </AddReward>
         @endcode
+
     @author
         Damian 'Mozork' Frick
+
+    @ingroup QuestEffects
     */
     class _QuestsystemExport AddReward : public QuestEffect

code/trunk/src/modules/questsystem/effects/ChangeQuestStatus.h

@@ -43 +43 @@
 namespace orxonox
 {
+
     /**
     @brief
         A QuestEffect which changes the status of a specified @ref orxonox::Quest "Quest" for the player invoking the QuestEffect.
+
     @author
         Damian 'Mozork' Frick
+
+    @ingroup QuestEffects
     */
     class _QuestsystemExport ChangeQuestStatus : public QuestEffect

code/trunk/src/modules/questsystem/effects/CompleteQuest.cc

@@ -83 +83 @@
     bool CompleteQuest::invoke(PlayerInfo* player)
     {
-        //TODO: Replace with assert?
-        if(player == NULL) // You know, what we think of NULL-pointers...
-        {
-            COUT(2) << "Input player is NULL." << std::endl;
-            return false;
-        }
+        assert(player);
 
         COUT(5) << "CompleteQuest on player: " << player << " ." << std::endl;

code/trunk/src/modules/questsystem/effects/CompleteQuest.h

@@ -41 +41 @@
 namespace orxonox
 {
+
     /**
     @brief
@@ -49 +50 @@
         <CompleteQuest questId="id" />  //Where id identifies the Quest that should be completed.
         @endcode
+
     @author
         Damian 'Mozork' Frick
+
+    @ingroup QuestEffects
     */
     class _QuestsystemExport CompleteQuest : public ChangeQuestStatus

code/trunk/src/modules/questsystem/effects/FailQuest.cc

@@ -83 +83 @@
     bool FailQuest::invoke(PlayerInfo* player)
     {
-        //TODO: Replace with assert?
-        if(player == NULL) // We don't know what to do with no player.
-        {
-            COUT(2) << "Input player is NULL." << std::endl;
-            return false;
-        }
+        assert(player);
 
         COUT(4) << "FailQuest on player: " << player << " ." << std::endl;

code/trunk/src/modules/questsystem/effects/FailQuest.h

@@ -41 +41 @@
 namespace orxonox
 {
+
     /**
     @brief
@@ -49 +50 @@
         <FailQuest questId="id" />  //Where id identifies the Quest that should be failed.
         @endcode
+
     @author
         Damian 'Mozork' Frick
+
+    @ingroup QuestEffects
     */
     class _QuestsystemExport FailQuest : public ChangeQuestStatus