phaser/src/physics/matter-js/events/SLEEP_START_EVENT.js

27 lines
867 B
JavaScript
Raw Normal View History

2019-01-17 15:47:27 +00:00
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2019 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
* @typedef {object} Phaser.Physics.Matter.Events.SleepStartEvent
*
* @property {any} source - The source object of the event.
* @property {string} name - The name of the event.
*/
/**
* The Matter Physics Sleep Start Event.
*
* This event is dispatched by a Matter Physics World instance when a Body goes to sleep.
*
* Listen to it from a Scene using: `this.matter.world.on('sleepstart', listener)`.
*
* @event Phaser.Physics.Matter.Events#SLEEP_START
*
* @param {Phaser.Physics.Matter.Events.SleepStartEvent} event - The Sleep Event object.
* @param {MatterJS.Body} body - The body that has gone to sleep.
*/
module.exports = 'sleepstart';