Commits

Anonymous committed d0af545

no message

  • Participants
  • Parent commits 9889ee0

Comments (0)

Files changed (5)

File src/Game/Cell.java

 package Game;
 
 /**
- * Represent a single cell on the board during randomly maze generating.
+ * Represents a single cell on the board during randomly maze generating.
  */
 
 public class Cell {
     }
 
     /**
-     * Visit a cell by setting its direction to the specified direction and 'push
-     * down' the wall at that direction.
+     * Visit a cell by setting its direction to the specified direction and
+     * 'knock down' the wall at that direction.
      *
-     * @param direction The direction we want to set up the cell for.
+     * @param direction The direction to set up the cell.
      */
     public void visit(int direction) {
         this.direction = direction;

File src/Game/DFS.java

     }
 
     /**
-     * Calculates the change in x if we want to move in the specified direction.
+     * Calculates the difference in x-coordinate to an adjacent cell in the
+     * specified direction.
      *
-     * @param direction The direction we want to move.
-     * @return The change in x if we want to move in that direction.
+     * @param direction The relative direction of the adjacent cell.
+     * @return The difference in x-coordinate.
      */
     private int DX(int direction) {
         if (E == direction) {
     }
 
     /**
-     * Calculates the change in y if we want to move in the specified direction.
+     * Calculates the difference in y-coordinate to an adjacent cell in the
+     * specified direction.
      *
-     * @param direction The direction we want to move
-     * @return the change in y if we want to move in that direction.
+     * @param direction The relative direction of the adjacent cell.
+     * @return The difference in y-coordinate.
      */
     private int DY(int direction) {
         if (N == direction) {
      * Checks if there is any cell that has a direction of '0'.
      * This is a workaround function.
      *
-     * @return If the maze we generated contains errors.
+     * @return If the maze contains errors.
      */
     public boolean containErrors() {
         for (int i = 0; i < height; i++) {

File src/Game/EndPoint.java

      * The ball collides with the end if the distance between their centres
      * is less than the threshold.
      *
-     * @param ball The ball we want to test for.
+     * @param ball The ball being tested for.
      * @return If the end collides with the ball.
      */
     @Override

File src/Game/Hole.java

      * is less than a certain value AND the magnitude of the linear speed of
      * the ball is less than a certain value.
      *
-     * @param ball The ball we want to test for.
+     * @param ball The ball being tested for.
      * @return If the end collides with the ball.
      */
     public boolean collideWith(Ball ball) {

File src/Game/RigidBody.java

     /**
      * Sets the location of the object.
      *
-     * @param location The location to which we want to set.
+     * @param location The location to which the object is set.
      */
     public void setLocation(Vector3f location) {
         this.location = location;