Score History Display

Score History

This feature is player can view their top ten history scores with each corresponding game time. We cooperate with team 7 "the score save, write to JSON and read from JSON". The wiki about GameRecord is here:
https://github.com/UQdeco2800/2021-ext-studio-2/wiki/Game-Records

The History Score Board

Flow diagram illustration

1. This is our old code flow diagram. At that time, we didn't realize our functionality is duplicate to Team 7 feature. We created UserHistoryScore.java similar to GameRecord.java. We save scores when gameover, write to JSON, read from JSON.
   

2. This is final flow diagram. The GameRecord.java is the core class.
   

The GameRecord.java class diagram and sequence diagram can be found here. https://github.com/UQdeco2800/2021-ext-studio-2/wiki/Game-Records

How to go to that screen

There are two paths to go there.

1. From the MainMenuScreen

    historyScoreBtn.addListener(new ChangeListener() {
        @Override
        public void changed(ChangeEvent event, Actor actor) {
            logger.debug("History Score clicked");
            entity.getEvents().trigger("displayHistoryScores");
        }
    });

2. From GameOverScreen

        historyScoreButton.addListener(
                new ChangeListener() {
                    @Override
                    public void changed(ChangeEvent changeEvent, Actor actor) {
                        logger.info("go to history score board button clicked");
                        game.setScreen(GdxGame.ScreenType.HISTORY_SCORES);
                    }
                });

How to get Score data from JSON file

        //prepare the score data.
        //The Score class contains actual score value and the date that the the score was played.
        List<GameRecords.Score> pastScores = GameRecords.getHighestScores();

This is a list of Score object. Score object has datetime and score as variables. I can access them by:

1. Get the score

int scoreRecord = score.getScore();

2.Get the date and time:

//The LocalDateTime is this format: 2021-09-13T20:22:55.527317800
//split"T" then get the date. split"." get the time (hour and min only) using substring
String dateText = String.valueOf(score.getDateTime()).split("T")[0]
    + "  " + String.valueOf(score.getDateTime()).split("T")[1].split("\\.")[0]
        .substring(0,5);

##How to display them on the board First, we create two tables: one is for the bg image and the other one is for the board image. These two tables are added to stage first otherwise they will cover all the other records. (Their z index should be smallest) How to display the records in the board is the trickiest part. We have tried to position using labels but failed. So we locate each record of score, datetime using tables. Each small value is a table. First, I get the list of Score object. Use loop to store score & dateTime into two lists. And loop the two lists.

At the bottom of that long for loop. When padBottomValue is less than -430 then the loop will break. The first toppest score value padBottonValue is 270. ANd each line has a height of 70. So if the board capacity is 10 lines. Then 270 - 10 x 70 = -430. This allows the board only display the top ten scores.
Here is the code

    /**
     * Use tables, labels, images and buttons to create the board.
     */
    private void createHistoryScoreBoard() {
        // Create components on the score board
        TextButton mainMenuButton = new TextButton("Main Menu", skin);
        mainMenuButton.addListener(
                new ChangeListener() {
                    @Override
                    public void changed(ChangeEvent changeEvent, Actor actor) {
                        logger.info("return menu button clicked");
                        game.setScreen(GdxGame.ScreenType.MAIN_MENU);
                    }
                });

        //add the bg image table and scoreboard to stage first.

        //this table contains the board
        boardTable = new Table();
        boardTable.center();
        boardTable.setFillParent(true);

        //this table contains the button back to main menu
        buttonTable = new Table();
        buttonTable.bottom().right();
        buttonTable.padBottom(35f).padRight(52f);
        buttonTable.setFillParent(true);

        board = new Image(ServiceLocator.getResourceService()
                .getAsset("images/historyScoreBoard.png", Texture.class));

        float boardSideLength = 850f;
        boardTable.add(board).size(boardSideLength);
        buttonTable.add(mainMenuButton);

        //this table contains the bg image: the night city
        Image bgImage = new Image(ServiceLocator.getResourceService()
                .getAsset("images/historyScoreBg.png", Texture.class));
        bgTable = new Table();
        bgTable.setFillParent(true);
        bgTable.add(bgImage);


        // add the board to the stage first so that its can be under of score data
        stage.addActor(bgTable);
        stage.addActor(boardTable);
        stage.addActor(buttonTable);

        //prepare the data tables
        List<Table> scoreTablesList = new ArrayList<>();
        List<Table> dateTablesList = new ArrayList<>();
        float padBottomValue = 270;

        //prepare the score data.
        //The Score class contains actual score value and the date that the the score was played.
        List<GameRecords.Score> pastScores = GameRecords.getHighestScores();

        //loop this list to create labels.
        for (GameRecords.Score score : pastScores) {

            //score
            Table scoreDataTable = new Table();
            scoreDataTable.center();
            scoreDataTable.padBottom(padBottomValue).padLeft(300);
            scoreDataTable.setFillParent(true);
            Label scoreLabel = new Label(score.getScore()+"", skin, "large");
            scoreDataTable.add(scoreLabel);

            //date
            Table dateDataTable = new Table();
            dateDataTable.center();
            dateDataTable.padBottom(padBottomValue).padRight(300);
            dateDataTable.setFillParent(true);
            //The LocalDateTime is this format: 2021-09-13T20:22:55.527317800
            //split"T" then get the date. split"." get the time (hour and min only) using substring
            String dateText = String.valueOf(score.getDateTime()).split("T")[0]
                    + "  " + String.valueOf(score.getDateTime()).split("T")[1].split("\\.")[0]
                    .substring(0,5);

            Label dateLabel =
                    new Label(dateText, skin, "large");
            dateDataTable.add(dateLabel);

            //add these two tables to the lists
            scoreTablesList.add(scoreDataTable);
            dateTablesList.add(dateDataTable);

            //now reduce the padding values
            //the history score board only display top 10
            if (padBottomValue < -430) {
                break;
            }
            padBottomValue = padBottomValue - 70;
        }

        for (Table table : scoreTablesList) {
            stage.addActor(table);
        }

        for (Table table : dateTablesList) {
            stage.addActor(table);
        }

        //use another table to display the game count
        Table gameCountTable = new Table();
        gameCountTable.bottom().left().padBottom(50).padLeft(50);
        Label gameCount =
                new Label("Game Count: " + scoreTablesList.size(),
                        new Label.LabelStyle(new BitmapFont(), Color.VIOLET));
        gameCount.setFontScale(2f);
        gameCountTable.add(gameCount);
        stage.addActor(gameCountTable);
    }

How to delete all the records on the board

It is very simple. Go to C drive and in the User folder. There is a DECO2800Game folder. Delete the GameRecord.json.