feat(sdk): limit nickname length automatically

Author: CGjupoulton

engine/core/src/main/java/com/codingame/gameengine/core/AbstractPlayer.java

@@ -41,6 +41,21 @@ public final String getNicknameToken() {
         return "$" + this.index;
     }
 
+    /**
+     * Returns a string that will be converted into the real nickname by the viewer.
+     * 
+     * @param maxLength the maximum amount of characters of the nickname to display.
+     * If it is longer, an ellipsis will be appended ("...")
+     * 
+     * @return the player's nickname token.
+     */
+    public final String getNicknameToken(int maxLength) {
+        if (maxLength <= 0) {
+            throw new IllegalArgumentException("Invalid width: " + maxLength);
+        }
+        return "$" + this.index + "ε" + maxLength;
+    }
+
     /**
      * Returns a string that will be converted into the real avatar by the viewer, if it exists.
      * 

engine/modules/entities/src/main/resources/view/entity-module/properties.js

@@ -99,13 +99,21 @@ export const PROPERTIES = {
     ...stringOpts,
     convert (value, globalData) {
       value = unescape(value)
-      const regexp = /\$(\d)/g
+      const regexp = /\$(\d)(?:ε(\d+))?/g
       let match = regexp.exec(value)
       let res = ''
       let prevIdx = 0
       while (match) {
         res += value.substring(prevIdx, match.index)
-        res += globalData.players[+match[1]].name
+        let name = globalData.players[+match[1]].name
+
+        if (match[2] != null) {
+          const maxChars = +match[2]
+          if (name.length > maxChars) {
+            name = name.substring(0, maxChars) + '...'
+          }
+        }
+        res += name
         prevIdx = match.index + match[0].length
         match = regexp.exec(value)
       }

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

@@ -4,6 +4,10 @@ The CodinGame SDK is regularly updated and improved. This document lets you know
 
 ## Next Release
 
+### 🎁 Features
+
+- It is now possible to limit the number of characters display given by `getNicknameToken`.
+
 ### 🐞 Bug fix
 
 - Fixed an issue where games with a `stepByStepAnimateSpeed` would sometimes try to animate frame 0, causing a black screen.