From 59186e034fb7903dfd839990d5ef264a49aa2a05 Mon Sep 17 00:00:00 2001
From: Michael Bayne <mdb@threerings.net>
Date: Tue, 9 Oct 2007 07:30:35 +0000
Subject: [PATCH] Added onStart function; cleaned up start().

git-svn-id: svn+ssh://src.earth.threerings.net/nenya/trunk@301 ed5b42cb-e716-0410-a449-f6a68f950b19
---
 src/as/com/threerings/flash/path/Path.as | 41 +++++++++++++++++-------
 1 file changed, 30 insertions(+), 11 deletions(-)

diff --git a/src/as/com/threerings/flash/path/Path.as b/src/as/com/threerings/flash/path/Path.as
index b0e8651b..ad2f755d 100644
--- a/src/as/com/threerings/flash/path/Path.as
+++ b/src/as/com/threerings/flash/path/Path.as
@@ -55,26 +55,41 @@ public /*abstract*/ class Path
      * Starts this path. The path will be ticked once immediately and subsequently ticked every
      * frame.
      *
-     * @param onComplete an optional function to be called when it completes (or is aborted). The
-     * function should have the following signature: function onComplete (path :Path) :void
+     * @param onComplete an optional function to be called when it completes (or is aborted).
      * @param startOffset an optional number of milliseconds by which to adjust the time at which
      * the path believes that it was started.
      */
-    public function start (onComplete :Function = null, startOffset :int = 0) :void
+    public function start () :void
     {
-        _onComplete = onComplete;
         _target.addEventListener(Event.ENTER_FRAME, onEnterFrame);
-        willStart(getTimer(), startOffset);
+        willStart(getTimer(), 0);
     }
 
     /**
-     * Configures this path's onComplete function. This should generally only be called shortly
-     * after construction as the function will not be called if the path is already completed or
-     * aborted.
+     * Configures this path's onStart function. The function should have the following signature:
+     * <code>function (path :Path) :void</code>. This should only be called before the path is
+     * started.
+     *
+     * @return a reference to this path, for easy chaining.
      */
-    public function setOnComplete (onComplete :Function) :void
+    public function setOnStart (onStart :Function) :Path
+    {
+        _onStart = onStart;
+        return this;
+    }
+
+    /**
+     * Configures this path's onComplete function. The function should have the following
+     * signature: <code>function (path :Path) :void</code>. This should generally only be called
+     * shortly after construction as the function will not be called if the path is already
+     * completed or aborted.
+     *
+     * @return a reference to this path, for easy chaining.
+     */
+    public function setOnComplete (onComplete :Function) :Path
     {
         _onComplete = onComplete;
+        return this;
     }
 
     /**
@@ -119,6 +134,9 @@ public /*abstract*/ class Path
     protected function willStart (now :int, startOffset :int = 0) :int
     {
         _startStamp = now + startOffset;
+        if (_onStart != null) {
+            _onStart(this);
+        }
         return tick(now);
     }
 
@@ -160,16 +178,17 @@ public /*abstract*/ class Path
     // needed by CompositePath
     protected static function tickPath (path :Path, curStamp :int) :int
     {
-        return (path == null) ? 0 : path.tick(curStamp);
+        return path.tick(curStamp);
     }
 
     // needed by CompositePath
     protected static function startPath (path :Path, curStamp :int, startOffset :int) :int
     {
-        return (path == null) ? 0 : path.willStart(curStamp, startOffset);
+        return path.willStart(curStamp, startOffset);
     }
 
     protected var _target :DisplayObject;
+    protected var _onStart :Function;
     protected var _onComplete :Function;
     protected var _startStamp :int = -1;
     protected var _wasAborted :Boolean;