Merge pull request #17 from neu-cs4530/documentation-and-more-testing

Documentation fixes

Author: nprosk

frontend/src/classes/interactable/PongAreaController.ts

@@ -119,7 +119,7 @@ export default class PongAreaController extends GameAreaController<PongGameState
   }
 
   /**
-   * Returns the color of the current player's game piece
+   * Returns the side of the current player's game piece
    * @throws an error with message PLAYER_NOT_IN_GAME_ERROR if the current player is not in the game
    */
   get gamePiece(): PongPlayer {
@@ -221,14 +221,12 @@ export default class PongAreaController extends GameAreaController<PongGameState
   }
 
   /**
-   * Sends a request to the server to place the current player's game piece in the given column.
-   * Calculates the row to place the game piece in based on the current state of the board.
+   * Sends a request to the server to move the paddle up or down.
    * Does not check if the move is valid.
    *
    * @throws an error with message NO_GAME_IN_PROGRESS_ERROR if there is no game in progress
-   * @throws an error with message COLUMN_FULL_MESSAGE if the column is full
    *
-   * @param col Column to place the game piece in
+   * @param direction Direction user moves the Paddle
    */
   public async makeMove(direction: PongPaddleDirection): Promise<void> {
     const instanceID = this._instanceID;

frontend/src/classes/interactable/TargetShooterAreaController.ts

@@ -33,7 +33,7 @@ export type TargetShooterEvents = GameEventTypes & {
 };
 
 /**
- * This class is responsible for managing the state of the Pong game, and for sending commands to the server
+ * This class is responsible for managing the state of the Target Shooter game, and for sending commands to the server
  */
 export default class TargetShooterAreaController extends GameAreaController<
   TargetShooterGameState,
@@ -62,33 +62,37 @@ export default class TargetShooterAreaController extends GameAreaController<
     shots: 0,
   };
 
-  // returns the current position of the ball
+  // returns the current position of the target
   get targetPosition(): XY {
     return this._targetposition;
   }
 
-  // returns the current score of the left player
+  // returns the current score of player1
   get player1Score(): TargetShooterScore {
     return this._player1score;
   }
 
-  // returns the current score of the right player
+  // returns the current score of player2
   get player2Score(): TargetShooterScore {
     return this._player2score;
   }
 
+  // returns the accuracy of player1
   get player1Accuracy(): TargetShooterAccuracy {
     return this._player1Acccuracy;
   }
 
+  // returns the accuracy of player2
   get player2Accuracy(): TargetShooterAccuracy {
     return this._player2Acccuracy;
   }
 
+  // returns what level of difficulty was selected
   get difficulty(): TargetShooterDifficulty {
     return this._difficulty;
   }
 
+  // returns the size of the target
   get targetSize(): number {
     return this._targetSize;
   }
@@ -134,7 +138,7 @@ export default class TargetShooterAreaController extends GameAreaController<
   }
 
   /**
-   * Returns the color of the current player's game piece
+   * Returns the player of the current player's game piece
    * @throws an error with message PLAYER_NOT_IN_GAME_ERROR if the current player is not in the game
    */
   get gamePiece(): TargetShooterPlayer {
@@ -179,11 +183,13 @@ export default class TargetShooterAreaController extends GameAreaController<
    * Calls super._updateFrom, which updates the occupants of this game area and other
    * common properties (including this._model)
    *
-   * If the opposite paddle has changed, emits an oppositePaddleUpdated event with the new paddle location
-   * If the our paddle has changed, emits an ourPaddleUpdated event with the new paddle location
-   * If the ball position has changed, emits a ballPositionUpdated event with the new ball position
-   * If the left score has changed, emits a leftScoreUpdated event with the new left score
-   * If the right score has changed, emits a rightScoreUpdated event with the new right score
+   * If the target position has changed, emits an targetPositionUpdated event with the new target location
+   * If the player1 score has changed, emits an player1Score event with the new player 1 score
+   * If the player2 score has changed, emits an player2Score event with the new player 2 score
+   * If the difficulty has changed, emits a difficultyUpdated event with the new difficulty
+   * If the target size has changed, emits a targetSizeUpdated event with the new target size
+   * If the player1 accuracy has changed, emits a player1AccuracyUpdated event with the new player1 accuracy
+   * If the player2 accuracy has changed, emits a player1AccuracyUpdated event with the new player2 accuracy
    *
    */
   protected _updateFrom(newModel: GameArea<TargetShooterGameState>): void {
@@ -251,9 +257,8 @@ export default class TargetShooterAreaController extends GameAreaController<
    * Does not check if the move is valid.
    *
    * @throws an error with message NO_GAME_IN_PROGRESS_ERROR if there is no game in progress
-   * @throws an error with message COLUMN_FULL_MESSAGE if the column is full
    *
-   * @param col Column to place the game piece in
+   * @param position XY where the player's position is
    */
   public async makeMove(position: XY): Promise<void> {
     const instanceID = this._instanceID;

frontend/src/components/Town/interactables/Inventory.tsx

@@ -14,18 +14,13 @@ const itemImages = {
 };
 
 /**
- * A generic component that renders a game area.
  *
  * It uses Chakra-UI components (does not use other GUI widgets)
  *
- * It uses the TicketBoothAreaController corresponding to the provided interactableID to get the current state of the game. (@see useInteractableAreaController)
- *
- * It renders the following:
- *  - A leaderboard of the game results
- *  - A list of occupants' usernames (in a list with the aria-label 'list of occupants in the game')
- *  - The game area component (either ConnectFourArea or TicTacToeArea). If the game area is NOT a ConnectFourArea or TicTacToeArea, then the message INVALID_GAME_AREA_TYPE_MESSAGE appears within the component
- *  - A chat channel for the game area (@see ChatChannel.tsx), with the property interactableID set to the interactableID of the game area
+ * It uses the TicketBoothAreaController corresponding to the provided interactableID to get
+ * the current state of the players inventory. (@see useInteractableAreaController)
  *
+ * TESTED MANUALLY
  */
 export function Inventory({ interactableID }: { interactableID: InteractableID }): JSX.Element {
   const ticketBoothAreaController = useInteractableAreaController(

frontend/src/components/Town/interactables/Pong/PongArea.tsx

@@ -8,12 +8,12 @@ import PongAreaController from '../../../../classes/interactable/PongAreaControl
 import PongDisplay from './PongDisplay';
 
 /**
- * The ConnectFourArea component renders the Connect Four game area.
+ * The PongArea component renders the Pong game area.
  * It renders the current state of the area, optionally allowing the player to join the game.
  *
  * It uses Chakra-UI components (does not use other GUI widgets)
  *
- * It uses the ConnectFourAreaController to get the current state of the game.
+ * It uses the PongAreaController to get the current state of the game.
  * It listens for the 'gameUpdated' and 'gameEnd' events on the controller, and re-renders accordingly.
  * It subscribes to these events when the component mounts, and unsubscribes when the component unmounts. It also unsubscribes when the gameAreaController changes.
  *
@@ -36,7 +36,6 @@ import PongDisplay from './PongDisplay';
  *    - Before calling startGame method, the button is disabled and has the property isLoading set to true, and is re-enabled when the method call completes
  *    - If the method call fails, a toast is displayed with the error message as the description of the toast (and status 'error')
  *    - Once the game starts, the button dissapears
- * - The ConnectFourBoard component, which is passed the current gameAreaController as a prop (@see ConnectFourBoard.tsx)
  *
  * - When the game ends, a toast is displayed with the result of the game:
  *    - Tie: description 'Game ended in a tie'

frontend/src/components/Town/interactables/Pong/PongDisplay.tsx

@@ -28,24 +28,13 @@ const Ball = ({ position }: { position: XY }) => {
 /**
  * A component that renders the ConnectFour state
  *
- * Renders the ConnectFour state as a "StyledConnectFourstate", which consists of "StyledConnectFourSquare"s
- * (one for each cell in the state, starting from the top left and going left to right, top to bottom).
+ * Renders the Pong state
  *
- * Each StyledConnectFourSquare has an aria-label property that describes the cell's position in the state,
- * formatted as `Cell ${rowIndex},${colIndex} (Red|Yellow|Empty)`.
+ * The state is re-rendered whenever the state changes
  *
- * The background color of each StyledConnectFourSquare is determined by the value of the cell in the state, either
- * 'red', 'yellow', or '' (an empty for an empty square).
+ * TESTED MANUALLY
  *
- * The state is re-rendered whenever the state changes, and each cell is re-rendered whenever the value
- * of that cell changes.
- *
- * If the current player is in the game, then each StyledConnectFourSquare is clickable, and clicking
- * on it will make a move in that column. If there is an error making the move, then a toast will be
- * displayed with the error message as the description of the toast. If it is not the current player's
- * turn, then the StyledConnectFourSquare will be disabled.
- *
- * @param gameAreaController the controller for the ConnectFour game
+ * @param gameAreaController the controller for the Pong game
  */
 export default function PongDisplay({ gameAreaController }: PongGameProps): JSX.Element {
   const [ballPosition, setBallPosition] = useState(gameAreaController.ballPosition);

frontend/src/components/Town/interactables/TargetShooter/TargetShooterArea.tsx

@@ -22,19 +22,19 @@ import TargetAreaController from '../../../../classes/interactable/TargetShooter
 import TargetShooterDisplay from './TargetShooterDisplay';
 
 /**
- * The ConnectFourArea component renders the Connect Four game area.
+ * The TargetShooterArea component renders the Target Shooter game area.
  * It renders the current state of the area, optionally allowing the player to join the game.
  *
  * It uses Chakra-UI components (does not use other GUI widgets)
  *
- * It uses the ConnectFourAreaController to get the current state of the game.
+ * It uses the TargetShooterAreaController to get the current state of the game.
  * It listens for the 'gameUpdated' and 'gameEnd' events on the controller, and re-renders accordingly.
  * It subscribes to these events when the component mounts, and unsubscribes when the component unmounts. It also unsubscribes when the gameAreaController changes.
  *
  * It renders the following:
- * - A list of players' usernames (in a list with the aria-label 'list of players in the game', one item for leftPlayer and one for rightPlayer)
+ * - A list of players' usernames (in a list with the aria-label 'list of players in the game', one item for player1 and one for player2)
  *    - If there is no player in the game, the username is '(No player yet!)'
- *    - List the players as (exactly) `leftPlayer: ${username}` and `rightPlayer: ${username}`
+ *    - List the players as (exactly) `player1: ${username}` and `player2: ${username}`
  * - A message indicating the current game status:
  *    - If the game is in progress, the message is 'Game in progress, {moveCount} moves in, currently {whoseTurn}'s turn'. If it is currently our player's turn, the message is 'Game in progress, {moveCount} moves in, currently your turn'
  *    - If the game is in status WAITING_FOR_PLAYERS, the message is 'Waiting for players to join'
@@ -50,7 +50,6 @@ import TargetShooterDisplay from './TargetShooterDisplay';
  *    - Before calling startGame method, the button is disabled and has the property isLoading set to true, and is re-enabled when the method call completes
  *    - If the method call fails, a toast is displayed with the error message as the description of the toast (and status 'error')
  *    - Once the game starts, the button dissapears
- * - The ConnectFourBoard component, which is passed the current gameAreaController as a prop (@see ConnectFourBoard.tsx)
  *
  * - When the game ends, a toast is displayed with the result of the game:
  *    - Tie: description 'Game ended in a tie'

frontend/src/components/Town/interactables/TargetShooter/TargetShooterDisplay.tsx

@@ -19,24 +19,17 @@ const Target = ({ position, size }: { position: XY; size: number }) => {
 };
 
 /**
- * A component that renders the ConnectFour state
+ * A component that renders the TargetShooter state
  *
- * Renders the ConnectFour state as a "StyledConnectFourstate", which consists of "StyledConnectFourSquare"s
- * (one for each cell in the state, starting from the top left and going left to right, top to bottom).
+ * The state is re-rendered whenever the state changes, and each target is re-rendered whenever the target position changes
+ * The state is re-rendered whenever the difficulty is changed
  *
- * Each StyledConnectFourSquare has an aria-label property that describes the cell's position in the state,
- * formatted as `Cell ${rowIndex},${colIndex} (Red|Yellow|Empty)`.
  *
- * The background color of each StyledConnectFourSquare is determined by the value of the cell in the state, either
- * 'red', 'yellow', or '' (an empty for an empty square).
+ * If the current player is in the game, then each Target is clickable, and clicking
+ * on it will make a move in the game and spawn a new target. If there is an error making the move, then a toast will be
+ * displayed with the error message as the description of the toast.
  *
- * The state is re-rendered whenever the state changes, and each cell is re-rendered whenever the value
- * of that cell changes.
- *
- * If the current player is in the game, then each StyledConnectFourSquare is clickable, and clicking
- * on it will make a move in that column. If there is an error making the move, then a toast will be
- * displayed with the error message as the description of the toast. If it is not the current player's
- * turn, then the StyledConnectFourSquare will be disabled.
+ * TESTED MANUALLY
  *
  * @param gameAreaController the controller for the ConnectFour game
  */

frontend/src/components/Town/interactables/TicketBooth/TicketBoothStore.tsx

@@ -42,18 +42,13 @@ const flashing = keyframes`
   `;
 
 /**
- * A generic component that renders a game area.
  *
  * It uses Chakra-UI components (does not use other GUI widgets)
  *
- * It uses the TicketBoothAreaController corresponding to the provided interactableID to get the current state of the game. (@see useInteractableAreaController)
- *
- * It renders the following:
- *  - A leaderboard of the game results
- *  - A list of occupants' usernames (in a list with the aria-label 'list of occupants in the game')
- *  - The game area component (either ConnectFourArea or TicTacToeArea). If the game area is NOT a ConnectFourArea or TicTacToeArea, then the message INVALID_GAME_AREA_TYPE_MESSAGE appears within the component
- *  - A chat channel for the game area (@see ChatChannel.tsx), with the property interactableID set to the interactableID of the game area
+ * It uses the TicketBoothAreaController corresponding to the provided interactableID to get
+ * the current state of the store. (@see useInteractableAreaController)
  *
+ * TESTED MANUALLY
  */
 export function TicketBoothStore({
   interactableID,

frontend/src/components/Town/interactables/TicketBoothsArea.tsx

@@ -20,18 +20,13 @@ import { Inventory } from './Inventory';
 import { TokenLeaderboard } from './TokenLeaderboard';
 
 /**
- * A generic component that renders a game area.
  *
  * It uses Chakra-UI components (does not use other GUI widgets)
  *
- * It uses the TicketBoothAreaController corresponding to the provided interactableID to get the current state of the game. (@see useInteractableAreaController)
- *
- * It renders the following:
- *  - A leaderboard of the game results
- *  - A list of occupants' usernames (in a list with the aria-label 'list of occupants in the game')
- *  - The game area component (either ConnectFourArea or TicTacToeArea). If the game area is NOT a ConnectFourArea or TicTacToeArea, then the message INVALID_GAME_AREA_TYPE_MESSAGE appears within the component
- *  - A chat channel for the game area (@see ChatChannel.tsx), with the property interactableID set to the interactableID of the game area
+ * It uses the TicketBoothAreaController corresponding to the provided interactableID to get
+ *  the current state of the ticketbooth. (@see useInteractableAreaController)
  *
+ * TESTED MANUALLY
  */
 function TicketBoothsArea({ interactableID }: { interactableID: InteractableID }): JSX.Element {
   return (

frontend/src/components/Town/interactables/TokenLeaderboard.tsx

@@ -4,17 +4,12 @@ import { usePlayers } from '../../../classes/TownController';
 import PlayerController from '../../../classes/PlayerController';
 
 /**
- * A generic component that renders a game area.
+ * A generic component that renders a token leaderboard.
  *
  * It uses Chakra-UI components (does not use other GUI widgets)
  *
- * It uses the TicketBoothAreaController corresponding to the provided interactableID to get the current state of the game. (@see useInteractableAreaController)
+ * It uses the UsePlayers hook to get the current players of the game. (@see usePlayers)
  *
- * It renders the following:
- *  - A leaderboard of the game results
- *  - A list of occupants' usernames (in a list with the aria-label 'list of occupants in the game')
- *  - The game area component (either ConnectFourArea or TicTacToeArea). If the game area is NOT a ConnectFourArea or TicTacToeArea, then the message INVALID_GAME_AREA_TYPE_MESSAGE appears within the component
- *  - A chat channel for the game area (@see ChatChannel.tsx), with the property interactableID set to the interactableID of the game area
  *
  */
 export function TokenLeaderboard(): JSX.Element {