Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-25 22:20:44 +00:00
Code Issues Projects Releases Packages Wiki Activity

Cleanup and added loop callback to Time.Timeline

Browse source
This commit is contained in:
Robert Kowalski 2024-02-14 10:21:06 -05:00
parent 878d3d2211
commit b9a7b3ed33
3 changed files with 64 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

75
src/time/Timeline.js
View file

@ -79,7 +79,7 @@ var Events = require('./events');
*
* The Timeline can also be looped with the repeat method:
* ```js
* timeline.repeat(2).play();
* timeline.repeat().play();
* ```
*
* There are lots of options available to you via the configuration object. See the
@ -156,8 +156,8 @@ var Timeline = new Class({
*
* A Timeline is considered complete when all of its events have been run.
*
* If you wish to restart a Timeline after it has completed, you can do so
* by calling the `Timeline.restart` method.
* If you wish to reset a Timeline after it has completed, you can do so
* by calling the `Timeline.reset` method.
*
* You can also use the `Timeline.stop` method to stop a running Timeline,
* at any point, without resetting it.
@ -185,7 +185,7 @@ var Timeline = new Class({
/**
* The number of times this timeline should loop.
*
* This value is decremented each loop.
* If this value is -1 or any negative number this Timeline will not stop.
*
* @name Phaser.Time.Timeline#loop
* @type {number}
@ -193,6 +193,17 @@ var Timeline = new Class({
*/
this.loop = 0;
/**
* The number of times this Timeline has looped.
*
* This value is incremented each loop if looping is enabled.
*
* @name Phaser.Time.Timeline#iteration
* @type {number}
* @since 3.80.0
*/
this.iteration = 0;
/**
* An array of all the Timeline Events.
*
@ -245,6 +256,8 @@ var Timeline = new Class({
* If the `TimelineEvent.event` property is set then the Timeline emits that event.
*
* If the `TimelineEvent.run` property is set then the Timeline invokes that method.
*
* If the `TimelineEvent.loop` property is set then the Timeline invokes that method when repeated.
*
* If the `TimelineEvent.target` property is set then the Timeline invokes the `run` method on that target.
*
@ -329,10 +342,20 @@ var Timeline = new Class({
event.run.call(target);
}
if (event.loop && event.repeat)
{
event.loop.call(target);
}
if (event.stop)
{
this.stop();
}
if (this.iteration)
{
event.repeat++;
}
}
}
@ -352,16 +375,11 @@ var Timeline = new Class({
// It may be greater than the length if events have been removed
if (this.totalComplete >= events.length)
{
if (this.loop !== 0)
if (this.loop !== 0 && (this.loop === -1 || this.loop > this.iteration))
{
if (this.loop > 0)
{
this.loop--;
}
this.iteration++;
// This combination resets the timeline
this.resume();
this.play();
this.reset(true);
}
else
{
@ -432,14 +450,18 @@ var Timeline = new Class({
/**
* Repeats this Timeline.
*
* A positive number will be repeated that amount which is decremented each repeat.
* If the value for `amount` is positive, the Timeline will repeat that many additional times.
* For example a value of 1 will actually run this Timeline twice.
*
* Depending on the value given, `false` is 0 and `true`, undefined and negative numbers are infinite.
*
* If this Timeline had any events set to `once` that have already been removed,
* they will **not** be repeated each loop.
*
* @method Phaser.Time.Timeline#repeat
* @since 3.80.0
*
* @param {Number|Boolean} [amount=-1] - Amount of times to repeat, if `true` or negative it will be infinite.
* @param {number|boolean} [amount=-1] - Amount of times to repeat, if `true` or negative it will be infinite.
*
* @return {this} This Timeline instance.
*/
@ -505,16 +527,30 @@ var Timeline = new Class({
*
* @method Phaser.Time.Timeline#reset
* @since 3.60.0
*
*
* @param {boolean} [loop=false] - Set to true if you do not want to reset the loop counters.
*
* @return {this} This Timeline instance.
*/
reset: function ()
reset: function (loop)
{
if (loop === undefined) { loop = false; }
this.elapsed = 0;
if (!loop)
{
this.iteration = 0;
}
for (var i = 0; i < this.events.length; i++)
{
this.events[i].complete = false;
if (!loop)
{
this.events[i].repeat = 0;
}
}
return this.play(false);
@ -582,8 +618,10 @@ var Timeline = new Class({
events.push({
complete: false,
time: startTime,
repeat: 0,
if: GetFastValue(entry, 'if', null),
run: GetFastValue(entry, 'run', null),
loop: GetFastValue(entry, 'loop', null),
event: GetFastValue(entry, 'event', null),
target: GetFastValue(entry, 'target', null),
set: GetFastValue(entry, 'set', null),
@ -750,6 +788,11 @@ var Timeline = new Class({
* timeline.play();
* ```
*
* The Timeline can also be looped with the repeat method:
* ```js
* timeline.repeat().play();
* ```
*
* There are lots of options available to you via the configuration object. See the
* {@link Phaser.Types.Time.TimelineEventConfig} typedef for more details.
*

2
src/time/typedefs/TimelineEvent.js
View file

@ -5,8 +5,10 @@
* @property {boolean} complete - Has this event completed yet?
* @property {boolean} once - Is this a once only event?
* @property {number} time - The time (in elapsed ms) at which this event will fire.
* @property {function} [repeat=0] - The amount of times this Event has repeated.
* @property {function} [if=null] - User-land callback which will be called if set. If it returns `true` then this event run all of its actions, otherwise it will be skipped.
* @property {function} [run=null] - User-land callback which will be called when the Event fires.
* @property {function} [loop=null] - User-land callback which will be called when the Event loops.
* @property {Phaser.Types.Tweens.TweenBuilderConfig|Phaser.Types.Tweens.TweenChainBuilderConfig|Phaser.Tweens.Tween|Phaser.Tweens.TweenChain} [tween=null] - Tween configuration object which will be used to create a Tween when the Event fires if set.
* @property {object} [set=null] - Object containing properties to set on the `target` when the Event fires if set.
* @property {string|object} [sound=null] - Sound configuration object which will be used to create a Sound when the Event fires if set.

5
src/time/typedefs/TimelineEventConfig.js
View file

@ -3,9 +3,10 @@
* @since 3.60.0
*
* @property {number} [at=0] - The time (in ms) at which the Event will fire. The Timeline starts at 0.
* @property {number} [in] - If the Timeline is already running, this is the time (in ms) at which the Event will fire based on its current elapsed value. If set, overrides the `at` property.
* @property {number} [from] - Fire this event 'from' milliseconds after the previous event in the Timeline. If set it overrides the `at` and `in` properties.
* @property {number} [in] - If the Timeline is running, this is the time (in ms) at which the Event will fire based on its current elapsed value. If set it will override the `at` property.
* @property {number} [from] - Fire this event 'from' milliseconds after the previous event in the Timeline. If set it will override the `at` and `in` properties.
* @property {function} [run] - A function which will be called when the Event fires.
* @property {function} [loop] - A function which will be called when the Event loops, this does not get called if the `repeat` method is not used or on first iteration.
* @property {string} [event] - Optional string-based event name to emit when the Event fires. The event is emitted from the Timeline instance.
* @property {*} [target] - The scope (`this` object) with which to invoke the run `callback`, if set.
* @property {boolean} [once=false] - If set, the Event will be removed from the Timeline when it fires.