feat(entities): add TilingSprite

Author: Valentin Vetter

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

@@ -24,7 +24,7 @@ public abstract class Entity<T extends Entity<?>> {
     Mask mask;
 
     static enum Type {
-        CIRCLE, LINE, RECTANGLE, SPRITE, TEXT, BITMAPTEXT, GROUP, BUFFERED_GROUP, SPRITEANIMATION, ROUNDED_RECTANGLE, POLYGON
+        CIRCLE, LINE, RECTANGLE, SPRITE, TEXT, BITMAPTEXT, GROUP, BUFFERED_GROUP, SPRITEANIMATION, ROUNDED_RECTANGLE, POLYGON, TILING_SPRITE
     }
 
     Entity() {

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

@@ -261,7 +261,7 @@ public Rectangle createRectangle() {
         newEntity(c);
         return c;
     }
-    
+
     /**
      * Creates a new RoundedRectangle entity, its graphical counterpart will be created on the frame currently being computed.
      * 
@@ -272,7 +272,7 @@ public RoundedRectangle createRoundedRectangle() {
         newEntity(c);
         return c;
     }
-    
+
     /**
      * Creates a new Polygon entity, its graphical counterpart will be created on the frame currently being computed.
      * 
@@ -360,6 +360,17 @@ public SpriteAnimation createSpriteAnimation() {
         return c;
     }
 
+    /**
+     * Creates a new TilingSprite entity, its graphical counterpart will be created on the frame currently being computed.
+     * 
+     * @return the entity. Modify its properties to animate the graphical counterpart.
+     */
+    public TilingSprite createTilingSprite() {
+        TilingSprite c = new TilingSprite();
+        newEntity(c);
+        return c;
+    }
+
     private void newEntity(Entity<?> e) {
         lockWorld = true;
         entities.add(e);

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

@@ -68,6 +68,10 @@ class Serializer {
         keys.put("points", "ps");
         keys.put("skewX", "kx");
         keys.put("skewY", "ky");
+        keys.put("tileX", "tx");
+        keys.put("tileY", "ty");
+        keys.put("tileScaleX", "tsx");
+        keys.put("tileScaleY", "tsy");
 
         commands = new HashMap<>();
         commands.put("CREATE", "C");
@@ -99,6 +103,7 @@ class Serializer {
         types.put(Type.BITMAPTEXT, "X");
         types.put(Type.SPRITEANIMATION, "A");
         types.put(Type.POLYGON, "P");
+        types.put(Type.TILING_SPRITE, "D");
 
         if (keys.values().stream().distinct().count() != keys.values().size()) {
             throw new RuntimeException("Duplicate keys");

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

@@ -0,0 +1,83 @@
+package com.codingame.gameengine.module.entities;
+
+/**
+ * A TilingSprite is a graphical entity which displays a tiling image. That image must be loaded into the viewer's texture cache, which you can
+ * configure by adding files to the <code>assets</code> folder of your game's project.
+ */
+public class TilingSprite extends SpriteBasedEntity<TilingSprite> {
+
+    private int tileX, tileY;
+    private double tileScaleX = 1, tileScaleY = 1;
+
+    @Override
+    Entity.Type getType() {
+        return Entity.Type.TILING_SPRITE;
+    }
+
+    public TilingSprite setTileX(int tileX) {
+        return setTileX(tileX, null);
+    }
+
+    public TilingSprite setTileX(int tileX, Curve curve) {
+        this.tileX = tileX;
+        set("tileX", tileX, curve);
+        return this;
+    }
+
+    public TilingSprite setTileY(int tileY) {
+        return setTileY(tileY, null);
+    }
+
+    public TilingSprite setTileY(int tileY, Curve curve) {
+        this.tileY = tileY;
+        set("tileY", tileY, curve);
+        return this;
+    }
+
+    public TilingSprite setTileScale(double tileScale) {
+        return setTileScale(tileScale, null);
+    }
+
+    public TilingSprite setTileScale(double tileScale, Curve curve) {
+        setTileScaleX(tileScale, curve);
+        setTileScaleY(tileScale, curve);
+        return this;
+    }
+
+    public TilingSprite setTileScaleX(double tileScaleX) {
+        return setTileScaleX(tileScaleX, null);
+    }
+
+    public TilingSprite setTileScaleX(double tileScaleX, Curve curve) {
+        this.tileScaleX = tileScaleX;
+        set("tileScaleX", tileScaleX, curve);
+        return this;
+    }
+
+    public TilingSprite setTileScaleY(double tileScaleY) {
+        return setTileScaleY(tileScaleY, null);
+    }
+
+    public TilingSprite setTileScaleY(double tileScaleY, Curve curve) {
+        this.tileScaleY = tileScaleY;
+        set("tileScaleY", tileScaleY, curve);
+        return this;
+    }
+
+    public int getTileX() {
+        return tileX;
+    }
+
+    public int getTileY() {
+        return tileY;
+    }
+
+    public double getTileScaleX() {
+        return tileScaleX;
+    }
+
+    public double getTileScaleY() {
+        return tileScaleY;
+    }
+
+}

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

@@ -43,7 +43,11 @@ const PROPERTY_KEY_MAP = {
   d: 'duration',
   bw: 'baseWidth',
   bh: 'baseHeight',
-  ps: 'points'
+  ps: 'points',
+  tx: 'tileX',
+  ty: 'tileY',
+  tsx: 'tileScaleX',
+  tsy: 'tileScaleY'
 }
 
 export class CreateCommand {

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

@@ -9,6 +9,7 @@ import { BufferedGroup } from './BufferedGroup.js'
 import { SpriteAnimation } from './SpriteAnimation.js'
 import { RoundedRectangle } from './RoundedRectangle.js';
 import { Polygon } from './Polygon.js';
+import { TilingSprite } from './TilingSprite.js';
 
 export class EntityFactory {
   static create (type) {
@@ -23,7 +24,8 @@ export class EntityFactory {
       B: BufferedGroup,
       A: SpriteAnimation,
       K: RoundedRectangle,
-      P: Polygon
+      P: Polygon,
+      D: TilingSprite
     }[type]
     if (!EntityClass) {
       throw new Error('Exception: entity type not found: ' + type)

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

@@ -0,0 +1,29 @@
+import { SpriteBasedEntity } from './SpriteBasedEntity.js'
+
+/* global PIXI */
+
+export class TilingSprite extends SpriteBasedEntity {
+  constructor () {
+    super()
+    Object.assign(this.defaultState, {
+      tileX: 0,
+      tileY: 0,
+      tileScaleX: 1,
+      tileScaleY: 1
+    })
+  }
+
+  initDisplay () {
+    super.initDisplay()
+    this.graphics = new PIXI.extras.TilingSprite(PIXI.Texture.EMPTY)
+  }
+
+  updateDisplay (state, changed, globalData) {
+    super.updateDisplay(state, changed, globalData)
+    
+    this.graphics.tilePosition.x = state.tileX
+    this.graphics.tilePosition.y = state.tileY
+    this.graphics.tileScale.x = state.tileScaleX
+    this.graphics.tileScale.y = state.tileScaleY
+  }
+}