Phaser.Physics.Matter.Events

Scope: static

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

Typedefs:

Public Members

AfterAddEvent

AfterAddEvent

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


AfterRemoveEvent

AfterRemoveEvent

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


AfterUpdateEvent

AfterUpdateEvent

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


BeforeAddEvent

BeforeAddEvent

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


BeforeRemoveEvent

BeforeRemoveEvent

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


BeforeUpdateEvent

BeforeUpdateEvent

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


CollisionActiveEvent

CollisionActiveEvent

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


CollisionEndEvent

CollisionEndEvent

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


CollisionStartEvent

CollisionStartEvent

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


SleepEndEvent

SleepEndEvent

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


SleepStartEvent

SleepStartEvent

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


Private Members

Events:

Public Members

AFTER_ADD

AFTER_ADD

Description:

The Matter Physics After Add Event.

This event is dispatched by a Matter Physics World instance at the end of the process when a new Body or Constraint has just been added to the world.

Listen to it from a Scene using: this.matter.world.on('afteradd', listener).

Parameters:

nametypeoptionaldescription
eventPhaser.Physics.Matter.Events.AfterAddEventNoThe Add Event object.

Source: src/physics/matter-js/events/AFTER_ADD_EVENT.js#L15
Since: 3.22.0


AFTER_REMOVE

AFTER_REMOVE

Description:

The Matter Physics After Remove Event.

This event is dispatched by a Matter Physics World instance at the end of the process when a Body or Constraint was removed from the world.

Listen to it from a Scene using: this.matter.world.on('afterremove', listener).

Parameters:

nametypeoptionaldescription
eventPhaser.Physics.Matter.Events.AfterRemoveEventNoThe Remove Event object.

Source: src/physics/matter-js/events/AFTER_REMOVE_EVENT.js#L15
Since: 3.22.0


AFTER_UPDATE

AFTER_UPDATE

Description:

The Matter Physics After Update Event.

This event is dispatched by a Matter Physics World instance after the engine has updated and all collision events have resolved.

Listen to it from a Scene using: this.matter.world.on('afterupdate', listener).

Parameters:

nametypeoptionaldescription
eventPhaser.Physics.Matter.Events.AfterUpdateEventNoThe Update Event object.

Source: src/physics/matter-js/events/AFTER_UPDATE_EVENT.js#L15
Since: 3.0.0


BEFORE_ADD

BEFORE_ADD

Description:

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

Parameters:

nametypeoptionaldescription
eventPhaser.Physics.Matter.Events.BeforeAddEventNoThe Add Event object.

Source: src/physics/matter-js/events/BEFORE_ADD_EVENT.js#L15
Since: 3.22.0


BEFORE_REMOVE

BEFORE_REMOVE

Description:

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

Parameters:

nametypeoptionaldescription
eventPhaser.Physics.Matter.Events.BeforeRemoveEventNoThe Remove Event object.

Source: src/physics/matter-js/events/BEFORE_REMOVE_EVENT.js#L15
Since: 3.22.0


BEFORE_UPDATE

BEFORE_UPDATE

Description:

The Matter Physics Before Update Event.

This event is dispatched by a Matter Physics World instance right before all the collision processing takes place.

Listen to it from a Scene using: this.matter.world.on('beforeupdate', listener).

Parameters:

nametypeoptionaldescription
eventPhaser.Physics.Matter.Events.BeforeUpdateEventNoThe Update Event object.

Source: src/physics/matter-js/events/BEFORE_UPDATE_EVENT.js#L15
Since: 3.0.0


COLLISION_ACTIVE

COLLISION_ACTIVE

Description:

The Matter Physics Collision Active Event.

This event is dispatched by a Matter Physics World instance after the engine has updated. It provides a list of all pairs that are colliding in the current tick (if any).

Listen to it from a Scene using: this.matter.world.on('collisionactive', listener).

Parameters:

nametypeoptionaldescription
eventPhaser.Physics.Matter.Events.CollisionActiveEventNoThe Collision Event object.
bodyAMatterJS.BodyTypeNoThe first body of the first colliding pair. The event.pairs array may contain more colliding bodies.
bodyBMatterJS.BodyTypeNoThe second body of the first colliding pair. The event.pairs array may contain more colliding bodies.

Source: src/physics/matter-js/events/COLLISION_ACTIVE_EVENT.js#L16
Since: 3.0.0


COLLISION_END

COLLISION_END

Description:

The Matter Physics Collision End Event.

This event is dispatched by a Matter Physics World instance after the engine has updated. It provides a list of all pairs that have finished colliding in the current tick (if any).

Listen to it from a Scene using: this.matter.world.on('collisionend', listener).

Parameters:

nametypeoptionaldescription
eventPhaser.Physics.Matter.Events.CollisionEndEventNoThe Collision Event object.
bodyAMatterJS.BodyTypeNoThe first body of the first colliding pair. The event.pairs array may contain more colliding bodies.
bodyBMatterJS.BodyTypeNoThe second body of the first colliding pair. The event.pairs array may contain more colliding bodies.

Source: src/physics/matter-js/events/COLLISION_END_EVENT.js#L16
Since: 3.0.0


COLLISION_START

COLLISION_START

Description:

The Matter Physics Collision Start Event.

This event is dispatched by a Matter Physics World instance after the engine has updated. It provides a list of all pairs that have started to collide in the current tick (if any).

Listen to it from a Scene using: this.matter.world.on('collisionstart', listener).

Parameters:

nametypeoptionaldescription
eventPhaser.Physics.Matter.Events.CollisionStartEventNoThe Collision Event object.
bodyAMatterJS.BodyTypeNoThe first body of the first colliding pair. The event.pairs array may contain more colliding bodies.
bodyBMatterJS.BodyTypeNoThe second body of the first colliding pair. The event.pairs array may contain more colliding bodies.

Source: src/physics/matter-js/events/COLLISION_START_EVENT.js#L16
Since: 3.0.0


DRAG

DRAG

Description:

The Matter Physics Drag Event.

This event is dispatched by a Matter Physics World instance when a Pointer Constraint is actively dragging a body. It is emitted each time the pointer moves.

Listen to it from a Scene using: this.matter.world.on('drag', listener).

Parameters:

nametypeoptionaldescription
bodyMatterJS.BodyTypeNoThe Body that is being dragged. This is a Matter Body, not a Phaser Game Object.
constraintPhaser.Physics.Matter.PointerConstraintNoThe Pointer Constraint that is dragging the body.

Source: src/physics/matter-js/events/DRAG_EVENT.js#L7
Since: 3.16.2


DRAG_END

DRAG_END

Description:

The Matter Physics Drag End Event.

This event is dispatched by a Matter Physics World instance when a Pointer Constraint stops dragging a body.

Listen to it from a Scene using: this.matter.world.on('dragend', listener).

Parameters:

nametypeoptionaldescription
bodyMatterJS.BodyTypeNoThe Body that has stopped being dragged. This is a Matter Body, not a Phaser Game Object.
constraintPhaser.Physics.Matter.PointerConstraintNoThe Pointer Constraint that was dragging the body.

Source: src/physics/matter-js/events/DRAG_END_EVENT.js#L7
Since: 3.16.2


DRAG_START

DRAG_START

Description:

The Matter Physics Drag Start Event.

This event is dispatched by a Matter Physics World instance when a Pointer Constraint starts dragging a body.

Listen to it from a Scene using: this.matter.world.on('dragstart', listener).

Parameters:

nametypeoptionaldescription
bodyMatterJS.BodyTypeNoThe Body that has started being dragged. This is a Matter Body, not a Phaser Game Object.
partMatterJS.BodyTypeNoThe part of the body that was clicked on.
constraintPhaser.Physics.Matter.PointerConstraintNoThe Pointer Constraint that is dragging the body.

Source: src/physics/matter-js/events/DRAG_START_EVENT.js#L7
Since: 3.16.2


PAUSE

PAUSE

Description:

The Matter Physics World Pause Event.

This event is dispatched by an Matter Physics World instance when it is paused.

Listen to it from a Scene using: this.matter.world.on('pause', listener).

Source: src/physics/matter-js/events/PAUSE_EVENT.js#L7
Since: 3.0.0


RESUME

RESUME

Description:

The Matter Physics World Resume Event.

This event is dispatched by an Matter Physics World instance when it resumes from a paused state.

Listen to it from a Scene using: this.matter.world.on('resume', listener).

Source: src/physics/matter-js/events/RESUME_EVENT.js#L7
Since: 3.0.0


SLEEP_END

SLEEP_END

Description:

The Matter Physics Sleep End Event.

This event is dispatched by a Matter Physics World instance when a Body stop sleeping.

Listen to it from a Scene using: this.matter.world.on('sleepend', listener).

Parameters:

nametypeoptionaldescription
eventPhaser.Physics.Matter.Events.SleepEndEventNoThe Sleep Event object.
bodyMatterJS.BodyTypeNoThe body that has stopped sleeping.

Source: src/physics/matter-js/events/SLEEP_END_EVENT.js#L14
Since: 3.0.0


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:

nametypeoptionaldescription
eventPhaser.Physics.Matter.Events.SleepStartEventNoThe Sleep Event object.
bodyMatterJS.BodyTypeNoThe body that has gone to sleep.

Source: src/physics/matter-js/events/SLEEP_START_EVENT.js#L14
Since: 3.0.0


Private Members

Updated on