Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord
Namespace: Friction
Phaser.Physics.Matter.Components.Friction

Methods

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

Description:

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

Parameters:

name type arguments 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.

Returns:
Description:

This Game Object.

Examples:
Since: 3.0.0
Focus
Focus
setFrictionAir(value)
Focus
Focus

Description:

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.

Returns:
Description:

This Game Object.

Examples:
Since: 3.0.0
Focus
Focus
setFrictionStatic(value)
Focus
Focus

Description:

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.

Returns:
Description:

This Game Object.

Examples:
Since: 3.0.0
Focus
Focus