Merge branch '5246-sdk-spritesheetloader-should-be-spritesheetsplitter' into 'master'

[FIX][SDK] Renamed SpriteSheetLoader to SpriteSheetSplitter

See merge request codingame/game-engine!154

Author: Julien Poulton

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

@@ -32,7 +32,7 @@ public class GraphicEntityModule implements Module {
 
     static int ENTITY_COUNT = 0;
 
-    private List<SpriteSheetLoader> newSpriteSheets;
+    private List<SpriteSheetSplitter> newSpriteSheetSplitters;
     private List<Entity<?>> newEntities;
     private List<Entity<?>> entities;
     private Map<String, WorldState> worldStates;
@@ -42,15 +42,15 @@ public class GraphicEntityModule implements Module {
 
     private GameManager<AbstractPlayer> gameManager;
     @Inject private Serializer gameSerializer;
-    @Inject private Provider<SpriteSheetLoader> spriteSheetProvider;
+    @Inject private Provider<SpriteSheetSplitter> spriteSheetProvider;
 
     @Inject
     GraphicEntityModule(GameManager<AbstractPlayer> gameManager) {
         this.gameManager = gameManager;
         world = new World();
         entities = new ArrayList<>();
         newEntities = new ArrayList<>();
-        newSpriteSheets = new ArrayList<>();
+        newSpriteSheetSplitters = new ArrayList<>();
         lockWorld = false;
         worldStates = new HashMap<>();
         currentWorldState = new WorldState("0");
@@ -89,16 +89,16 @@ public World getWorld() {
         return world;
     }
 
-    void loadSpriteSheet(SpriteSheetLoader spritesheet) {
-        newSpriteSheets.add(spritesheet);
+    void loadSpriteSheetSplitter(SpriteSheetSplitter spritesheetsplitter) {
+        newSpriteSheetSplitters.add(spritesheetsplitter);
     }
 
     /**
-     * Create a spritesheet loader.
+     * Create a spritesheet splitter.
      * 
-     * @return a SpriteSheetLoader
+     * @return a SpriteSheetSplitter
      */
-    public SpriteSheetLoader createSpriteSheetLoader() {
+    public SpriteSheetSplitter createSpriteSheetSplitter() {
         return spriteSheetProvider.get();
     }
 
@@ -177,8 +177,8 @@ private void sendFrameData() {
 
         autocommit();
 
-        Optional<String> load = gameSerializer.serializeLoadSpriteSheets(newSpriteSheets);
-        newSpriteSheets.clear();
+        Optional<String> load = gameSerializer.serializeLoadSpriteSheets(newSpriteSheetSplitters);
+        newSpriteSheetSplitters.clear();
 
         Optional<String> create = gameSerializer.serializeCreateEntities(newEntities);
         newEntities.clear();

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

@@ -206,15 +206,15 @@ public Optional<String> serializeCreateEntities(List<Entity<?>> entities) {
         }
     }
 
-    private String serializeLoadSpriteSheet(SpriteSheetLoader spriteSheet) {
+    private String serializeLoadSpriteSheet(SpriteSheetSplitter spriteSheet) {
         return join(
             spriteSheet.getName(), spriteSheet.getSourceImage(),
             spriteSheet.getWidth(), spriteSheet.getHeight(), spriteSheet.getOrigRow(), spriteSheet.getOrigCol(), spriteSheet.getImageCount(),
             spriteSheet.getImagesPerRow()
         );
     }
 
-    public Optional<String> serializeLoadSpriteSheets(List<SpriteSheetLoader> spriteSheets) {
+    public Optional<String> serializeLoadSpriteSheets(List<SpriteSheetSplitter> spriteSheets) {
         if (spriteSheets.isEmpty()) {
             return Optional.empty();
         } else {

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

@@ -4,7 +4,7 @@
 
 import com.google.inject.Inject;
 
-public class SpriteSheetLoader {
+public class SpriteSheetSplitter {
     private String name;
     private String sourceImage;
     private Integer width;
@@ -17,7 +17,7 @@ public class SpriteSheetLoader {
     private final GraphicEntityModule graphicEntityModule;
 
     @Inject
-    public SpriteSheetLoader(GraphicEntityModule graphicEntityModule) {
+    public SpriteSheetSplitter(GraphicEntityModule graphicEntityModule) {
         this.graphicEntityModule = graphicEntityModule;
     }
 
@@ -53,51 +53,51 @@ public int getImagesPerRow() {
         return imagesPerRow;
     }
 
-    public SpriteSheetLoader setName(String name) {
+    public SpriteSheetSplitter setName(String name) {
         this.name = name;
         return this;
     }
 
-    public SpriteSheetLoader setSourceImage(String sourceImage) {
+    public SpriteSheetSplitter setSourceImage(String sourceImage) {
         this.sourceImage = sourceImage;
         return this;
     }
 
-    public SpriteSheetLoader setWidth(int width) {
+    public SpriteSheetSplitter setWidth(int width) {
         this.width = width;
         return this;
     }
 
-    public SpriteSheetLoader setHeight(int height) {
+    public SpriteSheetSplitter setHeight(int height) {
         this.height = height;
         return this;
     }
 
-    public SpriteSheetLoader setOrigRow(int origRow) {
+    public SpriteSheetSplitter setOrigRow(int origRow) {
         this.origRow = origRow;
         return this;
     }
 
-    public SpriteSheetLoader setOrigCol(int origCol) {
+    public SpriteSheetSplitter setOrigCol(int origCol) {
         this.origCol = origCol;
         return this;
     }
 
-    public SpriteSheetLoader setImageCount(int imageCount) {
+    public SpriteSheetSplitter setImageCount(int imageCount) {
         this.imageCount = imageCount;
         return this;
     }
 
-    public SpriteSheetLoader setImagesPerRow(int imagesPerRow) {
+    public SpriteSheetSplitter setImagesPerRow(int imagesPerRow) {
         this.imagesPerRow = imagesPerRow;
         return this;
     }
 
     /**
-     * Load a spritesheet (all fields are required except imagesPerRow). Returns an array of image names that can be used in Sprite or SpriteAnimation.
+     * Splits up a spritesheet (all fields are required except imagesPerRow). Returns an array of image names that can be used in Sprite or SpriteAnimation.
      * @return an array of image names.
      */
-    public String[] load() {
+    public String[] split() {
         if (name == null) {
             throw new IllegalStateException("invalid name");
         }
@@ -120,7 +120,7 @@ public String[] load() {
             throw new IllegalStateException("invalid origCol");
         }
 
-        graphicEntityModule.loadSpriteSheet(this);
+        graphicEntityModule.loadSpriteSheetSplitter(this);
         if (imageCount > 1) {
             return IntStream.range(0, imageCount).mapToObj(i -> name + i).toArray(String[]::new);
         } else {

playground/graphics/graphics-4-spritesheets.md

@@ -2,7 +2,7 @@
 
 The Graphic Entity Module can cut and handle spritesheets. There are two ways of doing that.
 
-## Using the SpriteSheetLoader
+## Using the SpriteSheetSplitter
 
 This is the easiest way to create a set of sprites from a spritesheet. This solution is good for prototyping but it is performance costly.
 
@@ -16,7 +16,7 @@ For this example, we will use this spritesheet (taken from our [free to use asse
 - We want to use all the images starting from the top left corner, so the `OrigRow` and `OrigCol` must be set to 0
 
 ```java
-String[] seaweedSprites = graphicEntityModule.createSpriteSheetLoader()
+String[] seaweedSprites = graphicEntityModule.createSpriteSheetSplitter()
     .setSourceImage("spritesheet.png")
     .setImageCount(12)
     .setWidth(128)

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

@@ -12,9 +12,10 @@ The CodinGame SDK is regularly updated and improved. This document lets you know
 
 ### Bug fixes
 
+- 💥 _Breaking change_ Renamed SpriteSheetLoader to SpriteSheetSplitter.
 - Subfolders of the assets folder work on Windows now.
 - Frame zero now has a duration of zero.
-- The [SpriteSheetLoader](playground/graphics/graphics-spritesheet#Using the SpriteSheetLoader) doesn't reload the sprite sheet if it's already in the TextureCache.
+- The [SpriteSheetSplitter](playground/graphics/graphics-spritesheet#Using the SpriteSheetSplitter) doesn't reload the sprite sheet if it's already in the TextureCache.
 - The local player now uses the parameters stored in the LocalStorage.
 - Removed the max turn warning, since it's replaced by a limit of alloted time.
 - Better process cleanup.