Merge branch 'doc-sdk-commit-world' into 'master'

[SDK]doc(sdk): update javadoc for commitWorldState

See merge request codingame/game-engine!243

Author: CodinGameCommunity

engine/core/src/main/java/com/codingame/gameengine/core/RefereeMain.java

@@ -19,7 +19,7 @@ public class RefereeMain {
     private static boolean inProduction = false;
 
     /**
-     * Is overriden by CodinGame's server side game runner 
+     * Is overridden by CodinGame's server side game runner 
      * @return whether or not this execution is happening locally or on CodinGame
      */
     public static boolean isInProduction() {
@@ -30,10 +30,8 @@ public static boolean isInProduction() {
      * CodinGame's game runner will launch the referee using this method.
      * 
      * @param args unused
-     * @throws InstantiationException
-     * @throws IllegalAccessException
      */
-    public static void main(String[] args) throws InstantiationException, IllegalAccessException {
+    public static void main(String[] args) {
         inProduction = true;
         InputStream in = System.in;
         PrintStream out = System.out;

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

@@ -20,13 +20,13 @@
  * <p>
  * The GraphicEntityModule takes care of displaying and animating graphical entities on the replay of the game.
  * </p>
- * Use it by creating shapes, sprites, texts etc, then commiting their states to a certain moment of the frame. By default, the states are commited
+ * Use it by creating shapes, sprites, texts etc, then committing their states to a certain moment of the frame. By default, the states are commited
  * automatically at the end of the frame.
  */
 @Singleton
 public class GraphicEntityModule implements Module {
 
-    //TODO: extra properties for Texts (text wrapping, alignement, ...)
+    //TODO: extra properties for Texts (text wrapping, alignment, ...)
 
     static int ENTITY_COUNT = 0;
 
@@ -103,8 +103,16 @@ public SpriteSheetSplitter createSpriteSheetSplitter() {
     }
 
     /**
-     * Every entity's graphical counterpart, at instant t of the frame being computed, will have the same properties as the java object as they are
-     * now.
+     * <p>
+     * Creates a commit for each entity that has had some of its properties modified since a previous commit or the previous frame.
+     * </p>
+     * <p>
+     * This means that each one of those entities' graphical counterparts, at instant t of the frame being computed, will have the same properties as
+     * the java object as they are now.
+     * </p>
+     * <p>
+     * To force an entity to keep its current state instead of interpolating to the values of next frame, use <code>commitEntityState</code> instead.
+     * </p>
      * <p>
      * Only the most recent commits are kept for a given t.
      * </p>
@@ -188,13 +196,9 @@ private void sendFrameData() {
             .map(Entry::getValue)
             .collect(Collectors.toList());
 
-        List<String> worldCommitsBuilder = new ArrayList<>();
         List<WorldState> updateBuilder = new ArrayList<>();
 
         for (WorldState nextWorldState : orderedStates) {
-            if (nextWorldState.isWorldCommit()) {
-                worldCommitsBuilder.add(nextWorldState.getFrameTime());
-            }
             WorldState worldStateDiff = nextWorldState.diffFromOtherWorldState(currentWorldState);
             updateBuilder.add(worldStateDiff);
             currentWorldState.updateAllEntities(nextWorldState);

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

@@ -5,7 +5,7 @@
 import com.google.inject.Inject;
 
 /**
- * Utility to load an image containg serveral subimages displayed in sequential rectangles.
+ * Utility to load an image containing several subimages displayed in sequential rectangles.
  * <p>
  * Will extract each separate image and return generated names that can be used to create a <code>Sprite</code> or <code>SpriteAnimation</code>
  * </p>