Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added onStart parameter to FlxTween #1273

Merged
merged 6 commits into from
Aug 20, 2014
Merged

Added onStart parameter to FlxTween #1273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8c101a9
Initial addition of onStart
anissen Aug 15, 2014
2ede022
Change indentation to tabs to conform to style guide
anissen Aug 15, 2014
b649836
Merge branch 'dev' into feature-tween-onstart
anissen Aug 17, 2014
a070d70
Corrected outdated documentation
anissen Aug 17, 2014
d50dcce
Updated change log
anissen Aug 17, 2014
0a06efc
Added an onUpdate callback function to FlxTween
anissen Aug 18, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,9 @@
* FlxPool:
* Fixed a bug with point / rect pooling that could lead to them being recycled when they shouldn't be
* improved pooling performance
* FlxTween
* `complete` callback parameter in `options` is now called `onComplete`. Its type, `CompleteCallback`, is now called `TweenCallback`.
* Added `onStart` and `onUpdate` callback parameters in `options`

3.3.5
------------------------------
Expand Down
4 changes: 2 additions & 2 deletions flixel/system/FlxSplash.hx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ class FlxSplash extends FlxState
if (_curPart == 5)
{
// Make the logo a tad bit longer, so our users fully appreciate our hard work :D
FlxTween.tween(_sprite, { alpha: 0 }, 3.0, { ease: FlxEase.quadOut, complete: onComplete } );
FlxTween.tween(_sprite, { alpha: 0 }, 3.0, { ease: FlxEase.quadOut, onComplete: onComplete } );
FlxTween.tween(_text, { alpha: 0 }, 3.0, { ease: FlxEase.quadOut } );
}
}
Expand Down Expand Up @@ -194,4 +194,4 @@ class FlxSplash extends FlxState
FlxG.switchState(Type.createInstance(nextState, []));
FlxG.game._gameJustStarted = true;
}
}
}
99 changes: 70 additions & 29 deletions flixel/tweens/FlxTween.hx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,16 @@ class FlxTween implements IFlxDestroyable

/**
* Tweens numeric public properties of an Object. Shorthand for creating a VarTween, starting it and adding it to the TweenManager.
* Example: FlxTween.tween(Object, { x: 500, y: 350 }, 2.0, { ease: easeFunction, complete: onComplete, type: FlxTween.ONESHOT });
* Example: FlxTween.tween(Object, { x: 500, y: 350 }, 2.0, { ease: easeFunction, onStart: onStart, onUpdate: onUpdate, onComplete: onComplete, type: FlxTween.ONESHOT });
*
* @param Object The object containing the properties to tween.
* @param Values An object containing key/value pairs of properties and target values.
* @param Duration Duration of the tween in seconds.
* @param Options An object containing key/value pairs of the following optional parameters:
* type Tween type.
* complete Optional completion callback function.
* onStart Optional start callback function.
* onUpdate Optional update callback function.
* onComplete Optional completion callback function.
* ease Optional easer function.
* startDelay Seconds to wait until starting this tween, 0 by default.
* loopDelay Seconds to wait between loops of this tween, 0 by default.
Expand All @@ -74,14 +76,16 @@ class FlxTween implements IFlxDestroyable
*
* Example:
* private function tweenFunction(s:FlxSprite, v:Float) { s.alpha = v; }
* FlxTween.num(1, 0, 2.0, { ease: easeFunction, complete: onComplete, type: FlxTween.ONESHOT }, tweenFunction.bind(mySprite));
* FlxTween.num(1, 0, 2.0, { ease: easeFunction, onStart: onStart, onUpdate: onUpdate, onComplete: onComplete, type: FlxTween.ONESHOT }, tweenFunction.bind(mySprite));
*
* @param FromValue Start value.
* @param ToValue End value.
* @param Duration Duration of the tween.
* @param Options An object containing key/value pairs of the following optional parameters:
* type Tween type.
* complete Optional completion callback function.
* onStart Optional start callback function.
* onUpdate Optional update callback function.
* onComplete Optional completion callback function.
* ease Optional easer function.
* startDelay Seconds to wait until starting this tween, 0 by default.
* loopDelay Seconds to wait between loops of this tween, 0 by default.
Expand All @@ -98,15 +102,17 @@ class FlxTween implements IFlxDestroyable

/**
* Tweens numeric value which represents angle. Shorthand for creating a AngleTween object, starting it and adding it to the TweenManager.
* Example: FlxTween.angle(Sprite, -90, 90, 2.0, { ease: easeFunction, complete: onComplete, type: FlxTween.ONESHOT });
* Example: FlxTween.angle(Sprite, -90, 90, 2.0, { ease: easeFunction, onStart: onStart, onUpdate: onUpdate, onComplete: onComplete, type: FlxTween.ONESHOT });
*
* @param Sprite Optional Sprite whose angle should be tweened.
* @param FromAngle Start angle.
* @param ToAngle End angle.
* @param Duration Duration of the tween.
* @param Options An object containing key/value pairs of the following optional parameters:
* type Tween type.
* complete Optional completion callback function.
* onStart Optional start callback function.
* onUpdate Optional update callback function.
* onComplete Optional completion callback function.
* ease Optional easer function.
* startDelay Seconds to wait until starting this tween, 0 by default.
* loopDelay Seconds to wait between loops of this tween, 0 by default.
Expand All @@ -121,17 +127,17 @@ class FlxTween implements IFlxDestroyable

/**
* Tweens numeric value which represents color. Shorthand for creating a ColorTween object, starting it and adding it to a TweenPlugin.
* Example: FlxTween.color(Sprite, 2.0, 0x000000, 0xffffff, 0.0, 1.0, { ease: easeFunction, complete: onComplete, type: FlxTween.ONESHOT });
* Example: FlxTween.color(Sprite, 2.0, 0x000000, 0xffffff, 0.0, 1.0, { ease: easeFunction, onStart: onStart, onUpdate: onUpdate, onComplete: onComplete, type: FlxTween.ONESHOT });
*
* @param Sprite Optional Sprite whose color should be tweened.
* @param Duration Duration of the tween in seconds.
* @param FromColor Start color.
* @param ToColor End color.
* @param FromAlpha Start alpha.
* @param ToAlpha End alpha.
* @param Options An object containing key/value pairs of the following optional parameters:
* type Tween type.
* complete Optional completion callback function.
* onStart Optional start callback function.
* onUpdate Optional update callback function.
* onComplete Optional completion callback function.
* ease Optional easer function.
* startDelay Seconds to wait until starting this tween, 0 by default.
* loopDelay Seconds to wait between loops of this tween, 0 by default.
Expand All @@ -146,7 +152,7 @@ class FlxTween implements IFlxDestroyable

/**
* Create a new LinearMotion tween.
* Example: FlxTween.linearMotion(Object, 0, 0, 500, 20, 5, false, { ease: easeFunction, complete: onComplete, type: FlxTween.ONESHOT });
* Example: FlxTween.linearMotion(Object, 0, 0, 500, 20, 5, false, { ease: easeFunction, onStart: onStart, onUpdate: onUpdate, onComplete: onComplete, type: FlxTween.ONESHOT });
*
* @param Object The object to move (FlxObject or FlxSpriteGroup)
* @param FromX X start.
Expand All @@ -157,7 +163,9 @@ class FlxTween implements IFlxDestroyable
* @param UseDuration Whether to use the previous param as duration or speed.
* @param Options An object containing key/value pairs of the following optional parameters:
* type Tween type.
* complete Optional completion callback function.
* onStart Optional start callback function.
* onUpdate Optional update callback function.
* onComplete Optional completion callback function.
* ease Optional easer function.
* startDelay Seconds to wait until starting this tween, 0 by default.
* loopDelay Seconds to wait between loops of this tween, 0 by default.
Expand All @@ -173,7 +181,7 @@ class FlxTween implements IFlxDestroyable

/**
* Create a new QuadMotion tween.
* Example: FlxTween.quadMotion(Object, 0, 100, 300, 500, 100, 2, 5, false, { ease: easeFunction, complete: onComplete, type: FlxTween.ONESHOT });
* Example: FlxTween.quadMotion(Object, 0, 100, 300, 500, 100, 2, 5, false, { ease: easeFunction, onStart: onStart, onUpdate: onUpdate, onComplete: onComplete, type: FlxTween.ONESHOT });
*
* @param Object The object to move (FlxObject or FlxSpriteGroup)
* @param FromX X start.
Expand All @@ -186,7 +194,9 @@ class FlxTween implements IFlxDestroyable
* @param UseDuration Whether to use the previous param as duration or speed.
* @param Options An object containing key/value pairs of the following optional parameters:
* type Tween type.
* complete Optional completion callback function.
* onStart Optional start callback function.
* onUpdate Optional update callback function.
* onComplete Optional completion callback function.
* ease Optional easer function.
* startDelay Seconds to wait until starting this tween, 0 by default.
* loopDelay Seconds to wait between loops of this tween, 0 by default.
Expand All @@ -202,7 +212,7 @@ class FlxTween implements IFlxDestroyable

/**
* Create a new CubicMotion tween.
* Example: FlxTween.cubicMotion(_sprite, 0, 0, 500, 100, 400, 200, 100, 100, 2, { ease: easeFunction, complete: onComplete, type: FlxTween.ONESHOT });
* Example: FlxTween.cubicMotion(_sprite, 0, 0, 500, 100, 400, 200, 100, 100, 2, { ease: easeFunction, onStart: onStart, onUpdate: onUpdate, onComplete: onComplete, type: FlxTween.ONESHOT });
*
* @param Object The object to move (FlxObject or FlxSpriteGroup)
* @param FromX X start.
Expand All @@ -216,7 +226,9 @@ class FlxTween implements IFlxDestroyable
* @param Duration Duration of the movement in seconds.
* @param Options An object containing key/value pairs of the following optional parameters:
* type Tween type.
* complete Optional completion callback function.
* onStart Optional start callback function.
* onUpdate Optional update callback function.
* onComplete Optional completion callback function.
* ease Optional easer function.
* startDelay Seconds to wait until starting this tween, 0 by default.
* loopDelay Seconds to wait between loops of this tween, 0 by default.
Expand All @@ -232,7 +244,7 @@ class FlxTween implements IFlxDestroyable

/**
* Create a new CircularMotion tween.
* Example: FlxTween.circularMotion(Object, 250, 250, 50, 0, true, 2, true { ease: easeFunction, complete: onComplete, type: FlxTween.ONESHOT });
* Example: FlxTween.circularMotion(Object, 250, 250, 50, 0, true, 2, true { ease: easeFunction, onStart: onStart, onUpdate: onUpdate, onComplete: onComplete, type: FlxTween.ONESHOT });
*
* @param Object The object to move (FlxObject or FlxSpriteGroup)
* @param CenterX X position of the circle's center.
Expand All @@ -245,7 +257,8 @@ class FlxTween implements IFlxDestroyable
* @param Eease Optional easer function.
* @param Options An object containing key/value pairs of the following optional parameters:
* type Tween type.
* complete Optional completion callback function.
* onStart Optional start callback function.
* onComplete Optional completion callback function.
* ease Optional easer function.
* startDelay Seconds to wait until starting this tween, 0 by default.
* loopDelay Seconds to wait between loops of this tween, 0 by default.
Expand All @@ -261,15 +274,16 @@ class FlxTween implements IFlxDestroyable

/**
* Create a new LinearPath tween.
* Example: FlxTween.linearPath(Object, [FlxPoint.get(0, 0), FlxPoint.get(100, 100)], 2, true, { ease: easeFunction, complete: onComplete, type: FlxTween.ONESHOT });
* Example: FlxTween.linearPath(Object, [FlxPoint.get(0, 0), FlxPoint.get(100, 100)], 2, true, { ease: easeFunction, onStart: onStart, onUpdate: onUpdate, onComplete: onComplete, type: FlxTween.ONESHOT });
*
* @param Object The object to move (FlxObject or FlxSpriteGroup)
* @param Points An array of at least 2 FlxPoints defining the path
* @param DurationOrSpeed Duration (in seconds) or speed of the movement.
* @param UseDuration Whether to use the previous param as duration or speed.
* @param Options An object containing key/value pairs of the following optional parameters:
* type Tween type.
* complete Optional completion callback function.
* onStart Optional start callback function.
* onComplete Optional completion callback function.
* ease Optional easer function.
* startDelay Seconds to wait until starting this tween, 0 by default.
* loopDelay Seconds to wait between loops of this tween, 0 by default.
Expand All @@ -294,15 +308,16 @@ class FlxTween implements IFlxDestroyable

/**
* Create a new QuadPath tween.
* Example: FlxTween.quadPath(Object, [FlxPoint.get(0, 0), FlxPoint.get(200, 200), FlxPoint.get(400, 0)], 2, true, { ease: easeFunction, complete: onComplete, type: FlxTween.ONESHOT });
* Example: FlxTween.quadPath(Object, [FlxPoint.get(0, 0), FlxPoint.get(200, 200), FlxPoint.get(400, 0)], 2, true, { ease: easeFunction, onStart: onStart, onUpdate: onUpdate, onComplete: onComplete, type: FlxTween.ONESHOT });
*
* @param Object The object to move (FlxObject or FlxSpriteGroup)
* @param Points An array of at least 3 FlxPoints defining the path
* @param DurationOrSpeed Duration (in seconds) or speed of the movement.
* @param UseDuration Whether to use the previous param as duration or speed.
* @param Options An object containing key/value pairs of the following optional parameters:
* type Tween type.
* complete Optional completion callback function.
* onStart Optional start callback function.
* onComplete Optional completion callback function.
* ease Optional easer function.
* startDelay Seconds to wait until starting this tween, 0 by default.
* loopDelay Seconds to wait between loops of this tween, 0 by default.
Expand All @@ -328,7 +343,9 @@ class FlxTween implements IFlxDestroyable
public var active:Bool = false;
public var duration:Float = 0;
public var ease:EaseFunction;
public var complete:CompleteCallback;
public var onStart:TweenCallback;
public var onUpdate:TweenCallback;
public var onComplete:TweenCallback;

public var type(default, set):Int;
public var percent(get, set):Float;
Expand All @@ -354,6 +371,7 @@ class FlxTween implements IFlxDestroyable

private var _secondsSinceStart:Float = 0;
private var _delayToUse:Float = 0;
private var _running:Bool = false;

/**
* This function is called when tween is created, or recycled.
Expand All @@ -363,7 +381,9 @@ class FlxTween implements IFlxDestroyable
Options = resolveTweenOptions(Options);

type = Options.type;
complete = Options.complete;
onStart = Options.onStart;
onUpdate = Options.onUpdate;
onComplete = Options.onComplete;
ease = Options.ease;
setDelays(Options.startDelay, Options.loopDelay);
}
Expand All @@ -381,14 +401,20 @@ class FlxTween implements IFlxDestroyable

public function destroy():Void
{
complete = null;
onStart = null;
onUpdate = null;
onComplete = null;
ease = null;
}

private function update():Void
{
_secondsSinceStart += FlxG.elapsed;
var delay:Float = (executions > 0) ? loopDelay : startDelay;
if (_secondsSinceStart < delay)
{
return;
}
scale = Math.max((_secondsSinceStart - delay), 0) / duration;
if (ease != null)
{
Expand All @@ -398,10 +424,19 @@ class FlxTween implements IFlxDestroyable
{
scale = 1 - scale;
}
if (_secondsSinceStart > delay && _running == false) {
_running = true;
if (onStart != null)
onStart(this);
}
if (_secondsSinceStart >= duration + delay)
{
scale = (backward) ? 0 : 1;
finished = true;
} else
{
if (onUpdate != null)
onUpdate(this);
}
}

Expand All @@ -418,6 +453,7 @@ class FlxTween implements IFlxDestroyable
return this;
}
active = true;
_running = false;
finished = false;
return this;
}
Expand All @@ -429,6 +465,7 @@ class FlxTween implements IFlxDestroyable
public function cancel():Void
{
active = false;
_running = false;
finished = true;
manager.remove(this);
}
Expand All @@ -437,18 +474,20 @@ class FlxTween implements IFlxDestroyable
{
executions++;

if (complete != null)
complete(this);
if (onComplete != null)
onComplete(this);

switch (type & ~ FlxTween.BACKWARD)
{
case FlxTween.PERSIST:
_secondsSinceStart = duration + startDelay;
active = false;
_running = false;
finished = true;

case FlxTween.ONESHOT:
active = false;
_running = false;
finished = true;
_secondsSinceStart = duration + startDelay;
manager.remove(this);
Expand Down Expand Up @@ -539,12 +578,14 @@ class FlxTween implements IFlxDestroyable
}
}

typedef CompleteCallback = FlxTween->Void;
typedef TweenCallback = FlxTween->Void;

typedef TweenOptions = {
?type:Null<Int>,
?ease:EaseFunction,
?complete:CompleteCallback,
?onStart:TweenCallback,
?onUpdate:TweenCallback,
?onComplete:TweenCallback,
?startDelay:Null<Float>,
?loopDelay:Null<Float>,
}
Expand Down
8 changes: 4 additions & 4 deletions flixel/util/FlxSpriteUtil.hx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -644,13 +644,13 @@ class FlxSpriteUtil
* @param Duration How long the fade will take (in seconds).
* @return The FlxSprite for chaining
*/
public static inline function fadeIn(sprite:FlxSprite, Duration:Float = 1, ?ResetAlpha:Bool, ?OnComplete:CompleteCallback):FlxSprite
public static inline function fadeIn(sprite:FlxSprite, Duration:Float = 1, ?ResetAlpha:Bool, ?OnComplete:TweenCallback):FlxSprite
{
if (ResetAlpha)
{
sprite.alpha = 0;
}
FlxTween.num(sprite.alpha, 1, Duration, { complete: OnComplete }, alphaTween.bind(sprite));
FlxTween.num(sprite.alpha, 1, Duration, { onComplete: OnComplete }, alphaTween.bind(sprite));
return sprite;
}

Expand All @@ -661,9 +661,9 @@ class FlxSpriteUtil
* @param Duration How long the fade will take (in seconds).
* @return The FlxSprite for chaining
*/
public static inline function fadeOut(sprite:FlxSprite, Duration:Float = 1, ?OnComplete:CompleteCallback):FlxSprite
public static inline function fadeOut(sprite:FlxSprite, Duration:Float = 1, ?OnComplete:TweenCallback):FlxSprite
{
FlxTween.num(sprite.alpha, 0, Duration, { complete: OnComplete }, alphaTween.bind(sprite));
FlxTween.num(sprite.alpha, 0, Duration, { onComplete: OnComplete }, alphaTween.bind(sprite));
return sprite;
}

Expand Down