Merge branch 'tile-sprite' into 'master'

feat(sdk): add `Tilingsprite`

See merge request codingame/game-engine!231

Author: CodinGameCommunity

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() {
@@ -449,29 +449,18 @@ public boolean isVisible() {
         return visible;
     }
 
-    /**
-     * Sets a given <code>Shape</code> as this <code>Entity</code>'s <code>Mask</code>.
-     * 
-     * @param shape
-     *            the mask.
-     * @return this <code>Entity</code>.
-     */
-    public T setMask(Shape<?> shape) {
-        return saveMask(shape);
-    }
-
     /**
      * <p>
-     * Sets a given <code>Sprite</code> as this <code>Entity</code>'s <code>Mask</code>.
+     * Sets a given <code>Mask</code> as this <code>Entity</code>'s <code>Mask</code>.
      * </p>
      * <b>Note:</b> texture masks will only work on browsers which support WebGL
      * 
      * @param sprite
      *            the mask.
      * @return this <code>Entity</code>.
      */
-    public T setMask(Sprite sprite) {
-        return saveMask(sprite);
+    public T setMask(Mask mask) {
+        return saveMask(mask);
     }
 
     /**

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/Sprite.java

@@ -4,92 +4,11 @@
  * A Sprite is a graphical entity which displays an 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 Sprite extends TextureBasedEntity<Sprite> implements Mask {
-
-    private String image;
-    private Integer baseWidth, baseHeight;
-
-    Sprite() {
-        super();
-    }
+public class Sprite extends SpriteBasedEntity<Sprite> {
 
     @Override
     Entity.Type getType() {
         return Entity.Type.SPRITE;
     }
 
-    /**
-     * Sets the image for this <code>Sprite</code>.
-     * <p>
-     * You must either:
-     * <ul>
-     * <li>use the filename of an image relative to the assets folder of the Java project.
-     * <li>use the a player's nickname token.
-     * </ul>
-     * 
-     * @param image
-     *            the name of the image to use for this <code>Sprite</code>.
-     * @return this <code>Sprite</code>.
-     */
-    public Sprite setImage(String image) {
-        this.image = image;
-        set("image", image, null);
-        return this;
-    }
-
-    /**
-     * Sets the image base width for this <code>Sprite</code>. If not set, the image base width is the real image width.
-     * 
-     * @param baseWidth
-     *            image width
-     * @return this <code>Sprite</code>.
-     */
-    public Sprite setBaseWidth(int baseWidth) {
-        this.baseWidth = baseWidth;
-        set("baseWidth", baseWidth, null);
-        return self();
-    }
-
-    /**
-     * Sets the image base height for this <code>Sprite</code>. If not set, the image base height is the real image height.
-     * 
-     * @param baseHeight
-     *            image height
-     * @return this <code>Sprite</code>.
-     */
-    public Sprite setBaseHeight(int baseHeight) {
-        this.baseHeight = baseHeight;
-        set("baseHeight", baseHeight, null);
-        return self();
-    }
-
-    /**
-     * Returns the name of the image used for this <code>Sprite</code>.
-     * <p>
-     * Can be a player's nickname token.
-     * 
-     * @return the name of the image used for this <code>Sprite</code>
-     */
-    public String getImage() {
-        return image;
-    }
-
-    /**
-     * Returns the image base width for this <code>Sprite</code>. If not set, the image base width is the real image width, but this will return null.
-     * 
-     * @return the image base width for this <code>Sprite</code>.
-     */
-    public Integer getBaseWidth() {
-        return baseWidth;
-    }
-
-    /**
-     * Returns the image base height for this <code>Sprite</code>. If not set, the image base height is the real image height, but this will return
-     * null.
-     * 
-     * @return the image base height for this <code>Sprite</code>.
-     */
-    public Integer getBaseHeight() {
-        return baseHeight;
-    }
 }

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

@@ -0,0 +1,87 @@
+package com.codingame.gameengine.module.entities;
+
+/**
+ * A Sprite is a graphical entity which displays an 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 abstract class SpriteBasedEntity<T extends SpriteBasedEntity<?>> extends TextureBasedEntity<T> implements Mask {
+
+    private String image;
+    private Integer baseWidth, baseHeight;
+
+    /**
+     * Sets the image for this <code>Sprite</code>.
+     * <p>
+     * You must either:
+     * <ul>
+     * <li>use the filename of an image relative to the assets folder of the Java project.
+     * <li>use the a player's nickname token.
+     * </ul>
+     * 
+     * @param image
+     *            the name of the image to use for this <code>Sprite</code>.
+     * @return this <code>Sprite</code>.
+     */
+    public T setImage(String image) {
+        this.image = image;
+        set("image", image, null);
+        return self();
+    }
+
+    /**
+     * Sets the image base width for this <code>Sprite</code>. If not set, the image base width is the real image width.
+     * 
+     * @param baseWidth
+     *            image width
+     * @return this <code>Sprite</code>.
+     */
+    public T setBaseWidth(int baseWidth) {
+        this.baseWidth = baseWidth;
+        set("baseWidth", baseWidth, null);
+        return self();
+    }
+
+    /**
+     * Sets the image base height for this <code>Sprite</code>. If not set, the image base height is the real image height.
+     * 
+     * @param baseHeight
+     *            image height
+     * @return this <code>Sprite</code>.
+     */
+    public T setBaseHeight(int baseHeight) {
+        this.baseHeight = baseHeight;
+        set("baseHeight", baseHeight, null);
+        return self();
+    }
+
+    /**
+     * Returns the name of the image used for this <code>Sprite</code>.
+     * <p>
+     * Can be a player's nickname token.
+     * 
+     * @return the name of the image used for this <code>Sprite</code>
+     */
+    public String getImage() {
+        return image;
+    }
+
+    /**
+     * Returns the image base width for this <code>Sprite</code>. If not set, the image base width is the real image width, but this will return null.
+     * 
+     * @return the image base width for this <code>Sprite</code>.
+     */
+    public Integer getBaseWidth() {
+        return baseWidth;
+    }
+
+    /**
+     * Returns the image base height for this <code>Sprite</code>. If not set, the image base height is the real image height, but this will return
+     * null.
+     * 
+     * @return the image base height for this <code>Sprite</code>.
+     */
+    public Integer getBaseHeight() {
+        return baseHeight;
+    }
+
+}