Description

The integration of background music chooser GUI into code involves making a music icon which will be shown on each screen. Clicking on the music icon will open a dialog containing two radio buttons with background music names. The choice of the user will be persisted in local storage. The user should also be given an option to disable background music for a particular screen.

API Reference

BackgroundMusic.java: Location

Function	Returns	Description
getAllMusicByScreen(String screenName)	String[]	Fetch all music paths for a particular screen,empty if no associated music.
containsScreenMusic(String screenName)	Boolean	Checks if a particular screen has associated background music.Returns true if the screen has some background music, false otherwise
selectMusic(String screenName, String trackPath)	void	Selects a new background music and persists the choice in a JSON file stored in the 'DECO2800' folder in external location. The file's name is 'backgroundMusic.json' which contains a mapping of screen name and chosen track.
getSelectedMusic(String screenName)	String	Get selected music track for the supplied screen name, defaults to the first choice that is provided in backgroundMusic.json
isSelected(String screenName, String trackName)	Boolean	Check if a particular track is the selected one or not. If it is selected,return true and false otherwise.
getNotSelectedTrack(String screenName)	String	Get the first non-selected track of a screen, if any.

Implementation

Fetching the selected music for a particular screen

The music is fetched for a particular screen when its entity is registered.

On selecting music, persist the choice of user

Usage: A simple method call specifying the screen name and selected track path

BackgroundMusic.selectMusic(screenName, trackPath);
// Example
BackgroundMusic.selectMusic("MainGame", "sounds/customBgm/game1.mp3");

Persisting the choice of the user: Stores choice as a mapping of screen name (key) and track name (value).

    /**
     * Selects a new background music and persists the choice
     *
     * @param screenName name of the screen
     * @param trackPath  path of the track
     */
    public static void selectMusic(String screenName, String trackPath) {
        Map<String, String> chosenMusic = getAllChosenMusic();
        chosenMusic.put(screenName, trackPath);
        setChosenMusic(chosenMusic);
    }

Fetching the choice of the user(which defaults to the first track if nothing was selected):

    /**
     * Get selected music track for the supplied screen name, defaults to
     * the first choice that is provided in backgroundMusic.json
     *
     * @param screenName name of screen
     * @return trackPath path of the chosen track, defaults to the first track
     */
    public static String getSelectedMusic(String screenName) {
        String defaultTrack = "";
        if (containsScreenMusic(screenName)) {
            defaultTrack = getAllMusicByScreen(screenName)[0];
        }
        return getAllChosenMusic().getOrDefault(screenName, defaultTrack);
    }

Fetching track choices for a particular screen

Track choices for all screens are fetched through assets/configs/backgroundMusic.json which can be found here.

    /**
     * Fetch the mapping of screen name and associated background music paths
     *
     * @return music mapping of screen name and music paths
     */
    private static Map<String, String[]> getAllMusic() {
        MusicList musicList =
                FileLoader.readClass(MusicList.class, "configs/backgroundMusic.json");
        if (musicList == null) {
            musicList = new MusicList();
        }
        return musicList.music;
    }