phaser
Version:
A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers from the team at Phaser Studio Inc.
83 lines (73 loc) • 2.32 kB
JavaScript
/**
* @author Richard Davey <rich@phaser.io>
* @copyright 2013-2025 Phaser Studio Inc.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
/**
* Methods for setting the friction of an Arcade Physics Body.
*
* In Arcade Physics, friction is a special case of motion transfer from an "immovable" body to a riding body.
*
* @namespace Phaser.Physics.Arcade.Components.Friction
* @since 3.0.0
*
* @see Phaser.Physics.Arcade.Body#friction
*/
var Friction = {
/**
* Sets the friction of this game object's physics body.
* In Arcade Physics, friction is a special case of motion transfer from an "immovable" body to a riding body.
*
* @method Phaser.Physics.Arcade.Components.Friction#setFriction
* @since 3.0.0
*
* @param {number} x - The amount of horizontal friction to apply, [0, 1].
* @param {number} [y=x] - The amount of vertical friction to apply, [0, 1].
*
* @return {this} This Game Object.
*
* @see Phaser.Physics.Arcade.Body#friction
*/
setFriction: function (x, y)
{
this.body.friction.set(x, y);
return this;
},
/**
* Sets the horizontal friction of this game object's physics body.
* This can move a riding body horizontally when it collides with this one on the vertical axis.
*
* @method Phaser.Physics.Arcade.Components.Friction#setFrictionX
* @since 3.0.0
*
* @param {number} x - The amount of friction to apply, [0, 1].
*
* @return {this} This Game Object.
*
* @see Phaser.Physics.Arcade.Body#friction
*/
setFrictionX: function (x)
{
this.body.friction.x = x;
return this;
},
/**
* Sets the vertical friction of this game object's physics body.
* This can move a riding body vertically when it collides with this one on the horizontal axis.
*
* @method Phaser.Physics.Arcade.Components.Friction#setFrictionY
* @since 3.0.0
*
* @param {number} y - The amount of friction to apply, [0, 1].
*
* @return {this} This Game Object.
*
* @see Phaser.Physics.Arcade.Body#friction
*/
setFrictionY: function (y)
{
this.body.friction.y = y;
return this;
}
};
module.exports = Friction;