You’re reading the docs for Phaser v4.0.0. The latest is Phaser v4.1.0.

Physics.Matter.Events

Phaser.Physics.Matter.Events

AfterAddEvent

staticAfterAddEvent

nametypeoptionaldescription
objectArray.<any>NoAn array of the object(s) that have been added. May be a single body, constraint, composite or a mixture of these.
sourceanyNoThe source object of the event.
namestringNoThe name of the event.

Type: object

Member of: Phaser.Physics.Matter.Events

Source: src/physics/matter-js/events/AFTER_ADD_EVENT.js#L7


AfterRemoveEvent

staticAfterRemoveEvent

nametypeoptionaldescription
objectArray.<any>NoAn array of the object(s) that were removed. May be a single body, constraint, composite or a mixture of these.
sourceanyNoThe source object of the event.
namestringNoThe name of the event.

Type: object

Member of: Phaser.Physics.Matter.Events

Source: src/physics/matter-js/events/AFTER_REMOVE_EVENT.js#L7


AfterUpdateEvent

staticAfterUpdateEvent

nametypeoptionaldescription
timestampnumberNoThe Matter Engine timing.timestamp value for the event.
sourceanyNoThe source object of the event.
namestringNoThe name of the event.

Type: object

Member of: Phaser.Physics.Matter.Events

Source: src/physics/matter-js/events/AFTER_UPDATE_EVENT.js#L7


BeforeAddEvent

staticBeforeAddEvent

nametypeoptionaldescription
objectArray.<any>NoAn array of the object(s) to be added. May be a single body, constraint, composite or a mixture of these.
sourceanyNoThe source object of the event.
namestringNoThe name of the event.

Type: object

Member of: Phaser.Physics.Matter.Events

Source: src/physics/matter-js/events/BEFORE_ADD_EVENT.js#L7


BeforeRemoveEvent

staticBeforeRemoveEvent

nametypeoptionaldescription
objectArray.<any>NoAn array of the object(s) to be removed. May be a single body, constraint, composite or a mixture of these.
sourceanyNoThe source object of the event.
namestringNoThe name of the event.

Type: object

Member of: Phaser.Physics.Matter.Events

Source: src/physics/matter-js/events/BEFORE_REMOVE_EVENT.js#L7


BeforeUpdateEvent

staticBeforeUpdateEvent

nametypeoptionaldescription
timestampnumberNoThe Matter Engine timing.timestamp value for the event.
sourceanyNoThe source object of the event.
namestringNoThe name of the event.

Type: object

Member of: Phaser.Physics.Matter.Events

Source: src/physics/matter-js/events/BEFORE_UPDATE_EVENT.js#L7


CollisionActiveEvent

staticCollisionActiveEvent

nametypeoptionaldescription
pairsArray.<Phaser.Types.Physics.Matter.MatterCollisionPair>NoA list of all affected pairs in the collision.
timestampnumberNoThe Matter Engine timing.timestamp value for the event.
sourceanyNoThe source object of the event.
namestringNoThe name of the event.

Type: object

Member of: Phaser.Physics.Matter.Events

Source: src/physics/matter-js/events/COLLISION_ACTIVE_EVENT.js#L7


CollisionEndEvent

staticCollisionEndEvent

nametypeoptionaldescription
pairsArray.<Phaser.Types.Physics.Matter.MatterCollisionPair>NoA list of all affected pairs in the collision.
timestampnumberNoThe Matter Engine timing.timestamp value for the event.
sourceanyNoThe source object of the event.
namestringNoThe name of the event.

Type: object

Member of: Phaser.Physics.Matter.Events

Source: src/physics/matter-js/events/COLLISION_END_EVENT.js#L7


CollisionStartEvent

staticCollisionStartEvent

nametypeoptionaldescription
pairsArray.<Phaser.Types.Physics.Matter.MatterCollisionPair>NoA list of all affected pairs in the collision.
timestampnumberNoThe Matter Engine timing.timestamp value for the event.
sourceanyNoThe source object of the event.
namestringNoThe name of the event.

Type: object

Member of: Phaser.Physics.Matter.Events

Source: src/physics/matter-js/events/COLLISION_START_EVENT.js#L7


SleepEndEvent

staticSleepEndEvent

nametypeoptionaldescription
sourceanyNoThe source object of the event.
namestringNoThe name of the event.

Type: object

Member of: Phaser.Physics.Matter.Events

Source: src/physics/matter-js/events/SLEEP_END_EVENT.js#L7


SleepStartEvent

staticSleepStartEvent

nametypeoptionaldescription
sourceanyNoThe source object of the event.
namestringNoThe name of the event.

Type: object

Member of: Phaser.Physics.Matter.Events

Source: src/physics/matter-js/events/SLEEP_START_EVENT.js#L7