📝 Added & changed some comments (#70)

* 📝 Added some comments * ✨ Added a comment in heal unit
HelanaNady · May 16, 2024 · 255544d · 255544d
1 parent 46c460e
commit 255544d
Show file tree

Hide file tree

Showing 11 changed files with 19 additions and 18 deletions.
diff --git a/ArmyClasses/AlienArmy.cpp b/ArmyClasses/AlienArmy.cpp
@@ -27,7 +27,7 @@ void AlienArmy::addUnit(Unit* unit)
             else
                 drones.enqueueFront(unit);
 
-            dronesAddingToggler = !dronesAddingToggler;
+            dronesAddingToggler = !dronesAddingToggler; // Toggle the adding toggler to add the drones in a once front, once back order
             break;
     }
 }
@@ -44,7 +44,7 @@ Unit* AlienArmy::removeUnit(UnitType unitType)
 
         case UnitType::AM:
             if (!monsters.isEmpty())
-                monsters.remove((rand() % monsters.getCount()), unit);
+                monsters.remove((rand() % monsters.getCount()), unit); // Remove a random monster
             break;
 
         case UnitType::AD:
@@ -53,7 +53,7 @@ Unit* AlienArmy::removeUnit(UnitType unitType)
             else
                 drones.dequeueBack(unit);
 
-            dronesRemovingToggler = !dronesRemovingToggler;
+            dronesRemovingToggler = !dronesRemovingToggler; // Toggle the removing toggler to remove the drones in a once front, once back order
             break;
     }
 
@@ -81,7 +81,7 @@ Unit* AlienArmy::pickAttacker(UnitType unitType)
             else
                 drones.peekBack(unit);
 
-            dronesPickingToggler = !dronesPickingToggler;
+            dronesPickingToggler = !dronesPickingToggler; // Toggle the picking toggler to pick the drones in a once front, once back order
             break;
     }
 

diff --git a/ArmyClasses/EarthArmy.cpp b/ArmyClasses/EarthArmy.cpp
@@ -22,7 +22,7 @@ void EarthArmy::addUnit(Unit* unit)
     {
         case UnitType::ES:
             soldiers.enqueue(unit);
-            if (dynamic_cast<EarthSoldier*>(unit)->isInfected())
+            if (dynamic_cast<EarthSoldier*>(unit)->isInfected()) // If the soldier is infected, increment the infected count
                 infectedSoldiersCount++;
             break;
 
@@ -48,7 +48,7 @@ Unit* EarthArmy::removeUnit(UnitType unitType)
     {
         case UnitType::ES:
             soldiers.dequeue(unit);
-            if (unit && dynamic_cast<EarthSoldier*>(unit)->isInfected())
+            if (unit && dynamic_cast<EarthSoldier*>(unit)->isInfected()) // If the soldier is infected, decrement the infected count
                 infectedSoldiersCount--;
             break;
 

diff --git a/RandomGenerator/RandomGenerator.h b/RandomGenerator/RandomGenerator.h
@@ -43,8 +43,8 @@ class RandomGenerator
 	int getRandomNumber(int, int) const; // Generate a random number between the given range
 
 	// Setters
-	void setN(int);
-	void setProb(int);
+	void setN(int); // Set the number of units to generate
+	void setProb(int); // Set the probability of generating a unit
 
 	void setEarthParameters(int, int, int, int, Range, Range, Range); // Sets earth parameters loaded by game class
 	void setAlienParameters(int, int, int, Range, Range, Range); // Sets alien parameters loaded by game class

diff --git a/UnitClasses/AlienDrone.cpp b/UnitClasses/AlienDrone.cpp
@@ -49,7 +49,7 @@ bool AlienDrone::attack()
         // Store the IDs of the fought units to be printed later
         foughtUnits.enqueue(enemyUnit->getId());
 
-        // Nullify the pointer to avoid duplication
+        // Nullify the pointer
         enemyUnit = nullptr;
 
         // If this line is reached, at least one unit was attacked

diff --git a/UnitClasses/AlienMonster.cpp b/UnitClasses/AlienMonster.cpp
@@ -49,8 +49,8 @@ bool AlienMonster::attack()
         int x = rand() % 100 + 1;
         if (enemyUnit->getUnitType() == UnitType::ES && x <= infectingProbability)
         {
-            dynamic_cast<EarthSoldier*>(enemyUnit)->getInfection();
-            gamePtr->addUnit(enemyUnit);
+            dynamic_cast<EarthSoldier*>(enemyUnit)->getInfection(); // The soldier will get infected if not infected already and not immune
+            gamePtr->addUnit(enemyUnit); // The soldier will be re-enqueued to the list & infected soldiers counter will be incremented
             continue;
         }
 
@@ -68,7 +68,7 @@ bool AlienMonster::attack()
         // Store the IDs of the fought units to be printed later
         foughtUnits.enqueue(enemyUnit->getId());
 
-        // Nullify the pointer to avoid duplication
+        // Nullify the pointer
         enemyUnit = nullptr;
 
         // If this line is reached, at least one unit was attacked

diff --git a/UnitClasses/AlienSoldier.cpp b/UnitClasses/AlienSoldier.cpp
@@ -49,7 +49,7 @@ bool AlienSoldier::attack()
         // Store the IDs of the fought units to be printed later
         foughtUnits.enqueue(enemyUnit->getId());
 
-        // Nullify the pointer to avoid duplication
+        // Nullify the pointer
         enemyUnit = nullptr;
 
         // If this line is reached, at least one unit was attacked

diff --git a/UnitClasses/EarthGunnery.cpp b/UnitClasses/EarthGunnery.cpp
@@ -49,7 +49,7 @@ bool EarthGunnery::attack()
         // Store the IDs of the fought units to be printed later
         foughtUnits.enqueue(enemyUnit->getId());
 
-        // Nullify the pointer to avoid duplication
+        // Nullify the pointer
         enemyUnit = nullptr;
 
         // If this line is reached, at least one unit was attacked

diff --git a/UnitClasses/EarthSoldier.cpp b/UnitClasses/EarthSoldier.cpp
@@ -47,7 +47,7 @@ bool EarthSoldier::attack()
         // Store the IDs of the fought units to be printed later
         foughtUnits.enqueue(enemyUnit->getId());
 
-        // Nullify the pointer to avoid duplication
+        // Nullify the pointer
         enemyUnit = nullptr;
 
         // If this line is reached, at least one unit was attacked

diff --git a/UnitClasses/EarthTank.cpp b/UnitClasses/EarthTank.cpp
@@ -52,7 +52,7 @@ bool EarthTank::attack()
         // Store the IDs of the fought units to be printed later
         foughtUnits.enqueue(enemyUnit->getId());
 
-        // Nullify the pointer to avoid duplication
+        // Nullify the pointer
         enemyUnit = nullptr;
 
         // Set attack check to true if one unit at least was attacked successfully

diff --git a/UnitClasses/HealUnit.cpp b/UnitClasses/HealUnit.cpp
@@ -40,6 +40,7 @@ bool HealUnit::attack()
         }
 
         // Heal each unit with the appropriate heal power
+        // Inside receiveHeal, if unit is infected, it would apply only half of UAP so it would take as twice as long to heal
         unitToHeal->receiveHeal(calcUAP(unitToHeal));
 
         // Add the unit back to its list if completely healed, otherwise re-add to the UML
@@ -57,7 +58,7 @@ bool HealUnit::attack()
         // Store the IDs of the units that received heal to be printed later
         foughtUnits.enqueue(unitToHeal->getId());
 
-        // Nullify the pointer to avoid duplication
+        // Nullify the pointer
         unitToHeal = nullptr;
 
         // If this line was reached, at least one heal was successful

diff --git a/UnitClasses/SaverUnit.cpp b/UnitClasses/SaverUnit.cpp
@@ -44,7 +44,7 @@ bool SaverUnit::attack()
         // Store the IDs of the fought units to be printed later
         foughtUnits.enqueue(enemyUnit->getId());
 
-        // Nullify the pointer to avoid duplication
+        // Nullify the pointer
         enemyUnit = nullptr;
 
         // If this line is reached, at least one unit was attacked