Namespace: Matter

Classes

BodyBounds

Factory

Image

MatterPhysics

PointerConstraint

Sprite

TileBody

World

Namespaces

Components

Events

Matter

PhysicsEditorParser

PhysicsJSONParser

Methods

---

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

Parameters:

Name	Type	Argument	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	Phaser.Types.Physics.Matter.MatterBodyConfig | MatterJS.Body	<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?

Since: 3.3.0

Source: src/physics/matter-js/MatterGameObject.js (Line 26)

Returns:

The Game Object that was created with the Matter body.

Type

Phaser.GameObjects.GameObject