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: Drag
Phaser.Physics.Arcade.Components.Drag

Methods

setDrag(x, [y])
Focus
Focus

Description:

Sets the body's horizontal and vertical drag. If the vertical drag value is not provided, the vertical drag is set to the same value as the horizontal drag.

Drag can be considered as a form of deceleration that will return the velocity of a body back to zero over time. It is the absolute loss of velocity due to movement, in pixels per second squared. The x and y components are applied separately.

When useDamping is true, this is 1 minus the damping factor. A value of 1 means the Body loses no velocity. A value of 0.95 means the Body loses 5% of its velocity per step. A value of 0.5 means the Body loses 50% of its velocity per step.

Drag is applied only when acceleration is zero.

Parameters:

name type arguments Default description
x number

The amount of horizontal drag to apply.

y number <optional> x

The amount of vertical drag to apply.

Returns:
Description:

This Game Object.

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

Description:

Sets the body's horizontal drag.

Drag can be considered as a form of deceleration that will return the velocity of a body back to zero over time. It is the absolute loss of velocity due to movement, in pixels per second squared. The x and y components are applied separately.

When useDamping is true, this is 1 minus the damping factor. A value of 1 means the Body loses no velocity. A value of 0.95 means the Body loses 5% of its velocity per step. A value of 0.5 means the Body loses 50% of its velocity per step.

Drag is applied only when acceleration is zero.

Parameters:

name type description
value number

The amount of horizontal drag to apply.

Returns:
Description:

This Game Object.

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

Description:

Sets the body's vertical drag.

Drag can be considered as a form of deceleration that will return the velocity of a body back to zero over time. It is the absolute loss of velocity due to movement, in pixels per second squared. The x and y components are applied separately.

When useDamping is true, this is 1 minus the damping factor. A value of 1 means the Body loses no velocity. A value of 0.95 means the Body loses 5% of its velocity per step. A value of 0.5 means the Body loses 50% of its velocity per step.

Drag is applied only when acceleration is zero.

Parameters:

name type description
value number

The amount of vertical drag to apply.

Returns:
Description:

This Game Object.

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

Description:

If this Body is using drag for deceleration this function controls how the drag is applied. If set to true drag will use a damping effect rather than a linear approach. If you are creating a game where the Body moves freely at any angle (i.e. like the way the ship moves in the game Asteroids) then you will get a far smoother and more visually correct deceleration by using damping, avoiding the axis-drift that is prone with linear deceleration.

If you enable this property then you should use far smaller drag values than with linear, as they are used as a multiplier on the velocity. Values such as 0.95 will give a nice slow deceleration, where-as smaller values, such as 0.5 will stop an object almost immediately.

Parameters:

name type description
value boolean

true to use damping for deceleration, or false to use linear deceleration.

Returns:
Description:

This Game Object.

Examples:
Since: 3.10.0
Focus
Focus