phaser
Version:
A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers.
29 lines (26 loc) • 983 B
JavaScript
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2020 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
/**
* @typedef {object} Phaser.Physics.Matter.Events.BeforeAddEvent
*
* @property {any[]} object - An array of the object(s) to be added. 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 Add Event.
*
* This event is dispatched by a Matter Physics World instance at the start of the process when a new Body
* or Constraint is being added to the world.
*
* Listen to it from a Scene using: `this.matter.world.on('beforeadd', listener)`.
*
* @event Phaser.Physics.Matter.Events#BEFORE_ADD
* @since 3.22.0
*
* @param {Phaser.Physics.Matter.Events.BeforeAddEvent} event - The Add Event object.
*/
module.exports = 'beforeadd';