Class World

The Matter.World module contains methods for creating and manipulating the world composite. A Matter.World is a Matter.Composite body, which is a collection of Matter.Body, Matter.Constraint and other Matter.Composite. A Matter.World has a few additional properties including gravity and bounds. It is important to use the functions in the Matter.Composite module to modify the world composite, rather than directly modifying its properties. There are also a few methods here that alias those in Matter.Composite for easier readability.

See the included usage examples.

World

Index

Constructors

constructor

new World(): MatterJS.World
Returns MatterJS.World

Properties

bounds

bounds: MatterJS.Bounds

gravity

gravity: MatterJS.Gravity

Methods

`Static`add

add(
    world: MatterJS.World,
    body:
        | MatterJS.BodyType
        | MatterJS.BodyType[]
        | MatterJS.CompositeType
        | MatterJS.CompositeType[]
        | MatterJS.ConstraintType
        | MatterJS.ConstraintType[]
        | MatterJS.MouseConstraint,
): MatterJS.World
Add objects or arrays of objects of types: Body, Constraint, Composite
Parameters
- world: MatterJS.World
- body:
      | MatterJS.BodyType
      | MatterJS.BodyType[]
      | MatterJS.CompositeType
      | MatterJS.CompositeType[]
      | MatterJS.ConstraintType
      | MatterJS.ConstraintType[]
      | MatterJS.MouseConstraint
Returns MatterJS.World
world
- Defined in types/matter.d.ts:4849

`Static`addBody

addBody(world: MatterJS.World, body: MatterJS.BodyType): MatterJS.World
An alias for Composite.addBody since World is also a Composite
Parameters
- world: MatterJS.World
- body: MatterJS.BodyType
Returns MatterJS.World
The original world with the body added

Method
addBody
- Defined in types/matter.d.ts:4858

`Static`addComposite

addComposite(
world: MatterJS.World,
composite: MatterJS.CompositeType,
): MatterJS.World
An alias for Composite.add since World is also a Composite
Parameters
- world: MatterJS.World
- composite: MatterJS.CompositeType
Returns MatterJS.World
The original world with the objects from composite added

Method
addComposite
- Defined in types/matter.d.ts:4867

`Static`addConstraint

addConstraint(
world: MatterJS.World,
constraint: MatterJS.ConstraintType,
): MatterJS.World
An alias for Composite.addConstraint since World is also a Composite
Parameters
- world: MatterJS.World
- constraint: MatterJS.ConstraintType
Returns MatterJS.World
The original world with the constraint added

Method
addConstraint
- Defined in types/matter.d.ts:4876

`Static`clear

clear(world: MatterJS.World, keepStatic: boolean): void
An alias for Composite.clear since World is also a Composite
Parameters
- world: MatterJS.World
- keepStatic: boolean
Returns void
Method
clear
- Defined in types/matter.d.ts:4884

`Static`create

create(options: MatterJS.IWorldDefinition): MatterJS.World
Creates a new world composite. The options parameter is an object that specifies any properties you wish to override the defaults. See the properties section below for detailed information on what you can pass via the options object.
Parameters
- options: MatterJS.IWorldDefinition
Returns MatterJS.World
A new world

Method
create
- Defined in types/matter.d.ts:4894

Class World

Index

Constructors

Properties

Methods

Constructors

constructor

Returns MatterJS.World

Properties

bounds

gravity

Methods

`Static`add

Parameters

Returns MatterJS.World

`Static`addBody

Parameters

Returns MatterJS.World

Method

`Static`addComposite

Parameters

Returns MatterJS.World

Method

`Static`addConstraint

Parameters

Returns MatterJS.World

Method

`Static`clear

Parameters

Returns void

Method

`Static`create

Parameters

Returns MatterJS.World

Method

Settings

On This Page

Class World

Index

Constructors

Properties

Methods

Constructors

constructor

Returns MatterJS.World

Properties

bounds

gravity

Methods

Staticadd

Parameters

Returns MatterJS.World

StaticaddBody

Parameters

Returns MatterJS.World

Method

StaticaddComposite

Parameters

Returns MatterJS.World

Method

StaticaddConstraint

Parameters

Returns MatterJS.World

Method

Staticclear

Parameters

Returns void

Method

Staticcreate

Parameters

Returns MatterJS.World

Method

Settings

On This Page

`Static`add

`Static`addBody

`Static`addComposite

`Static`addConstraint

`Static`clear

`Static`create