Namespace: Friction

Phaser.Physics.Matter.Components. Friction

Contains methods for changing the friction of a Game Object's Matter Body. Should be used a mixin, not called directly.

Since: 3.0.0
Source: src/physics/matter-js/components/Friction.js (Line 7)

Methods


setFriction(value [, air] [, fstatic])

Sets new friction values for this Game Object's Matter Body.

Parameters:
Name Type Argument Description
value number

The new friction of the body, between 0 and 1, where 0 allows the Body to slide indefinitely, while 1 allows it to stop almost immediately after a force is applied.

air number <optional>

If provided, the new air resistance of the Body. The higher the value, the faster the Body will slow as it moves through space. 0 means the body has no air resistance.

fstatic number <optional>

If provided, the new static friction of the Body. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary. 0 means the body will never "stick" when it is nearly stationary.

Since: 3.0.0
Source: src/physics/matter-js/components/Friction.js (Line 15)
Returns:

This Game Object.

Type
Phaser.GameObjects.GameObject

setFrictionAir(value)

Sets a new air resistance for this Game Object's Matter Body. A value of 0 means the Body will never slow as it moves through space. The higher the value, the faster a Body slows when moving through space.

Parameters:
Name Type Description
value number

The new air resistance for the Body.

Since: 3.0.0
Source: src/physics/matter-js/components/Friction.js (Line 44)
Returns:

This Game Object.

Type
Phaser.GameObjects.GameObject

setFrictionStatic(value)

Sets a new static friction for this Game Object's Matter Body. A value of 0 means the Body will never "stick" when it is nearly stationary. The higher the value (e.g. 10), the more force it will take to initially get the Body moving when it is nearly stationary.

Parameters:
Name Type Description
value number

The new static friction for the Body.

Since: 3.0.0
Source: src/physics/matter-js/components/Friction.js (Line 61)
Returns:

This Game Object.

Type
Phaser.GameObjects.GameObject