Changeset 10608 for code/branches/towerdefenseFabien/src/modules/weapons/IceGunFreezer.cc

Timestamp:

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

Author:

fvultier

Message:

Improved documentation

File:

• code/branches/towerdefenseFabien/src/modules/weapons/IceGunFreezer.cc (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()
     {