Add unit 5 method stubs and documentation

3 files changed, 109 insertions, 4 deletions

diff --git a/src/ch/epfl/xblast/Cell.java b/src/ch/epfl/xblast/Cell.java
index d31a889..098c19c 100644
--- a/src/ch/epfl/xblast/Cell.java
+++ b/src/ch/epfl/xblast/Cell.java
@@ -175,6 +175,16 @@ public final class Cell {
     }
 
     /**
+     * Returns the hash code for this Cell, given by its row-major index.
+     *
+     * @return the hash code
+     */
+    @Override
+    public int hashCode() {
+        return 0; // TODO
+    }
+
+    /**
      * Returns a String representation of the coordinates of the Cell.
      *
      * @return a String representation of the coordinates of the Cell.
diff --git a/src/ch/epfl/xblast/SubCell.java b/src/ch/epfl/xblast/SubCell.java
index a95e65e..3b7fdb1 100644
--- a/src/ch/epfl/xblast/SubCell.java
+++ b/src/ch/epfl/xblast/SubCell.java
@@ -137,6 +137,16 @@ public final class SubCell {
     }
 
     /**
+     * Returns the hash code of this SubCell, given by its row-major index.
+     *
+     * @return the hash code
+     */
+    @Override
+    public int hashCode() {
+        return 0; // TODO
+    }
+
+    /**
      * Returns a String representation of the coordinates of the SubCell.
      *
      * @return a String representation of the coordinates of the SubCell.
diff --git a/src/ch/epfl/xblast/server/GameState.java b/src/ch/epfl/xblast/server/GameState.java
index ef792b6..a415301 100644
--- a/src/ch/epfl/xblast/server/GameState.java
+++ b/src/ch/epfl/xblast/server/GameState.java
@@ -3,12 +3,10 @@ package ch.epfl.xblast.server;
 import ch.epfl.cs108.Sq;
 import ch.epfl.xblast.ArgumentChecker;
 import ch.epfl.xblast.Cell;
+import ch.epfl.xblast.Direction;
 import ch.epfl.xblast.PlayerID;
 
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Objects;
-import java.util.Optional;
+import java.util.*;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
@@ -143,4 +141,91 @@ public final class GameState {
                 .collect(Collectors.toList());
     }
 
+    /**
+     * Returns a mapping of Cells and their Bomb.
+     *
+     * @return the map of bombs
+     */
+    public Map<Cell, Bomb> bombedCells() {
+        return null; // TODO
+    }
+
+    /**
+     * Returns the set of cells which contains at least one explosion particle.
+     *
+     * @return the set of blasted cells
+     */
+    public Set<Cell> blastedCells() {
+        return null; // TODO
+    }
+
+    /**
+     * Computes and returns the game state for the next tick, given the current state and the given events.
+     *
+     * @param speedChangeEvents the speed change events
+     * @param bombDropEvents    the bomb drop events
+     * @return the next game state
+     */
+    public GameState next(Map<PlayerID, Optional<Direction>> speedChangeEvents, Set<PlayerID> bombDropEvents) {
+        return null; // TODO
+    }
+
+    /**
+     * Computes and returns the next board state of the given board according to the given events.
+     *
+     * @param board0          the previous board
+     * @param consumedBonuses the set of consumed bonuses
+     * @param blastedCells1   the set of newly blasted cells
+     * @return the next board
+     */
+    private static Board nextBoard(Board board0, Set<Cell> consumedBonuses, Set<Cell> blastedCells1) {
+        return null; // TODO
+    }
+
+    /**
+     * Computes and returns the next player list given the current one and the given events and states.
+     *
+     * @param players0          the previous player list
+     * @param playerBonuses     the map of player bonuses
+     * @param bombedCells1      the set of newly bombed cells
+     * @param board1            the newly updated board
+     * @param blastedCells1     the set of newly blasted cells
+     * @param speedChangeEvents the speed change events
+     * @return the next player list
+     */
+    private static List<Player> nextPlayers(
+            List<Player> players0,
+            Map<PlayerID, Bonus> playerBonuses,
+            Set<Cell> bombedCells1,
+            Board board1,
+            Set<Cell> blastedCells1,
+            Map<PlayerID, Optional<Direction>> speedChangeEvents) {
+        return null; // TODO
+    }
+
+    /**
+     * Computes and returns the next state of the given explosion list.
+     *
+     * @param explosions0 the previous explosion state
+     * @return the next explosion state
+     */
+    private static List<Sq<Sq<Cell>>> nextExplosions(List<Sq<Sq<Cell>>> explosions0) {
+        return null; // TODO
+    }
+
+    /**
+     * Computes and returns the list of newly dropped bombs by players according to the given player states and events.
+     *
+     * @param players0       the previous player states
+     * @param bombDropEvents the bomb drop events
+     * @param bombs0         the previous bomb state
+     * @return the next bomb states
+     */
+    private static List<Bomb> newlyDroppedBombs(
+            List<Player> players0,
+            Set<PlayerID> bombDropEvents,
+            List<Bomb> bombs0) {
+        return null; // TODO
+    }
+
 }