From 700bfba0dfe94b6a36adee1cf764b173980f1e88 Mon Sep 17 00:00:00 2001 From: Matthew Grove Date: Sun, 23 Apr 2023 23:22:14 +0100 Subject: [PATCH] [TIDY] JavaDoc comments --- .../java/uk/mgrove/ac/soton/comp1206/component/Chat.java | 4 ++++ .../uk/mgrove/ac/soton/comp1206/component/GameBlock.java | 5 +++-- .../uk/mgrove/ac/soton/comp1206/component/GameBoard.java | 7 +++++++ .../mgrove/ac/soton/comp1206/component/Leaderboard.java | 1 + .../mgrove/ac/soton/comp1206/component/PieceBoard.java | 7 +++++++ .../mgrove/ac/soton/comp1206/component/ScoresList.java | 3 +++ .../ac/soton/comp1206/event/ShowScoresSceneListener.java | 1 + src/main/java/uk/mgrove/ac/soton/comp1206/game/Game.java | 2 ++ .../mgrove/ac/soton/comp1206/game/MultiplayerGame.java | 4 ++++ .../mgrove/ac/soton/comp1206/scene/ChallengeScene.java | 9 +++++++++ .../uk/mgrove/ac/soton/comp1206/scene/LoadingScene.java | 3 +++ .../uk/mgrove/ac/soton/comp1206/scene/LobbyScene.java | 3 +++ .../mgrove/ac/soton/comp1206/scene/MultiplayerScene.java | 4 +++- .../java/uk/mgrove/ac/soton/comp1206/ui/GameWindow.java | 3 ++- 14 files changed, 52 insertions(+), 4 deletions(-) diff --git a/src/main/java/uk/mgrove/ac/soton/comp1206/component/Chat.java b/src/main/java/uk/mgrove/ac/soton/comp1206/component/Chat.java index 8a4ce85..ef64759 100644 --- a/src/main/java/uk/mgrove/ac/soton/comp1206/component/Chat.java +++ b/src/main/java/uk/mgrove/ac/soton/comp1206/component/Chat.java @@ -14,6 +14,9 @@ import org.apache.logging.log4j.Logger; import uk.mgrove.ac.soton.comp1206.network.Communicator; import uk.mgrove.ac.soton.comp1206.util.Multimedia; +/** + * Clas for chat container + */ public class Chat extends VBox { /** @@ -59,6 +62,7 @@ public class Chat extends VBox { /** * Initialise the chat container with a communicator * @param communicator the communicator to use + * @param compact whether the container should have a compact layout */ public Chat(Communicator communicator, boolean compact) { this.communicator = communicator; diff --git a/src/main/java/uk/mgrove/ac/soton/comp1206/component/GameBlock.java b/src/main/java/uk/mgrove/ac/soton/comp1206/component/GameBlock.java index b03fc2e..0810f52 100644 --- a/src/main/java/uk/mgrove/ac/soton/comp1206/component/GameBlock.java +++ b/src/main/java/uk/mgrove/ac/soton/comp1206/component/GameBlock.java @@ -139,6 +139,7 @@ public class GameBlock extends Canvas { /** * Handle painting of the block canvas with block preview + * @param color color to paint block preview */ public void paintPreview(Color color) { logger.info("Painting preview overlay on block at x: {}, y: {} with color: {}", getX(), getY(), color); @@ -263,12 +264,12 @@ public class GameBlock extends Canvas { private int iterations = 0; @Override public void handle(long now) { - if (iterations < 12) { + if (iterations < 10) { color = color.deriveColor(0,1,1.2,1); paintColor(color); if (isFocussed) paintFocusOverlay(); } else if (color.getOpacity() > 0.1) { - color = color.deriveColor(0,1,1,0.95); + color = color.deriveColor(0,1,1,0.9); paintColor(color); if (isFocussed) paintFocusOverlay(); } else { diff --git a/src/main/java/uk/mgrove/ac/soton/comp1206/component/GameBoard.java b/src/main/java/uk/mgrove/ac/soton/comp1206/component/GameBoard.java index 5368d6c..ec0f756 100644 --- a/src/main/java/uk/mgrove/ac/soton/comp1206/component/GameBoard.java +++ b/src/main/java/uk/mgrove/ac/soton/comp1206/component/GameBoard.java @@ -170,6 +170,7 @@ public class GameBoard extends GridPane { * Create a block at the given x and y position in the GameBoard * @param x column * @param y row + * @return block that was created */ protected GameBlock createBlock(int x, int y) { logger.info("Creating new block at x: {}, y: {}", x, y); @@ -202,6 +203,8 @@ public class GameBoard extends GridPane { /** * Get grid value property + * @param x x-coordinate in grid + * @param y y-coordinate in grid * @return properties for value of block at given location in grid */ public IntegerProperty getGridProperty(int x, int y) { @@ -229,6 +232,10 @@ public class GameBoard extends GridPane { } } + /** + * Handle game block being hovered + * @param gameBlock game block that was hovered + */ public void blockHovered(GameBlock gameBlock) { grid.clearPreview(); if (enableFocus) { diff --git a/src/main/java/uk/mgrove/ac/soton/comp1206/component/Leaderboard.java b/src/main/java/uk/mgrove/ac/soton/comp1206/component/Leaderboard.java index f952e45..24bf1d8 100644 --- a/src/main/java/uk/mgrove/ac/soton/comp1206/component/Leaderboard.java +++ b/src/main/java/uk/mgrove/ac/soton/comp1206/component/Leaderboard.java @@ -27,6 +27,7 @@ public class Leaderboard extends ScoresList { /** * Initialise the leaderboard + * @param titleText text for list title */ public Leaderboard(String titleText) { super(); diff --git a/src/main/java/uk/mgrove/ac/soton/comp1206/component/PieceBoard.java b/src/main/java/uk/mgrove/ac/soton/comp1206/component/PieceBoard.java index 1eb25f0..d417fc8 100644 --- a/src/main/java/uk/mgrove/ac/soton/comp1206/component/PieceBoard.java +++ b/src/main/java/uk/mgrove/ac/soton/comp1206/component/PieceBoard.java @@ -4,6 +4,9 @@ import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; import uk.mgrove.ac.soton.comp1206.game.GamePiece; +/** + * Smaller board, to show pieces without interaction + */ public class PieceBoard extends GameBoard { /** @@ -23,6 +26,10 @@ public class PieceBoard extends GameBoard { enableFocus = false; } + /** + * Display a piece in the board + * @param piece piece to display + */ public void displayPiece(GamePiece piece) { logger.info("Displaying new piece: {}", piece.toString()); grid.clearGrid(); diff --git a/src/main/java/uk/mgrove/ac/soton/comp1206/component/ScoresList.java b/src/main/java/uk/mgrove/ac/soton/comp1206/component/ScoresList.java index f5f82a8..b02d04e 100644 --- a/src/main/java/uk/mgrove/ac/soton/comp1206/component/ScoresList.java +++ b/src/main/java/uk/mgrove/ac/soton/comp1206/component/ScoresList.java @@ -35,6 +35,7 @@ public class ScoresList extends VBox { /** * Initialise the scores list + * @param titleText text for list title */ public ScoresList(String titleText) { logger.info("Building scores list"); @@ -49,8 +50,10 @@ public class ScoresList extends VBox { logger.info("Detected change in scores list: {}", change); getChildren().clear(); getChildren().add(title); + setSpacing(4); for (var pair : scores.get()) { var individualScoreContainer = new HBox(); + individualScoreContainer.setSpacing(8); individualScoreContainer.getChildren().addAll(new Text(pair.getKey()), new Text(pair.getValue().toString())); getChildren().add(individualScoreContainer); } diff --git a/src/main/java/uk/mgrove/ac/soton/comp1206/event/ShowScoresSceneListener.java b/src/main/java/uk/mgrove/ac/soton/comp1206/event/ShowScoresSceneListener.java index ceeb760..fd06d55 100644 --- a/src/main/java/uk/mgrove/ac/soton/comp1206/event/ShowScoresSceneListener.java +++ b/src/main/java/uk/mgrove/ac/soton/comp1206/event/ShowScoresSceneListener.java @@ -9,6 +9,7 @@ public interface ShowScoresSceneListener { /** * Show the scene + * @param game the game used when initialising the scores scene */ void show(Game game); diff --git a/src/main/java/uk/mgrove/ac/soton/comp1206/game/Game.java b/src/main/java/uk/mgrove/ac/soton/comp1206/game/Game.java index 67633b1..3891799 100644 --- a/src/main/java/uk/mgrove/ac/soton/comp1206/game/Game.java +++ b/src/main/java/uk/mgrove/ac/soton/comp1206/game/Game.java @@ -396,6 +396,7 @@ public class Game { /** * Set the player's remaining lives + * @param lives number of remaining lives */ public void setLives(int lives) { this.lives.set(lives); @@ -411,6 +412,7 @@ public class Game { /** * Set the player's current multiplier + * @param multiplier the current multiplier */ public void setMultiplier(int multiplier) { this.multiplier.set(multiplier); diff --git a/src/main/java/uk/mgrove/ac/soton/comp1206/game/MultiplayerGame.java b/src/main/java/uk/mgrove/ac/soton/comp1206/game/MultiplayerGame.java index 902e17a..eae6b43 100644 --- a/src/main/java/uk/mgrove/ac/soton/comp1206/game/MultiplayerGame.java +++ b/src/main/java/uk/mgrove/ac/soton/comp1206/game/MultiplayerGame.java @@ -17,6 +17,9 @@ import java.util.Scanner; import java.util.concurrent.BlockingQueue; import java.util.concurrent.LinkedBlockingQueue; +/** + * Class for multiplayer games + */ public class MultiplayerGame extends Game { /** @@ -54,6 +57,7 @@ public class MultiplayerGame extends Game { * * @param cols number of columns * @param rows number of rows + * @param communicator communicator to use */ public MultiplayerGame(int cols, int rows, Communicator communicator) { super(cols, rows); diff --git a/src/main/java/uk/mgrove/ac/soton/comp1206/scene/ChallengeScene.java b/src/main/java/uk/mgrove/ac/soton/comp1206/scene/ChallengeScene.java index ac42970..73663fa 100644 --- a/src/main/java/uk/mgrove/ac/soton/comp1206/scene/ChallengeScene.java +++ b/src/main/java/uk/mgrove/ac/soton/comp1206/scene/ChallengeScene.java @@ -226,12 +226,21 @@ public class ChallengeScene extends BaseScene { gameWindow.startMenu(); } + /** + * Show the scores scene + * @param game game that just ended + */ protected void showScores(Game game) { if (timerCountdownBarFillTransition != null) timerCountdownBarFillTransition.stop(); if (timerCountdownBarScaleTransition != null) timerCountdownBarScaleTransition.stop(); gameWindow.startScores(game); } + /** + * Set the current and next piece + * @param currentPiece current piece + * @param followingPiece next piece + */ protected void setCurrentPiece(GamePiece currentPiece, GamePiece followingPiece) { currentPieceBoard.displayPiece(currentPiece); followingPieceBoard.displayPiece(followingPiece); diff --git a/src/main/java/uk/mgrove/ac/soton/comp1206/scene/LoadingScene.java b/src/main/java/uk/mgrove/ac/soton/comp1206/scene/LoadingScene.java index 8c145d7..fd17da1 100644 --- a/src/main/java/uk/mgrove/ac/soton/comp1206/scene/LoadingScene.java +++ b/src/main/java/uk/mgrove/ac/soton/comp1206/scene/LoadingScene.java @@ -15,6 +15,9 @@ import uk.mgrove.ac.soton.comp1206.util.Multimedia; import java.util.Timer; import java.util.TimerTask; +/** + * Class for loading scene, displayed when game is first loading + */ public class LoadingScene extends BaseScene { /** diff --git a/src/main/java/uk/mgrove/ac/soton/comp1206/scene/LobbyScene.java b/src/main/java/uk/mgrove/ac/soton/comp1206/scene/LobbyScene.java index 43f0435..2880c1f 100644 --- a/src/main/java/uk/mgrove/ac/soton/comp1206/scene/LobbyScene.java +++ b/src/main/java/uk/mgrove/ac/soton/comp1206/scene/LobbyScene.java @@ -20,6 +20,9 @@ import uk.mgrove.ac.soton.comp1206.ui.GameWindow; import java.util.Timer; import java.util.TimerTask; +/** + * Class for multiplayer lobby, displayed before multiplayer games start + */ public class LobbyScene extends BaseScene { /** diff --git a/src/main/java/uk/mgrove/ac/soton/comp1206/scene/MultiplayerScene.java b/src/main/java/uk/mgrove/ac/soton/comp1206/scene/MultiplayerScene.java index f501c65..250bc8f 100644 --- a/src/main/java/uk/mgrove/ac/soton/comp1206/scene/MultiplayerScene.java +++ b/src/main/java/uk/mgrove/ac/soton/comp1206/scene/MultiplayerScene.java @@ -5,6 +5,7 @@ import javafx.beans.property.MapProperty; import javafx.beans.property.SimpleIntegerProperty; import javafx.beans.property.SimpleMapProperty; import javafx.collections.FXCollections; +import javafx.geometry.Insets; import javafx.geometry.Pos; import javafx.scene.control.Separator; import javafx.scene.layout.GridPane; @@ -82,7 +83,8 @@ public class MultiplayerScene extends ChallengeScene { var newBoardContainer = new VBox(newBoardTitle, newGameBoard); newBoardContainer.setAlignment(Pos.CENTER); newBoardContainer.setSpacing(4); - playerBoardGrid.add(newBoardContainer, 1, 1); + newBoardContainer.setPadding(new Insets(8)); + playerBoardGrid.add(newBoardContainer, rowIndex, columnIndex); })); gameWindow.getCommunicator().send("SCORES"); diff --git a/src/main/java/uk/mgrove/ac/soton/comp1206/ui/GameWindow.java b/src/main/java/uk/mgrove/ac/soton/comp1206/ui/GameWindow.java index 903e3db..a367b79 100644 --- a/src/main/java/uk/mgrove/ac/soton/comp1206/ui/GameWindow.java +++ b/src/main/java/uk/mgrove/ac/soton/comp1206/ui/GameWindow.java @@ -116,7 +116,8 @@ public class GameWindow { public void startInstructions() { loadScene(new InstructionsScene(this)); } /** - * Display the single player challenge + * Display the scores scene + * @param game the game that just finished */ public void startScores(Game game) { loadScene(new ScoresScene(this, game)); }