Changeset 10594 for code/branches/towerdefenseFabien/src/modules/weapons/weaponmodes

Timestamp:

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

Author:

fvultier

Message:

improved documentation

Location:

code/branches/towerdefenseFabien/src/modules/weapons/weaponmodes

Files:

• SplitGun.cc (modified) (3 diffs)
• SplitGun.h (modified) (3 diffs)

code/branches/towerdefenseFabien/src/modules/weapons/weaponmodes/SplitGun.cc

@@ -21 +21 @@
  *
  *   Author:
- *      Joel Smely
+ *      Fabien Vultier
  *   Co-authors:
- *      simonmie
+ *      ...
  *
  */
@@ -69 +69 @@
     /**
     @brief
-        XMLPort for the SplitGun. You can define how often the projectiles split, how many childs should be created per split and the time between two splits.
+        XMLPort for the SplitGun. You can define how often the projectiles split, how many childs should be created per split, the spread and the time between two splits.
     */
     void SplitGun::XMLPort(Element& xmlelement, XMLPort::Mode mode)
@@ -95 +95 @@
         projectile->setVelocity(this->getMuzzleDirection() * this->speed_);
 
+        // Pass important information to the projectile: Number of splits, Number of childs, split time, spread
         projectile->setNumberOfSplits(getNumberOfSplits());
         projectile->setNumberOfChilds(getNumberOfChilds());

code/branches/towerdefenseFabien/src/modules/weapons/weaponmodes/SplitGun.h

@@ -21 +21 @@
  *
  *   Author:
- *      Joel Smely
+ *      Fabien Vultier
  *   Co-authors:
  *      ...
@@ -45 +45 @@
         A slow ball of lightning.
     @author
-        Joel Smely
+        Fabien Vultier
     @ingroup WeaponsWeaponModes
     */
@@ -75 +75 @@
 
        private:
-            float speed_; //!< The speed of the fired projectile.
-            int numberOfSplits_;
-            int numberOfChilds_;
-            float splitTime_;
-            float spread_;
+            float speed_; //The speed of the fired projectile.
+            int numberOfSplits_; //The number of times the projectile will split into child projectiles
+            int numberOfChilds_; //The number of child projectiles that are created if the projectile splits
+            float splitTime_; //The time between creation of the projectile and the split of the projectile
+            float spread_; //Low spread means that the child projectiles are concentrated in a small area
     };
 }