Changeset 7540 for code/trunk/src/modules/pickup/PickupRepresentation.cc

Timestamp:

Oct 14, 2010, 11:20:16 AM (14 years ago)

Author:

dafrick

Message:

Some more documenting.

File:

• code/trunk/src/modules/pickup/PickupRepresentation.cc (modified) (7 diffs)

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

@@ -36 +36 @@
 #include "core/CoreIncludes.h"
 #include "core/GameMode.h"
+#include "util/StringUtils.h"
+
 #include "graphics/Billboard.h"
-#include "util/StringUtils.h"
+
 #include "PickupManager.h"
 
@@ -55 +57 @@
 
         this->initialize();
-        this->setSyncMode(0x0);
+        this->setSyncMode(0x0); // The default PickupRperesentation created by each PickupManager is not synchronised, since it only exists locally.
     }
 
@@ -69 +71 @@
         this->registerVariables();
 
-        PickupManager::getInstance().registerRepresentation(this); //!< Registers the PickupRepresentation with the PickupManager.
+        PickupManager::getInstance().registerRepresentation(this); // Registers the PickupRepresentation with the PickupManager.
     }
 
@@ -107 +109 @@
     }
 
+    /**
+    @brief
+        Registers the variables that need to be synchornised.
+    */
     void PickupRepresentation::registerVariables(void)
     {
@@ -131 +137 @@
         if(GameMode::isMaster())
         {
-            PickupManager::getInstance().registerRepresentation(this->pickup_->getPickupIdentifier(), this); //!< Registers the PickupRepresentation with the PickupManager through the PickupIdentifier of the Pickupable it represents.
+            // Registers the PickupRepresentation with the PickupManager through the PickupIdentifier of the Pickupable it represents.
+            PickupManager::getInstance().registerRepresentation(this->pickup_->getPickupIdentifier(), this);
         }
 
@@ -156 +163 @@
             {
                 COUT(4) << "PickupRepresentation: Spawner template is empty." << std::endl;
-                //!< If neither spawnerRepresentation nor spawnerTemplate was specified
+                // If neither spawnerRepresentation nor spawnerTemplate was specified
                 return this->getDefaultSpawnerRepresentation(spawner);
             }
@@ -180 +187 @@
         Returns a pointer to the StaticEntity.
     */
-    //TODO: Possibility to define default representation through XML.
+    //TODO: Possibility to define default representation through XML?
     StaticEntity* PickupRepresentation::getDefaultSpawnerRepresentation(PickupSpawner* spawner)
     {