Changeset 10608

Timestamp:

Oct 2, 2015, 11:03:31 PM (9 years ago)

Author:

fvultier

Message:

Improved documentation

Location:

code/branches/towerdefenseFabien/src/modules/weapons

Files:

• IceGunFreezer.cc (modified) (2 diffs)
• IceGunFreezer.h (modified) (1 diff)
• projectiles/IceGunProjectile.cc (modified) (2 diffs)
• projectiles/IceGunProjectile.h (modified) (1 diff)
• weaponmodes/IceGun.cc (modified) (1 diff)
• weaponmodes/IceGun.h (modified) (2 diffs)

code/branches/towerdefenseFabien/src/modules/weapons/IceGunFreezer.cc

@@ -92 +92 @@
     }    
 
+    /**
+    @brief
+        Try to slow down the WorldEntity where this is attached to. It is only possible to slow down a SpaceShip.
+    */
     void IceGunFreezer::startFreezing()
     {
         WorldEntity* parent = this->getParent();
 
+        // Check if the freezer is attached to a parent and check if the parent is a SpaceShip
         if (parent != NULL && parent->isA(Class(SpaceShip)))
         {
             freezedSpaceShip_ = orxonox_cast<SpaceShip*>(parent);
+            //Slow down the SpaceShip
             freezedSpaceShip_->addSpeedFactor(freezeFactor_);
         }
@@ -106 +112 @@
     }
 
+    /**
+    @brief
+        This method is called by the timer. It gives back the original engine strength to the hit SpaceShip.
+    */
     void IceGunFreezer::stopFreezing()
     {

code/branches/towerdefenseFabien/src/modules/weapons/IceGunFreezer.h

@@ -47 +47 @@
     /**
     @brief
-        blablabla
+        This is the WorldEntity that gets attached to a victim hit by a IceGunProjectile. It slows down the hit SpaceShip by a defined amount and time.
     @ingroup Weapons
     */

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

@@ -76 +76 @@
 
     bool IceGunProjectile::collidesAgainst(WorldEntity* otherObject, const btCollisionShape* cs, btManifoldPoint& contactPoint)
-    {
+    {        
         bool bCollision = Projectile::collidesAgainst(otherObject, cs, contactPoint);
 
         if (bCollision)
         {
+            // If there was a collision, attach a IceGunFreezer to the hit object.
             IceGunFreezer* freezer = new IceGunFreezer(this->getContext());
             freezer->setFreezeTime(freezeTime_);
@@ -89 +90 @@
             freezer->setPosition(Vector3(0,0,0));
             freezer->translate(offset, WorldEntity::World);
+            // Start the freezing effect.
             freezer->startFreezing();
         }

code/branches/towerdefenseFabien/src/modules/weapons/projectiles/IceGunProjectile.h

@@ -47 +47 @@
     /**
     @brief
-        The IceGunProjectile is a projectile that may split up into many child projectiles.
+        The IceGunProjectile is a projectile that attaches a IceGunFreezer to the hit object. This object gets slowed down by the IceGunFreezer.
     @author
         Fabien Vultier

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

@@ -51 +51 @@
         RegisterObject(IceGun);
 
+        // Default values
         this->reloadTime_ = 1.0f;
         this->damage_ = 0.0f;
         this->speed_ = 750.0f;
-
 
         this->setFreezeTime(3.0);

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

@@ -43 +43 @@
     /**
     @brief
-        A slow ball of lightning.
+        A Gun that fires ice arrows that slow down any SpaceShip object that gets hit.
     @author
         Fabien Vultier
@@ -56 +56 @@
             virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
             virtual void fire();
-
             
             inline void setFreezeTime(float freezeTime)