Phaser API Documentation

<static> MatterGameObject(world, gameObject, [options], [addToWorld])


A Matter Game Object is a generic object that allows you to combine any Phaser Game Object, including those you have extended or created yourself, with all of the Matter Components.

This enables you to use component methods such as setVelocity or isSensor directly from this Game Object.


name type arguments Default description
world Phaser.Physics.Matter.World

The Matter world to add the body to.

gameObject Phaser.GameObjects.GameObject

The Game Object that will have the Matter body applied to it.

options MatterJS.Body | Phaser.Types.Physics.Matter.MatterBodyConfig <optional>

A Matter Body configuration object, or an instance of a Matter Body.

addToWorld boolean <optional> true

Should the newly created body be immediately added to the World?


The Game Object that was created with the Matter body.

Since: 3.3.0