Changeset 7494 for code/trunk/src/modules/pickup/Pickup.cc

Timestamp:

Sep 28, 2010, 5:31:59 PM (14 years ago)

Author:

dafrick

Message:

Some documenting and cleaning up/re-organization in pickups module.

File:

• code/trunk/src/modules/pickup/Pickup.cc (modified) (6 diffs)

code/trunk/src/modules/pickup/Pickup.cc

@@ -36 +36 @@
 #include "core/CoreIncludes.h"
 #include "util/StringUtils.h"
+
 #include "pickup/PickupIdentifier.h"
+
 #include "DroppedPickup.h"
-
-#include "tools/Timer.h"
 
 namespace orxonox
@@ -51 +51 @@
     CreateUnloadableFactory(Pickup);
 
+    /**
+    @brief
+        Constructor. Registers and initializes the object.
+    @param creator
+        The objects creator.
+    */
     Pickup::Pickup(BaseObject* creator) : BaseObject(creator)
     {
@@ -58 +64 @@
     }
 
+    /**
+    @brief
+        Destructor.
+    */
     Pickup::~Pickup()
     {
@@ -158 +168 @@
         else
         {
-            COUT(1) << "Invalid activationType in pickup." << std::endl;
+            COUT(1) << "Invalid activationType '" << type << "' in pickup." << std::endl;
         }
     }
@@ -180 +190 @@
         else
         {
-            COUT(1) << "Invalid durationType in pickup." << std::endl;
+            COUT(1) << "Invalid durationType '" << type << "' in pickup." << std::endl;
         }
     }
@@ -193 +203 @@
         SUPER(Pickup, changedPickedUp);
 
-        //! Sets the Pickup to used if the Pickup has activation type 'immediate' and gets picked up.
+        // Sets the Pickup to used if the Pickup has activation type 'immediate' and gets picked up.
         if(this->isPickedUp() && this->isImmediate())
-        {
             this->setUsed(true);
-        }
-    }
-
-    /**
-    @brief
-        Creates a duplicate of the Pickup.
-    @return
-        Returns the clone of this pickup as a pointer to a Pickupable.
+    }
+
+    /**
+    @brief
+        Creates a duplicate of the OrxonoxClass.
+    @param item
+        A reference to the pointer of the item that we're duplicating.
     */
     void Pickup::clone(OrxonoxClass*& item)