Package com.deco2800.game.files.meta

Class BackgroundMusic

java.lang.Object
com.deco2800.game.files.meta.BackgroundMusic
public class BackgroundMusic
extends java.lang.Object

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  BackgroundMusic.MusicList  
    static class  BackgroundMusic.SelectedMusicList  

  • Constructor Summary

    Constructors 
    Constructor Description
    BackgroundMusic()  

  • Method Summary

    Modifier and Type Method Description
    static boolean containsScreenMusic​(java.lang.String screenName)
    Checks if a particular screen has associated background music
    static java.lang.String[] getAllMusicByScreen​(java.lang.String screenName)
    Fetch all music paths for a particular screen
    static java.lang.String getNotSelectedTrack​(java.lang.String screenName)
    Get the first non-selected track of a screen
    static java.lang.String getSelectedMusic​(java.lang.String screenName)
    Get selected music track for the supplied screen name
    static boolean isSelected​(java.lang.String screenName, java.lang.String trackName)
    Check if a particular track is the selected one or not.
    static void selectMusic​(java.lang.String screenName, java.lang.String trackPath)
    Selects a new background music and persists the choice

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • getAllMusicByScreen

      public static java.lang.String[] getAllMusicByScreen​(java.lang.String screenName)
      Fetch all music paths for a particular screen
      Parameters:
      screenName - name of screen
      Returns:
      music paths array, empty if no associated music

    • containsScreenMusic

      public static boolean containsScreenMusic​(java.lang.String screenName)
      Checks if a particular screen has associated background music
      Parameters:
      screenName - name of the screen
      Returns:
      true if the screen has some background music, false otherwise

    • selectMusic

      public static void selectMusic​(java.lang.String screenName, java.lang.String trackPath)
      Selects a new background music and persists the choice
      Parameters:
      screenName - name of the screen
      trackPath - path of the track

    • getSelectedMusic

      public static java.lang.String getSelectedMusic​(java.lang.String screenName)
      Get selected music track for the supplied screen name
      Parameters:
      screenName - name of screen
      Returns:
      trackPath path of the chosen track, defaults to the first track

    • isSelected

      public static boolean isSelected​(java.lang.String screenName, java.lang.String trackName)
      Check if a particular track is the selected one or not. If it is selected, get its index.
      Parameters:
      screenName - the name of screen
      Returns:
      selected whether the particular track is the user's choice or not

    • getNotSelectedTrack

      public static java.lang.String getNotSelectedTrack​(java.lang.String screenName)
      Get the first non-selected track of a screen
      Parameters:
      screenName - the name of the screen
      Returns:
      nonSelectedTrack track which has not been selected by user