Changeset 6421 for code/branches/pickup3/src/modules/pickup/PickupSpawner.cc

Timestamp:

Dec 26, 2009, 10:06:54 AM (14 years ago)

Author:

dafrick

Message:

Some Documenting and bug fixes.

File:

• code/branches/pickup3/src/modules/pickup/PickupSpawner.cc (modified) (10 diffs)

code/branches/pickup3/src/modules/pickup/PickupSpawner.cc

@@ -53 +53 @@
     /**
     @brief
-        Constructor. Registers the PickupSpawner.
+        Constructor. Creates a blank PickupSpawner.
     @param creator
         Pointer to the object which created this item.
@@ -62 +62 @@
     }
 
+    /**
+    @brief
+        Constructor, Creates a fully functional PickupSpawner.
+    @param creator
+        The creator of this PickupSpawner.
+    @param pickup
+        The Pickupable to be spawned by this PickupSpawner.
+    @param triggerDistance
+        The distance at which the PickupSpawner will trigger.
+    @param respawnTime
+        The minimum time between two spawns.
+    @param maySpawnedItems
+        The maximum number of items spawned by this PickupSpawner.
+    */
     PickupSpawner::PickupSpawner(BaseObject* creator, Pickupable* pickup, float triggerDistance, float respawnTime, int maxSpawnedItems) : StaticEntity(creator)
     {
@@ -73 +87 @@
     }
 
+    /**
+    @brief
+        Registers the object and sets some default values.
+    */
     void PickupSpawner::initialize(void)
     {
@@ -92 +110 @@
     PickupSpawner::~PickupSpawner()
     {
-        
+        if(this->pickup_ != NULL)
+            delete this->pickup_;
     }
 
@@ -107 +126 @@
         SUPER(PickupSpawner, XMLPort, xmlelement, mode);
 
-        XMLPortObject(PickupSpawner, Pickupable, "pickup", addPickupable, getPickupable, xmlelement, mode);
+        XMLPortObject(PickupSpawner, Pickupable, "pickup", setPickupable, getPickupable, xmlelement, mode);
         
         XMLPortParam(PickupSpawner, "triggerDistance", setTriggerDistance, getTriggerDistance, xmlelement, mode);
@@ -128 +147 @@
         //  & load the GUI itself too, along with some empty windows
         //   = even less delays
-//         GUIManager::showGUI("PickupInventory");
-//         GUIManager::hideGUI("PickupInventory");
+//         GUIManager::getInstance().showGUI("PickupInventory");
+//         GUIManager::getInstance().executeCode("hideGUI(\"PickupInventory\")");
 //         PickupInventory::getSingleton();
     }
     
-    void PickupSpawner::addPickupable(Pickupable* pickup)
+    /**
+    @brief
+        Sets a Pickupable for the PickupSpawner to spawn.
+    @param pickup
+        The Pickupable to be set.
+    */
+    void PickupSpawner::setPickupable(Pickupable* pickup)
     {
         if(this->pickup_ != NULL)
@@ -149 +174 @@
     }
     
-    Pickupable* PickupSpawner::getPickupable(void)
+    /**
+    @brief
+        Get the Pickupable that is spawned by this PickupSpawner.
+    @return
+        Returns the Pickupable that is spawned by this PickupSpawner.
+    */
+    const Pickupable* PickupSpawner::getPickupable(void)
     {
         return this->pickup_;
@@ -166 +197 @@
 //     }
 
+    /**
+    @brief
+        Sets the maximum number of spawned items.
+    @param items
+        The maximum number of spawned items to be set.
+    */
     void PickupSpawner::setMaxSpawnedItems(int items)
     {
@@ -243 +280 @@
     }
     
+    /**
+    @brief
+        Decrements the number of remaining spawns.
+        Sets the PickupSpawner to inactive for the duration of the respawnTime.
+        Destroys the PickupSpawner if the number of remaining spawns has reached zero.
+        
+    */
     void PickupSpawner::decrementSpawnsRemaining(void)
     {
@@ -251 +295 @@
         if(this->spawnsRemaining_ != 0 && this->respawnTime_ > 0)
         {
-            //TODO: Nicer?
+            //TODO: Nicer? Does this even work?
             this->respawnTimer_.setTimer(this->respawnTime_, false, createExecutor(createFunctor(&PickupSpawner::respawnTimerCallback, this)));