Class Pair

The Matter.Pair module contains methods for creating and manipulating collision pairs.

Index

Constructors

Methods

create id setActive update

Constructors

constructor

new Pair(): Pair
Returns Pair

Methods

`Static`create

create(collision: ICollisionData, timestamp: number): IPair
Creates a pair.
Parameters
- collision: ICollisionData
- timestamp: number
Returns IPair
A new pair

Method
create
- Defined in node_modules/.pnpm/phaser@3.90.0/node_modules/phaser/types/matter.d.ts:3703

`Static`id

id(bodyA: BodyType, bodyB: BodyType): string
Get the id for the given pair.
Parameters
- bodyA: BodyType
- bodyB: BodyType
Returns string
Unique pairId

Method
id
- Defined in node_modules/.pnpm/phaser@3.90.0/node_modules/phaser/types/matter.d.ts:3730

`Static`setActive

setActive(pair: IPair, isActive: boolean, timestamp: number): void
Set a pair as active or inactive.
Parameters
- pair: IPair
- isActive: boolean
- timestamp: number
Returns void
Method
setActive
- Defined in node_modules/.pnpm/phaser@3.90.0/node_modules/phaser/types/matter.d.ts:3721

`Static`update

update(pair: IPair, collision: ICollisionData, timestamp: number): void
Updates a pair given a collision.
Parameters
- pair: IPair
- collision: ICollisionData
- timestamp: number
Returns void
Method
update
- Defined in node_modules/.pnpm/phaser@3.90.0/node_modules/phaser/types/matter.d.ts:3712