Merge branch '5210-sdk-adding-the-text-align-property-to-textbasedentity' into 'master'

feature(TextBasedEntity): add textAlign property

See merge request codingame/game-engine!259

Author: CodinGameCommunity

engine/modules/entities/src/main/java/com/codingame/gameengine/module/entities/BitmapText.java

@@ -31,16 +31,16 @@ public String getFont() {
      * Only fonts available to the browser can be displayed.
      * 
      * 
-     * @param fontFamily
+     * @param font
      *            the size for the font of this <code>BitmapText</code>.
      * @return this <code>BitmapText</code>.
      * @exception NullPointerException
-     *                if fontFamily is null.
+     *                if font is null.
      */
-    public BitmapText setFont(String fontFamily) {
-        Objects.requireNonNull(fontFamily);
-        this.font = fontFamily;
-        set("fontFamily", fontFamily, null);
+    public BitmapText setFont(String font) {
+        Objects.requireNonNull(font);
+        this.font = font;
+        set("fontFamily", font, null);
         return this;
     }
 

engine/modules/entities/src/main/java/com/codingame/gameengine/module/entities/Serializer.java

@@ -50,6 +50,7 @@ class Serializer {
         keys.put("fontSize", "s");
         keys.put("fontWeight", "fw");
         keys.put("text", "T");
+        keys.put("textAlign", "ta");
         keys.put("children", "ch");
         keys.put("scaleX", "sx");
         keys.put("scaleY", "sy");

engine/modules/entities/src/main/java/com/codingame/gameengine/module/entities/TextBasedEntity.java

@@ -6,8 +6,36 @@
  * @param <T> a subclass inheriting TextureBasedEntity, used in order to return <b>this</b> as a T instead of a <code>TextBasedEntity</code>.
  */
 public abstract class TextBasedEntity<T extends TextureBasedEntity<?>> extends TextureBasedEntity<T> {
+    /**
+     * This is an enumeration that contains the three options for text alignment: left, center, and right.
+     */
+    public static enum TextAlign {
+        /**
+         * Align text left
+         */
+        LEFT(0),
+        /**
+         * Align text center
+         */
+        CENTER(1),
+        /**
+         * Align text right
+         */
+        RIGHT(2);
+
+        private int value;
+
+        private TextAlign(int value) {
+            this.value = value;
+        }
+
+        private int getValue() {
+            return value;
+        }
+    }
     protected String text = "";
     protected int fontSize = 26;
+    protected TextAlign textAlign;
 
     /**
      * Returns the string this <code>TextBasedEntity</code> displays.
@@ -36,6 +64,33 @@ public T setText(String text) {
         set("text", text, null);
         return self();
     }
+    /**
+     * Returns text alignment of this <code>TextBasedEntity</code>.
+     * <p>
+     * Default is TextAlign.LEFT (align left).
+     * 
+     * @return the text alignment of this <code>TextBasedEntity</code>.
+     */
+    public TextAlign getTextAlign() {
+        return textAlign;
+    }
+    
+
+    /**
+     * Sets the text alignment of this <code>TextBasedEntity</code>.
+     * 
+     * @param align
+     *            the text alignment of this <code>TextBasedEntity</code>.
+     * @return this <code>Text</code>.
+     * @exception NullPointerException
+     *                if align is null.
+     */
+    public T setTextAlign(TextAlign align) {
+        Objects.requireNonNull(align);
+        this.textAlign = align;
+        set("textAlign", align.getValue(), null);
+        return self();
+    }
 
     /**
      * Returns the size of the font of this <code>TextBasedEntity</code> in px.

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

@@ -10,6 +10,7 @@ export class BitmapText extends Entity {
     super()
     Object.assign(this.defaultState, {
       text: '',
+      textAlign: 'left',
       fontSize: 26,
       fontFamily: null,
       anchorX: TextureBasedEntity.defaultAnchor(),
@@ -41,6 +42,7 @@ export class BitmapText extends Entity {
         this.displayed.anchor.set(state.anchorX, state.anchorY)
         this.displayed.blendMode = state.blendMode
         this.displayed.tint = state.tint
+        this.displayed.align = state.textAlign
       } else {
         if (!this.missingFonts[state.fontFamily]) {
           this.missingFonts[state.fontFamily] = true

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

@@ -26,6 +26,7 @@ const PROPERTY_KEY_MAP = {
   s: 'fontSize',
   fw: 'fontWeight',
   T: 'text',
+  ta: 'textAlign',
   ch: 'children',
   sx: 'scaleX',
   sy: 'scaleY',

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

@@ -7,6 +7,7 @@ export class Text extends TextureBasedEntity {
     super()
     Object.assign(this.defaultState, {
       text: '',
+      textAlign: 'left',
       strokeColor: 0,
       strokeThickness: 0,
       fillColor: 0,
@@ -20,6 +21,7 @@ export class Text extends TextureBasedEntity {
     super.initDisplay()
 
     this.graphics = new PIXI.Text(this.defaultState.text, {
+      align: this.defaultState.textAlign,
       fontSize: this.defaultState.fontSize + 'px',
       fontFamily: this.defaultState.fontFamily,
       fill: this.defaultState.fillColor
@@ -29,6 +31,7 @@ export class Text extends TextureBasedEntity {
   updateDisplay (state, changed, globalData) {
     super.updateDisplay(state, changed, globalData)
     this.graphics.text = state.text
+    this.graphics.style.align = state.textAlign
     this.graphics.style.stroke = state.strokeColor
     this.graphics.style.strokeThickness = globalData.atLeastOnePixel(state.strokeThickness)
     this.graphics.style.fill = state.fillColor

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

@@ -113,6 +113,16 @@ export const PROPERTIES = {
       return res
     }
   },
+  textAlign: {
+    ...stringOpts,
+    convert: (value) => (
+      {
+        0: 'left',
+        1: 'center',
+        2: 'right'
+      }[value]
+    )
+  },
   fontFamily: stringOpts,
   fontWeight: stringOpts,
   children: {

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
+
+- Added text-align property to TextBasedEntity
+
 ### 🐞 Bug fix
 
 - Changed CSS of statement preview to match the codingame IDE