phaser
Version:
A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers from the team at Phaser Studio Inc.
29 lines (26 loc) • 876 B
JavaScript
/**
* @author Richard Davey <rich@phaser.io>
* @copyright 2013-2025 Phaser Studio Inc.
* @license {@link https://opensource.org/licenses/MIT|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
* @type {string}
* @since 3.0.0
*
* @param {Phaser.Physics.Matter.Events.SleepStartEvent} event - The Sleep Event object.
* @param {MatterJS.BodyType} body - The body that has gone to sleep.
*/
module.exports = 'sleepstart';