TimedAnimation : add comments about usage of begin()

1 files changed, 4 insertions, 1 deletions

diff --git a/core/src/ch/asynk/gdx/boardgame/animations/TimedAnimation.java b/core/src/ch/asynk/gdx/boardgame/animations/TimedAnimation.java
index 04b84fd..5a22c2b 100644
--- a/core/src/ch/asynk/gdx/boardgame/animations/TimedAnimation.java
+++ b/core/src/ch/asynk/gdx/boardgame/animations/TimedAnimation.java
@@ -6,6 +6,9 @@ public abstract class TimedAnimation implements Animation
     protected float percent;
     protected float elapsed;
 
+    // begin() may be called after the first call to draw()
+    // only use it to capture variables when the animation starts
+    // not to setup the Animation, do that it the Animation initialisation
     abstract protected void begin();
     abstract protected void end();
     abstract protected void update(float delta);
@@ -28,7 +31,7 @@ public abstract class TimedAnimation implements Animation
 
     @Override public boolean animate(float delta)
     {
-        if (percent == 0) {
+        if (elapsed == 0f) {
             begin();
         }