Merge pull request #23 from devklick/feature/19_SoundEffects

Feature/19 sound effects

Author: devklick

src/assets/audio/DardDealt.mp3

@@ -1,6 +1,7 @@
 import { useRef, useState } from "react";
 import { CardObject, Facing } from "../card.types";
 import { BestHand, calculateBestHand } from "../../../utilities/deckUtilities";
+import useAudioPlayer from "../../Table/hooks/useAudioPlayer";
 
 const defaultBestHand: BestHand = { cards: [], score: 0 };
 /**
@@ -13,14 +14,18 @@ export function useCardPile() {
   const bust = useRef<boolean>(false);
   const fiveCardTrick = useRef<boolean>(false);
   const allCardsVisible = useRef<boolean>(false);
+  const {play} = useAudioPlayer();
 
   /**
    * Add cards to the pile
    * @param cardsToAdd The cards to be added to the pile
    * @param facing The direction the card should be facing when placed in the pile
    */
   function addCards(cardsToAdd: CardObject[], facing: Facing | null = null) {
-    if (facing) cardsToAdd.forEach((c) => (c.facing = facing));
+    cardsToAdd.forEach(card => {
+      play('cardDealt');
+      if (facing) card.facing = facing;
+    });
     setCards([...cards].concat(cardsToAdd));
   }
 

src/assets/audio/RoundLost.mp3

@@ -33,6 +33,22 @@ function GameSettings() {
           </div>
         </div>
 
+        <div className={styles.GameSetting}>
+          <div className={styles.Info}>
+            <span className={styles.Header}>Audio Enabled</span>
+            <span className={styles.Description}>
+              Whether or not sound effects should play
+            </span>
+          </div>
+          <div className={styles.ControlWrapper}>
+            <CheckBox
+              className={styles.Control}
+              checked={gameSettings.audioEnabled}
+              onChanged={() => gameSettings.toggleAudioEnabled()}
+            />
+          </div>
+        </div>
+
         <div className={styles.GameSetting}>
           <div className={styles.Info}>
             <span className={styles.Header}>Hit Warnings Enabled</span>

src/assets/audio/RoundWon.mp3

@@ -9,9 +9,11 @@ import { useGameSettingsStore } from "../../stores/gameSettingsStore";
 import styles from "./Table.module.scss";
 import SettingsButton from "../SettingsButton";
 import { CardEffect } from "../Card/Card";
+import useAudioPlayer from "./hooks/useAudioPlayer";
 
 const Table = ({ hide = false }: { hide?: boolean }) => {
   const game = useGame();
+  const {play} = useAudioPlayer();
   const { hitWarningsEnabled, stickWarningsEnabled } = useGameSettingsStore();
   const [showHitWarning, setShowHitWarning] = useState<boolean>(false);
   const [showStickWarning, setShowStickWarning] = useState<boolean>(false);
@@ -29,6 +31,7 @@ const Table = ({ hide = false }: { hide?: boolean }) => {
       game.getParticipantScore("Player") >= 18 &&
       !overrideWarning
     ) {
+      play('warning');
       setShowHitWarning(true);
       return;
     }
@@ -44,6 +47,7 @@ const Table = ({ hide = false }: { hide?: boolean }) => {
       game.getParticipantScore("Player") <= 10 &&
       !overrideWarning
     ) {
+      play('warning');
       setShowStickWarning(true);
       return;
     }

src/assets/audio/WarningAlert.mp3

@@ -0,0 +1,25 @@
+import cardDealt from "../../../assets/audio/DardDealt.mp3";
+import roundLost from "../../../assets/audio/RoundLost.mp3";
+import roundWon from "../../../assets/audio/RoundWon.mp3";
+import warning from "../../../assets/audio/WarningAlert.mp3";
+import { useGameSettingsStore } from "../../../stores/gameSettingsStore";
+
+type SoundEffect = "cardDealt" | "warning" | "roundWon" | "roundLost";
+
+const sounds: Record<SoundEffect, string> = {
+  cardDealt,
+  roundLost,
+  roundWon,
+  warning,
+};
+
+function useAudioPlayer() {
+  const { audioEnabled } = useGameSettingsStore();
+
+  function play(soundEffect: SoundEffect) {
+    audioEnabled && new Audio(sounds[soundEffect]).play();
+  }
+
+  return { play };
+}
+export default useAudioPlayer;

src/components/Card/hooks/useCardPile.tsx

@@ -2,6 +2,7 @@ import { useEffect, useState } from "react";
 import { useGameStats } from "../../InfoHud";
 import { determineWinner } from "../../../utilities/deckUtilities";
 import { Facing, useCardPile, useDeck } from "../../Card";
+import useAudioPlayer from "./useAudioPlayer";
 
 export type GameState =
   | "WaitingForStart"
@@ -22,6 +23,8 @@ export type WinType =
   | "high-card"
   | "draw";
 
+const delayBetweenCards = 400;
+
 export function useGame() {
   const [state, setState] = useState<GameState>("WaitingForStart");
   const [outcome, setOutcome] = useState<string | null>(null);
@@ -31,12 +34,13 @@ export function useGame() {
   const player = useCardPile();
   const dealer = useCardPile();
   const stats = useGameStats();
+  const {play} = useAudioPlayer();
 
   const dealPlayerCard = state === "DealPlayerCard";
   const dealDealerCard = state === "DealDealerCard";
   const resultGame = state === "Result";
   const dealerRound = state === "DealerRound";
-
+  
   /**
    * Takes card of determining the winner
    * when the game state changes to Result
@@ -85,7 +89,7 @@ export function useGame() {
     else if (dealerScore >= 16 && dealerScore > playerScore) {
       setState("Result");
     } else {
-      timeout = setTimeout(() => dealCardsToParticipant("Dealer", 1), 500);
+      timeout = setTimeout(() => dealCardsToParticipant("Dealer", 1), delayBetweenCards);
     }
 
     return () => {
@@ -105,7 +109,7 @@ export function useGame() {
     const timeout = setTimeout(() => {
       player.addCards(deck.take(1));
       setState("DealDealerCard");
-    }, 500);
+    }, delayBetweenCards);
 
     return () => {
       clearTimeout(timeout);
@@ -130,7 +134,7 @@ export function useGame() {
       } else {
         setState("DealPlayerCard");
       }
-    }, 500);
+    }, delayBetweenCards);
 
     return () => {
       clearTimeout(timeout);
@@ -207,6 +211,11 @@ export function useGame() {
     setState("GameOver");
     setOutcome(outcomeText);
     setWinner(winner ?? "none");
+    if (winner) {
+      play(winner === 'Player' ? 'roundWon' : 'roundLost' );
+    }
+
+    
 
     winner && stats.updateWinnerStats(winner);
   }

src/components/GameSettings/GameSettings.tsx

@@ -1 +1,6 @@
 /// <reference types="react-scripts" />
+
+declare module "*.mp3" {
+  const src: string;
+  export default src;
+}