phaser
Version:
A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers from the team at Phaser Studio Inc.
94 lines (82 loc) • 2.58 kB
JavaScript
/**
* @author Richard Davey <rich@phaser.io>
* @copyright 2013-2025 Phaser Studio Inc.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
/**
* Provides methods for modifying the velocity of an Arcade Physics body.
*
* Should be applied as a mixin and not used directly.
*
* @namespace Phaser.Physics.Arcade.Components.Velocity
* @since 3.0.0
*/
var Velocity = {
/**
* Sets the velocity of the Body.
*
* @method Phaser.Physics.Arcade.Components.Velocity#setVelocity
* @since 3.0.0
*
* @param {number} x - The horizontal velocity of the body, in pixels per second. Positive values move the body to the right, while negative values move it to the left.
* @param {number} [y=x] - The vertical velocity of the body, in pixels per second. Positive values move the body down, while negative values move it up.
*
* @return {this} This Game Object.
*/
setVelocity: function (x, y)
{
this.body.setVelocity(x, y);
return this;
},
/**
* Sets the horizontal component of the body's velocity.
*
* Positive values move the body to the right, while negative values move it to the left.
*
* @method Phaser.Physics.Arcade.Components.Velocity#setVelocityX
* @since 3.0.0
*
* @param {number} x - The new horizontal velocity, in pixels per second.
*
* @return {this} This Game Object.
*/
setVelocityX: function (x)
{
this.body.setVelocityX(x);
return this;
},
/**
* Sets the vertical component of the body's velocity.
*
* Positive values move the body down, while negative values move it up.
*
* @method Phaser.Physics.Arcade.Components.Velocity#setVelocityY
* @since 3.0.0
*
* @param {number} y - The new vertical velocity, in pixels per second.
*
* @return {this} This Game Object.
*/
setVelocityY: function (y)
{
this.body.setVelocityY(y);
return this;
},
/**
* Sets the maximum velocity of the body.
*
* @method Phaser.Physics.Arcade.Components.Velocity#setMaxVelocity
* @since 3.0.0
*
* @param {number} x - The new maximum horizontal velocity, in pixels per second.
* @param {number} [y=x] - The new maximum vertical velocity, in pixels per second.
*
* @return {this} This Game Object.
*/
setMaxVelocity: function (x, y)
{
this.body.maxVelocity.set(x, y);
return this;
}
};
module.exports = Velocity;