some simple code changes to improve

Author: mkutay

src/entities/generic/AnimalTest.java

@@ -99,14 +99,6 @@ void testEat_EntityAlreadyDead() {
     assertFalse(prey.isAlive());
     assertEquals(animal.hungerController.getFoodLevel(), initialFoodLevel);
   }
-  
-  @Test
-  void testEat_NullList() {
-    double initialFoodLevel = animal.hungerController.getFoodLevel();
-    animal.hungerController.eat(null);
-    assertTrue(animal.isAlive());
-    assertEquals(animal.hungerController.getFoodLevel(), initialFoodLevel);
-  }
 
   @Test
   void testMoveToNearestFood_NoNearbyEntities() {

src/simulation/FieldBuilder.java

@@ -20,9 +20,9 @@ public class FieldBuilder {
   private ArrayList<Entity> entities; // The list of entities.
 
   /**
-   * Constructor.
+   * Constructor -- Create a FieldBuilder with the given width and height and create all entities.
    * @param width The width of the field.
-   * @param height The height of the field
+   * @param height The height of the field.
    */
   public FieldBuilder(int width, int height) {
     this.width = width;

src/simulation/environment/Environment.java

@@ -23,26 +23,30 @@ public Environment() {
   }
 
   /**
-   * Update the weather effects on the display.
+   * Draws the weather effects on the display.
    * @param display The display to update the weather effects on.
    */
   public void drawWeatherEffects(Display display) {
     weatherController.drawWeatherEffects(display);
   }
 
   /**
-   * Update the weather that affects the simulation.
+   * Draws the weather that affects the simulation.
    */
   public void updateWeather() {
     weatherController.updateWeather();
   }
 
+  /**
+   * Draws the weather text onto the display.
+   * @param display The display to draw.
+   */
   public void drawWeatherText(Display display) {
     weatherController.drawWeatherText(display);
   }
 
   /**
-   * Update the time of day, and if the day has changed, change the weather.
+   * Updates the time of day, and if the day has changed, change the weather.
    * @param dayNightCycleRate The amount of time to pass per update.
    */
   public void updateTime(double dayNightCycleRate) {
@@ -53,15 +57,15 @@ public void updateTime(double dayNightCycleRate) {
   }
 
   /**
-   * Draw the darkness effect onto the display.
+   * Draws the darkness effect onto the display.
    * @param display The display to draw the effects on.
    */
   public void drawDarknessEffect(Display display) {
     timeController.drawDarknessEffect(display);
   }
 
   /**
-   * Update the time effects on the display; mainly time text.
+   * Draws the time effects on the display; mainly time text.
    * @param display The display to update the time effects on.
    */
   public void drawTimeText(Display display) {

src/simulation/quadTree/QuadTree.java

@@ -118,8 +118,8 @@ private void queryInternal(Circle queryRange, List<Entity> foundEntities) {
       }
     }
 
-    // Recursively query children
     if (!hasSubdivided) return;
+    // Recursively query children:
     topLeftTree.queryInternal(queryRange, foundEntities);
     topRightTree.queryInternal(queryRange, foundEntities);
     bottomLeftTree.queryInternal(queryRange, foundEntities);

src/simulation/quadTree/Rectangle.java

@@ -10,8 +10,8 @@
  */
 public record Rectangle(double x, double y, double w, double h) {
   /**
-   * @param point The point to check inside the rectangle
-   * @return True if the point is in the rectangle, false otherwise
+   * @param point The point to check inside the rectangle.
+   * @return True if the point is in the rectangle, false otherwise.
    */
   public boolean hasPoint(Vector point) {
     double px = point.x();

src/simulation/simulationData/AnimalData.java

@@ -14,16 +14,16 @@
  * @version 1.0
  */
 public class AnimalData extends EntityData{
-  public int[] maxLitterSize; // Maximum number of offspring per breeding
-  public double[] maxSpeed; // Speed of the entity
-  public double[] sight; // Range at which the entity can see other entities
-  public String[] eats; // List of entities that this entity can eat
+  public int[] maxLitterSize; // Maximum number of offspring per breeding.
+  public double[] maxSpeed; // Speed of the entity.
+  public double[] sight; // Range at which the entity can see other entities.
+  public String[] eats; // List of entities that this entity can eat.
   /**
    * @return A random set of genetics for an animal based on the data provided.
    */
   public AnimalGenetics generateRandomGenetics() {
-    Color convertedColour = new Color(this.colour[0], this.colour[1], this.colour[2]); // Convert RGB data to java.swing.Color
-    Color mutatedColour = Utility.mutateColor(convertedColour, 1); // Change the colour slightly
+    Color convertedColour = new Color(this.colour[0], this.colour[1], this.colour[2]); // Convert RGB data to java.awt.Color.
+    Color mutatedColour = Utility.mutateColor(convertedColour, 1); // Change the colour slightly.
 
     return new AnimalGenetics(
       generateRandomNumberBetween(multiplyingRate[0], multiplyingRate[1]),

src/simulation/simulationData/Data.java

@@ -9,9 +9,9 @@
  * @version 1.0
  */
 public class Data {
-  public static final String PATH = System.getProperty("user.dir"); // The main directory of the project
+  public static final String PATH = System.getProperty("user.dir"); // The main directory of the project.
 
-  // The data of the simulation
+  // The data of the simulation:
   private static final SimulationData simulationData = Parser.parseSimulationData(Parser.getContentsOfFile(PATH + "/src/simulation_data.json"));
 
   // Getters:

src/simulation/simulationData/EntityData.java

@@ -8,17 +8,17 @@
  * @version 1.0
  */
 public abstract class EntityData {
-  public String name; // Name of the entity
-  public int numberOfEntitiesAtStart; // Number of entities at the start of the simulation
-  public int[] maxAge; // Maximum age of the entity
-  public int[] matureAge; // Age at which the entity can start breeding
-  public double[] multiplyingRate; // Rate at which the entity can multiply
-  public int[] size; // Size of the entity
-  public int[] colour; // RGB colour of the entity
-  public int[] overcrowdingThreshold; // Number of entities at which the entity will die
-  public double[] overcrowdingRadius; // Radius inside of which the threshold is checked
-  public double[] maxOffspringSpawnDistance; // Maximum distance offspring can spawn from the parent entity
-  public double[] mutationRate; // The rate at which the genetics will mutate
+  public String name; // Name of the entity.
+  public int numberOfEntitiesAtStart; // Number of entities at the start of the simulation.
+  public int[] maxAge; // Maximum age of the entity.
+  public int[] matureAge; // Age at which the entity can start breeding.
+  public double[] multiplyingRate; // Rate at which the entity can multiply.
+  public int[] size; // Size of the entity.
+  public int[] colour; // RGB colour of the entity.
+  public int[] overcrowdingThreshold; // Number of entities at which the entity will die.
+  public double[] overcrowdingRadius; // Radius inside of which the threshold is checked.
+  public double[] maxOffspringSpawnDistance; // Maximum distance offspring can spawn from the parent entity.
+  public double[] mutationRate; // The rate at which the genetics will mutate.
 
   /**
    * @return A random number between the given double min and max values.

src/simulation/simulationData/PlantData.java

@@ -13,15 +13,15 @@
  * @version 1.0
  */
 public class PlantData extends EntityData {
-  public int[] numberOfSeeds; // Number of seeds produced by the plant -- when multiplied
-  public double rainingGrowthFactor; // Growth factor when raining (affects number of seeds and range of growth)
+  public int[] numberOfSeeds; // Number of seeds produced by the plant -- when multiplied.
+  public double rainingGrowthFactor; // Growth factor when raining (affects number of seeds and range of growth).
 
   /**
    * @return A random set of genetics for a plant based on the data provided.
    */
   public PlantGenetics generateRandomGenetics() {
-    Color convertedColour = new Color(this.colour[0], this.colour[1], this.colour[2]); // Convert rgRGB data to java.swing.Color
-    Color mutatedColour = Utility.mutateColor(convertedColour, 1); // Change the colour slightly
+    Color convertedColour = new Color(this.colour[0], this.colour[1], this.colour[2]); // Convert array RGB data to java.awt.Color.
+    Color mutatedColour = Utility.mutateColor(convertedColour, 1); // Change the colour slightly.
 
     return new PlantGenetics(
       generateRandomNumberBetween(maxAge[0], maxAge[1]),

src/simulation/simulationData/SimulationData.java

@@ -1,25 +1,25 @@
 package simulation.simulationData;
 
 public class SimulationData {
-  public AnimalData[] preysData; // An array of prey species data
-  public AnimalData[] predatorsData; // An array of predator species data
-  public PlantData[] plantsData; // An array of plant types data
+  public AnimalData[] preysData; // An array of prey species data.
+  public AnimalData[] predatorsData; // An array of predator species data.
+  public PlantData[] plantsData; // An array of plant types data.
 
-  public double foodValueForAnimals; // Scales the food value of animals
-  public double foodValueForPlants; // Scales the food value of plants
-  public double animalHungerDrain; // Controls rate of foodLevel depletion over time
-  public double animalBreedingCost; // Scales how much food is consumed on breeding; use 0 for no food cost
+  public double foodValueForAnimals; // Scales the food value of animals.
+  public double foodValueForPlants; // Scales the food value of plants.
+  public double animalHungerDrain; // Controls rate of foodLevel depletion over time.
+  public double animalBreedingCost; // Scales how much food is consumed on breeding; use 0 for no food cost.
 
-  public double mutationFactor; // The ratio that the genetics will mutate by
-  public double entityAgeRate; // Controls how fast the entities age
+  public double mutationFactor; // The ratio that the genetics will mutate by.
+  public double entityAgeRate; // Controls how fast the entities age.
   public double fieldScaleFactor; // The size of the field, smaller value means more zoomed in.
-  public double weatherChangeProbability; // The probability of the weather changing
-  public double windStrength; // The strength of the wind in windy conditions
-  public double stormMovementSpeedFactor; // When a storm happens, the factor that hinders the entities' speed
-  public double dayNightCycleSpeed; // The speed of the day-night cycle -- how fast the time passes
-  public boolean doDayNightCycle; // Whether the day-night cycle is enabled
-  public boolean doWeatherCycle; // Whether the weather cycle is enabled
-  public boolean showQuadTrees; // Whether the quad trees are shown
+  public double weatherChangeProbability; // The probability of the weather changing.
+  public double windStrength; // The strength of the wind in windy conditions.
+  public double stormMovementSpeedFactor; // When a storm happens, the factor that hinders the entities' speed.
+  public double dayNightCycleSpeed; // The speed of the day-night cycle -- how fast the time passes.
+  public boolean doDayNightCycle; // Whether the day-night cycle is enabled.
+  public boolean doWeatherCycle; // Whether the weather cycle is enabled.
+  public boolean showQuadTrees; // Whether the quad trees are shown.
 
   public double animalHungerThreshold; // Animals will look for food at this threshold.
   public double animalDyingOfHungerThreshold; // Animals will prioritise looking for food at this threshold.