phaser/src/gameobjects/events/DESTROY_EVENT.js
2020-01-15 12:07:09 +00:00

19 lines
581 B
JavaScript

/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2020 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
/**
* The Game Object Destroy Event.
*
* This event is dispatched when a Game Object instance is being destroyed.
*
* Listen for it on a Game Object instance using `GameObject.on('destroy', listener)`.
*
* @event Phaser.GameObjects.Events#DESTROY
* @since 3.0.0
*
* @param {Phaser.GameObjects.GameObject} gameObject - The Game Object which is being destroyed.
*/
module.exports = 'destroy';