Adding new Tween events

Author: photonstorm

src/tweens/events/TWEEN_ACTIVE_EVENT.js

@@ -0,0 +1,29 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The Tween Active Event.
+ * 
+ * This event is dispatched by a Tween when it becomes active within the Tween Manager.
+ * 
+ * Listen to it from a Tween instance using `Tween.on('active', listener)`, i.e.:
+ * 
+ * ```javascript
+ * var tween = this.tweens.add({
+ *     targets: image,
+ *     ease: 'Power1',
+ *     duration: 3000,
+ *     tweens: [ { x: 600 }, { y: 500 }, { x: 100 }, { y: 100 } ]
+ * });
+ * tween.on('active', listener);
+ * ```
+ *
+ * @event Phaser.Tweens.Events#TWEEN_ACTIVE
+ * @since 3.19.0
+ * 
+ * @param {Phaser.Tweens.Tween} tween - A reference to the Tween instance that emitted the event.
+ */
+module.exports = 'active';

src/tweens/events/TWEEN_COMPLETE_EVENT.js

@@ -0,0 +1,29 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The Tween Complete Event.
+ * 
+ * This event is dispatched by a Tween when it completes playback.
+ * 
+ * Listen to it from a Tween instance using `Tween.on('complete', listener)`, i.e.:
+ * 
+ * ```javascript
+ * var tween = this.tweens.add({
+ *     targets: image,
+ *     ease: 'Power1',
+ *     duration: 3000,
+ *     tweens: [ { x: 600 }, { y: 500 }, { x: 100 }, { y: 100 } ]
+ * });
+ * tween.on('complete', listener);
+ * ```
+ *
+ * @event Phaser.Tweens.Events#TWEEN_COMPLETE
+ * @since 3.19.0
+ * 
+ * @param {Phaser.Tweens.Tween} tween - A reference to the Tween instance that emitted the event.
+ */
+module.exports = 'complete';

src/tweens/events/TWEEN_START_EVENT.js

@@ -0,0 +1,29 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The Tween Start Event.
+ * 
+ * This event is dispatched by a Tween when it starts playback.
+ * 
+ * Listen to it from a Tween instance using `Tween.on('start', listener)`, i.e.:
+ * 
+ * ```javascript
+ * var tween = this.tweens.add({
+ *     targets: image,
+ *     ease: 'Power1',
+ *     duration: 3000,
+ *     tweens: [ { x: 600 }, { y: 500 }, { x: 100 }, { y: 100 } ]
+ * });
+ * tween.on('start', listener);
+ * ```
+ *
+ * @event Phaser.Tweens.Events#TWEEN_START
+ * @since 3.19.0
+ * 
+ * @param {Phaser.Tweens.Tween} tween - A reference to the Tween instance that emitted the event.
+ */
+module.exports = 'start';

src/tweens/events/index.js

@@ -15,6 +15,9 @@ module.exports = {
     TIMELINE_PAUSE: require('./TIMELINE_PAUSE_EVENT'),
     TIMELINE_RESUME: require('./TIMELINE_RESUME_EVENT'),
     TIMELINE_START: require('./TIMELINE_START_EVENT'),
-    TIMELINE_UPDATE: require('./TIMELINE_UPDATE_EVENT')
+    TIMELINE_UPDATE: require('./TIMELINE_UPDATE_EVENT'),
+    TWEEN_ACTIVE: require('./TWEEN_ACTIVE_EVENT'),
+    TWEEN_COMPLETE: require('./TWEEN_COMPLETE_EVENT'),
+    TWEEN_START: require('./TWEEN_START_EVENT')
 
 };