Merge branch '5343-sdk-spritesheetsplitter-could-take-the-full-height-or-weigth-if-none-given' into 'master'

feature(spriteSheetSplitter): crop using full height or width of spritesheet if no h/w given

See merge request codingame/game-engine!257

Author: CodinGameCommunity

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

@@ -221,9 +221,8 @@ public Optional<String> serializeCreateEntities(List<Entity<?>> entities) {
 
     private String serializeLoadSpriteSheet(SpriteSheetSplitter spriteSheet) {
         return join(
-            spriteSheet.getName(), spriteSheet.getSourceImage(),
-            spriteSheet.getWidth(), spriteSheet.getHeight(), spriteSheet.getOrigRow(), spriteSheet.getOrigCol(), spriteSheet.getImageCount(),
-            spriteSheet.getImagesPerRow()
+            spriteSheet.getName(), spriteSheet.getSourceImage(), spriteSheet.getWidth(), spriteSheet.getHeight(),
+            spriteSheet.getOrigRow(), spriteSheet.getOrigCol(), spriteSheet.getImageCount(), spriteSheet.getImagesPerRow()
         );
     }
 

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

@@ -14,8 +14,8 @@
 public class SpriteSheetSplitter {
     private String name;
     private String sourceImage;
-    private Integer width;
-    private Integer height;
+    private Integer width = 0; // 0 means take full width of spritesheet
+    private Integer height = 0; // 0 means take full height of spritesheet
     private Integer origRow;
     private Integer origCol;
     private Integer imageCount;
@@ -120,20 +120,28 @@ public SpriteSheetSplitter setSourceImage(String sourceImage) {
 
     /**
      * Sets the width of the subimages to extract
+     * Defaults to full width of spritesheet if not set
      * @param width the width of the subimages
      * @return this <code>SpriteSheetSplitter</code>
      */
     public SpriteSheetSplitter setWidth(int width) {
+        if (width <= 0) {
+            throw new IllegalStateException("invalid width");
+        }
         this.width = width;
         return this;
     }
 
     /**
      * Sets the height of the subimages to extract
+     * Defaults to full height of spritesheet if not set
      * @param height the height of the subimages
      * @return this <code>SpriteSheetSplitter</code>
      */
     public SpriteSheetSplitter setHeight(int height) {
+        if (height <= 0) {
+            throw new IllegalStateException("invalid height");
+        }
         this.height = height;
         return this;
     }
@@ -193,12 +201,6 @@ public String[] split() {
         if (sourceImage == null) {
             throw new IllegalStateException("invalid sourceImage");
         }
-        if (width == null || width <= 0) {
-            throw new IllegalStateException("invalid width");
-        }
-        if (height == null || height <= 0) {
-            throw new IllegalStateException("invalid height");
-        }
         if (imageCount == null || imageCount <= 0) {
             throw new IllegalStateException("invalid imageCount");
         }

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

@@ -81,6 +81,13 @@ export class LoadCommand {
   constructor ([assetName, sourceImage, imageWidth, imageHeight, origRow, origCol, imageCount, imagesPerRow], globalData) {
     this.loader = new PIXI.loaders.Loader()
 
+    if (imageWidth === '0') {
+      imageWidth = PIXI.utils.TextureCache[sourceImage].width
+    }
+    if (imageHeight === '0') {
+      imageHeight = PIXI.utils.TextureCache[sourceImage].height
+    }
+
     const _imagesPerRow = imagesPerRow > 0 ? imagesPerRow : imageCount
     const data = {
       frames: {},

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

@@ -7,6 +7,7 @@ The CodinGame SDK is regularly updated and improved. This document lets you know
 ### 🎁 Features
 
 - Added text-align property to TextBasedEntity
+- SpriteSheetSplitter splits using full width and/or height of spritesheet when width and/or height not set.
 
 ### 🐞 Bug fix