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

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.h (modified) (4 diffs)

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

@@ -57 +57 @@
             virtual ~PickupSpawner();
 
-            virtual void changedActivity();                                 //!< Invoked when activity has changed (set visibilty).
+            //virtual void changedActivity();                                 //!< Invoked when activity has changed (set visibilty).
             virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);  //!< Method for creating a PickupSpawner through XML.
             virtual void tick(float dt);
@@ -87 +87 @@
                 { this->respawnTime_ = time; }
 
-
+            /**
+                @brief Get the maximum number of items that will be spawned by this PickupSpawner.
+                @return Returns the maximum number of items spawned by this PickupSpawner.
+            */
             inline int getMaxSpawnedItems(void)
                 { return this->maxSpawnedItems_; }
@@ -95 +98 @@
             virtual Pickupable* getPickup(void);
             
-            void addPickupable(Pickupable* pickup);
-            Pickupable* getPickupable(void);
+            void setPickupable(Pickupable* pickup);
+            const Pickupable* getPickupable(void);
             
             void decrementSpawnsRemaining(void);
+            
+            Pickupable* pickup_; //!< The pickup to be spawned.
 
         private:
@@ -105 +110 @@
             void trigger(Pawn* pawn);                                       //!< Method called when a Pawn is close enough.
             void respawnTimerCallback();                                    //!< Method called when the timer runs out.
-
-            
-            Pickupable* pickup_;
 
             int maxSpawnedItems_;                   //!< Maximum number of items spawned by this PickupSpawner.