Merge branch '5376-sdkmodule-adding-options-to-replace-the-text-of-the-score-by-a-string' into 'master'

[SDK][endscreen] adding options to display a custom text instead of the score

See merge request codingame/game-engine!175

Author: Julien Poulton

engine/modules/endscreen/src/main/java/com/codingame/gameengine/module/endscreen/EndScreenModule.java

@@ -15,6 +15,7 @@ public class EndScreenModule implements Module {
 
     private GameManager<AbstractPlayer> gameManager;
     private int[] scores;
+    private String[] displayedText;
     private String titleRankingsSprite = "logo.png";
 
     @Inject
@@ -33,6 +34,20 @@ public void setScores(int[] scores) {
         this.scores = scores;
     }
 
+    /**
+     * Send scores to the module
+     * 
+     * @param scores
+     *            the scores of the different players, the index matches the player.getIndex()
+     * @param displayedText
+     *            the text displayed instead of the score of a player, if null or empty string for a player the score will still be displayed
+     *
+     */
+    public void setScores(int[] scores, String[] displayedText) {
+        this.scores = scores;
+        this.displayedText = displayedText;
+    }
+
     /**
      * Allows you to set the sprite used as the title of the ranking board
      * 
@@ -61,7 +76,7 @@ public final void onAfterGameTurn() {
 
     @Override
     public final void onAfterOnEnd() {
-        Object[] data = { scores, titleRankingsSprite };
+        Object[] data = { scores, titleRankingsSprite, displayedText };
         gameManager.setViewData("endScreen", data);
     }
 

engine/modules/endscreen/src/main/resources/view/endscreen-module/EndScreenModule.js

@@ -28,21 +28,27 @@ export class EndScreenModule {
   handleFrameData (frameInfo, data) {
     let scores = null
     let spriteName = null
+    let displayedText = null
     if (data) {
       scores = data[0]
       spriteName = data[1]
+      displayedText = data[2]
     }
     const state = {
       number: frameInfo.number,
       scores,
-      spriteName
+      spriteName,
+      displayedText
     }
     if (scores) {
       this.scores = scores
     }
     if (spriteName) {
       this.spriteName = spriteName
     }
+    if (displayedText) {
+      this.displayedText = displayedText
+    }
     this.states.push(state)
     return state
   }
@@ -176,7 +182,9 @@ export class EndScreenModule {
     avatarContainer.addChild(hudAvatar)
 
     var name = this.generateText(finisher.player.name.toUpperCase(), 50, 'left', finisher.player.color)
-    var scoreLabel = this.generateText(((finisher.score >= 0) ? finisher.score.toString() + ' points' : '-'), 64, 'left', finisher.player.color)
+
+    const scoreText = finisher.text || ((finisher.score >= 0) ? finisher.score.toString() + ' points' : '-')
+    var scoreLabel = this.generateText(scoreText, 64, 'left', finisher.player.color)
 
     name.x = 330
     name.y = -4
@@ -218,6 +226,7 @@ export class EndScreenModule {
     for (var i = 0; i < this.globalData.playerCount; ++i) {
       podium.push({
         score: this.scores[i],
+        text: (this.displayedText) ? this.displayedText[i] : null,
         player: this.globalData.players[i],
         rank: 0
       })

playground/extensions/extensions-4-endscreen.md

@@ -33,11 +33,24 @@ To guarantee the correct ranking, you must set this module's score property in y
 ```java
   @Override
   public void onEnd() {
-      endScreenModule.setScores(gameManager.getPlayers().stream().mapToInt(p -> p.getScore()).toArray());
+    endScreenModule.setScores(gameManager.getPlayers().stream().mapToInt(p -> p.getScore()).toArray());
   }
 ```
 
 The module loads by default your `logo.png` as title, you can set your own image with `setTitleRankingsSprite()`.
 ```java
   endScreenModule.setTitleRankingsSprite("myCustomSprite.png");
 ```
+
+You can also display a custom text instead of the score.
+
+`Referee.java`
+```java
+  @Override
+  public void onEnd() {
+    int[] scores = { player1.getScore(), player2.getScore() };
+    String[] text = { scores[0] + " mana", scores[1] + " mana" };
+
+    endScreenModule.setScores(scores, text);
+  }
+```

playground/misc/misc-3-release-notes.md

@@ -2,6 +2,12 @@
 
 The CodinGame SDK is regularly updated and improved. This document lets you know what changed in the latest releases.
 
+## Next release
+
+### 🎁 New feature
+
+- The [EndScreenModule](playground/extensions/extensions-4-endscreen.md) allows you to display a custom text instead of the score.
+
 ## 3.2.0
 
 ### 🎁 New features