Skip to main content
Version: Phaser v3.88.2

Physics.Matter.Events

AfterAddEvent

<static> AfterAddEvent

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

<static> AfterRemoveEvent

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

<static> AfterUpdateEvent

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

<static> BeforeAddEvent

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

<static> BeforeRemoveEvent

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

<static> BeforeUpdateEvent

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

<static> CollisionActiveEvent

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

<static> CollisionEndEvent

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

<static> CollisionStartEvent

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

<static> SleepEndEvent

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

<static> SleepStartEvent

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