-
Notifications
You must be signed in to change notification settings - Fork 7.1k
/
TWEEN_LOOP_EVENT.js
38 lines (37 loc) · 1.11 KB
/
TWEEN_LOOP_EVENT.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2020 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
/**
* The Tween Loop Event.
*
* This event is dispatched by a Tween when it loops.
*
* This event will only be dispatched if the Tween has a loop count set.
*
* If a Tween has a `loopDelay` set, this event will fire after that delay expires.
*
* The difference between `loop` and `repeat` is that `repeat` is a property setting,
* where-as `loop` applies to the entire Tween.
*
* Listen to it from a Tween instance using `Tween.on('loop', listener)`, i.e.:
*
* ```javascript
* var tween = this.tweens.add({
* targets: image,
* x: 500,
* ease: 'Power1',
* duration: 3000,
* loop: 6
* });
* tween.on('loop', listener);
* ```
*
* @event Phaser.Tweens.Events#TWEEN_LOOP
* @since 3.19.0
*
* @param {Phaser.Tweens.Tween} tween - A reference to the Tween instance that emitted the event.
* @param {any[]} targets - An array of references to the target/s the Tween is operating on.
*/
module.exports = 'loop';