Changeset 10594 for code/branches/towerdefenseFabien/src/modules/weapons/projectiles/SplitGunProjectile.cc

Timestamp:

Sep 25, 2015, 1:56:51 PM (9 years ago)

Author:

fvultier

Message:

improved documentation

File:

• code/branches/towerdefenseFabien/src/modules/weapons/projectiles/SplitGunProjectile.cc (modified) (5 diffs)

code/branches/towerdefenseFabien/src/modules/weapons/projectiles/SplitGunProjectile.cc

@@ -21 +21 @@
  *
  *   Author:
- *      Joel Smely
+ *      Fabien Vultier
  *   Co-authors:
  *      ...
@@ -77 +77 @@
     }
 
+    /**
+    @brief
+        This function starts a timer that will cause the projectile to split after a time defined by the argument @param splitTime.        
+    */
     void SplitGunProjectile::setSplitTime(float splitTime)
     {
@@ -95 +99 @@
     }
 
+    /**
+    @brief
+        If this function is called the projectile splits up into many child projectiles. The original projectiles does not get destroyed but it will never split up again.
+    */
     void SplitGunProjectile::split()
     {
@@ -100 +108 @@
         {
             -- numberOfSplits_;
+
+            // Reduce damage of this projectile by the number of childs plus one. This way the total amount of possible damage contained in the original projectile and its childs is unchanged after s aplit.
+            this->setDamage(this->getDamage()/(numberOfChilds_+1));
 
             // Calculate a normalized vector (velocityOffset) that is perpendicluar to the velocity of this projectile. Since there are infinitly many perpendicular vectors a random one is chosen.
@@ -131 +142 @@
                 projectile->setDamage(this->getDamage());
                 projectile->setShieldDamage(this->getShieldDamage());
-                projectile->setHealthDamage(this->getHealthDamage());                
+                projectile->setHealthDamage(this->getHealthDamage());
             }