Phaser API Documentation

  Version: 
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord
Event: SLEEP_START
Phaser.Physics.Matter.Events.SLEEP_START
SLEEP_START

Description:

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).

Parameters:

name type description
event Phaser.Physics.Matter.Events.SleepStartEvent

The Sleep Event object.

body MatterJS.BodyType

The body that has gone to sleep.