-
Notifications
You must be signed in to change notification settings - Fork 7.1k
/
BEFORE_REMOVE_EVENT.js
29 lines (27 loc) · 1021 Bytes
/
BEFORE_REMOVE_EVENT.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
/**
* @author Richard Davey <rich@phaser.io>
* @copyright 2013-2024 Phaser Studio Inc.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
/**
* @typedef {object} Phaser.Physics.Matter.Events.BeforeRemoveEvent
*
* @property {any[]} object - An array of the object(s) to be removed. May be a single body, constraint, composite or a mixture of these.
* @property {any} source - The source object of the event.
* @property {string} name - The name of the event.
*/
/**
* The Matter Physics Before Remove Event.
*
* This event is dispatched by a Matter Physics World instance at the start of the process when a
* Body or Constraint is being removed from the world.
*
* Listen to it from a Scene using: `this.matter.world.on('beforeremove', listener)`.
*
* @event Phaser.Physics.Matter.Events#BEFORE_REMOVE
* @type {string}
* @since 3.22.0
*
* @param {Phaser.Physics.Matter.Events.BeforeRemoveEvent} event - The Remove Event object.
*/
module.exports = 'beforeremove';