phaser
Version:
A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers.
35 lines (33 loc) • 1.01 kB
JavaScript
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2020 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 tweening its first property.
*
* A Tween will only emit this event once, as it can only start once.
*
* If a Tween has a `delay` set, this event will fire after that delay expires.
*
* Listen to it from a Tween instance using `Tween.on('start', listener)`, i.e.:
*
* ```javascript
* var tween = this.tweens.add({
* targets: image,
* x: 500,
* ease: 'Power1',
* duration: 3000
* });
* 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.
* @param {any[]} targets - An array of references to the target/s the Tween is operating on.
*/
module.exports = 'start';