Skip to content

Commit b74c3e8

Browse files
committed
doc(sdk): update javadoc for commitWorldState
1 parent 648deba commit b74c3e8

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

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

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,16 @@ public SpriteSheetSplitter createSpriteSheetSplitter() {
103103
}
104104

105105
/**
106-
* 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
107-
* now.
106+
* <p>
107+
* Creates a commit for each entity that has had some of its properties modified since a previous commit or the previous frame.
108+
* </p>
109+
* <p>
110+
* This means that each one of those entities' graphical counterparts, at instant t of the frame being computed, will have the same properties as
111+
* the java object as they are now.
112+
* </p>
113+
* <p>
114+
* To force an entity to keep its current state instead of interpolating to the values of next frame, use <code>commitEntityState</code> instead.
115+
* </p>
108116
* <p>
109117
* Only the most recent commits are kept for a given t.
110118
* </p>

0 commit comments

Comments
 (0)