Changeset 9155 for code/branches/pickup2012/src/modules/pickup/items

Timestamp:

May 4, 2012, 3:56:56 PM (13 years ago)

Author:

lkevin

Message:

Changed pickup icon and xml for possible varieties of the pickup in the future.

Location:

code/branches/pickup2012/src/modules/pickup/items

Files:

• DamageBoostPickup.cc (modified) (6 diffs)
• DamageBoostPickup.h (modified) (4 diffs)
• SpeedPickup.h (modified) (1 diff)

code/branches/pickup2012/src/modules/pickup/items/DamageBoostPickup.cc

@@ -21 +21 @@
  *
  *   Author:
- *      Eric Beier
+ *      Kevin Lengauer
  *   Co-authors:
  *      ...
@@ -28 +28 @@
 
 /**
-    @file SpeedPickup.cc
-    @brief Implementation of the SpeedPickup class.
+    @file DamageBoostPickup.cc
+    @brief Implementation of the DamageBoostPickup class.
 */
 
@@ -71 +71 @@
     {
         this->duration_ = 0.0f;
-        this->damageMultiplier_ = 20.0f;
+        this->damageMultiplier_ = 1.0f; //The default damage multiplier.
         //Defines who is allowed to pick up the pickup.
         this->addTarget(ClassIdentifier<SpaceShip>::getIdentifier());
@@ -105 +105 @@
 
         XMLPortParam(DamageBoostPickup, "duration", setDuration, getDuration, xmlelement, mode);
-        XMLPortParam(DamageBoostPickup, "damageMultiplier", setDefaultDamageMultiplier, getDefaultDamageMultiplier, xmlelement, mode);
+        XMLPortParam(DamageBoostPickup, "damageMultiplier", setDamageMultiplier, getDamageMultiplier, xmlelement, mode);
 
         this->initializeIdentifier();
     }
+
+    // Work in Progress setDamage Function
+    void DamageBoostPickup::setDamageMultiplier(float damageMultiplier)
+    {
+        if(damageMultiplier >= 1.0f)
+        {
+            this->damageMultiplier_ = damageMultiplier;
+            orxout() << "Set Damage " << damageMultiplier << endl;
+        }
+    }
+
 
     /**
@@ -138 +149 @@
                 }
             }
-            // NOTE: commented this since its use was not apparent
-            // ship->getCreator();
-
+
+            // Saves the old default Damage that is needed to restore the original damage
             this->olddamageMultiplier_ = ship->getDamageMultiplier();
+            // Sets the new Damage with the damage multiplier.
             ship->setDamageMultiplier( this->damageMultiplier_ );
         }
@@ -214 +225 @@
         else
         {
-            orxout(internal_error, context::pickups) << "Invalid duration in SpeedPickup." << endl;
+            orxout(internal_error, context::pickups) << "Invalid duration in DamagePickup." << endl;
             this->duration_ = 0.0f;
         }
     }
 
-   /* void DamageBoostPickup::setDamageBoost(float damageBoost)
-       {
-
-       }
-    void DamageBoostPickup::setDamageSave(float damageSave)
-    {
-
-    }
-    */
-
+    /**
+    @brief
+        Helper method. Is called by the Timer as soon as it expires.
+    */
     void DamageBoostPickup::pickupTimerCallback(void)
     {

code/branches/pickup2012/src/modules/pickup/items/DamageBoostPickup.h

@@ -21 +21 @@
  *
  *   Author:
- *      Damian 'Mozork' Frick
+ *      Kevin Lengauer
  *   Co-authors:
  *      ...
@@ -53 +53 @@
 
             virtual void XMLPort(Element& xmlelement, orxonox::XMLPort::Mode mode); //!< Method for creating a DamageBoostPickup object through XML.
-            // commented out cuz was not used
-            // virtual void tick(float dt); //!< Is called every tick.
 
             virtual void changedUsed(void); //!< Is called when the pickup has transited from used to unused or the other way around.
             virtual void clone(OrxonoxClass*& item); //!< Creates a duplicate of the input OrxonoxClass.
-
-            /**
-            @brief Get the damageboost that is transferred to the Pawn upon usage of this pickup.
-            @return Returns the damageboost.
-            */
-            // Commentend, may not be used
-            // inline float setDamageMultiplier(void) const
-            //    { ship->setMultiplier(); }
-
 
             /**
@@ -77 +66 @@
 
 
-            // we need these methods to set the default damage multiplier from XML
-            // not that beautiful yet
-            inline void setDefaultDamageMultiplier(float multiplier)
-                { this->damageMultiplier_ = multiplier; }
-            inline float getDefaultDamageMultiplier()
+
+            /**
+             @brief set Damage multiplier
+             @param multiplier The default damage multiplier to set
+             */
+            inline float getDamageMultiplier()
                 { return this->damageMultiplier_; }
 
@@ -89 +79 @@
         protected:
             void initializeIdentifier(void); //!< Initializes the PickupIdentifier of this pickup.
+            void setDamageMultiplier(float damageMultiplier);
 
-            // void setDamageBoost(float damageBoost);//!< Sets the damage boost.
-            // void setDamageSave(float damageSave); //!< Saves the original damage.
 
         private:
             void initialize(void); //!< Initializes the member variables.
             Pawn* carrierToPawnHelper(void); //!< Helper to transform the PickupCarrier to a Pawn, and throw an error message if the conversion fails.
-            SpaceShip* carrierToSpaceShipHelper(void);
+            SpaceShip* carrierToSpaceShipHelper(void); //!< Helper to transform the PickupCarrier to a SpaceShip, and throw an error message if the conversion fails.
             void pickupTimerCallback(void);
 

code/branches/pickup2012/src/modules/pickup/items/SpeedPickup.h

@@ -112 +112 @@
         private:
             void initialize(void); //!< Initializes the member variables.
-            SpaceShip* carrierToSpaceShipHelper(void); //!< Helper to transform the PickupCarrier to a SpaceSHip, and throw an error message if the conversion fails.
+            SpaceShip* carrierToSpaceShipHelper(void); //!< Helper to transform the PickupCarrier to a SpaceShip, and throw an error message if the conversion fails.
 
             Timer durationTimer_; //!< Timer.