phaser
Version:
A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers from the team at Phaser Studio Inc.
98 lines (86 loc) • 3.25 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 setting the size of an Arcade Physics Game Object.
* Should be applied as a mixin and not used directly.
*
* @namespace Phaser.Physics.Arcade.Components.Size
* @since 3.0.0
*/
var Size = {
/**
* Sets the body offset. This allows you to adjust the difference between the center of the body
* and the x and y coordinates of the parent Game Object.
*
* @method Phaser.Physics.Arcade.Components.Size#setOffset
* @since 3.0.0
*
* @param {number} x - The amount to offset the body from the parent Game Object along the x-axis.
* @param {number} [y=x] - The amount to offset the body from the parent Game Object along the y-axis. Defaults to the value given for the x-axis.
*
* @return {this} This Game Object.
*/
setOffset: function (x, y)
{
this.body.setOffset(x, y);
return this;
},
/**
* **DEPRECATED**: Please use `setBodySize` instead.
*
* Sets the size of this physics body. Setting the size does not adjust the dimensions of the parent Game Object.
*
* @method Phaser.Physics.Arcade.Components.Size#setSize
* @since 3.0.0
* @deprecated
*
* @param {number} width - The new width of the physics body, in pixels.
* @param {number} height - The new height of the physics body, in pixels.
* @param {boolean} [center=true] - Should the body be re-positioned so its center aligns with the parent Game Object?
*
* @return {this} This Game Object.
*/
setSize: function (width, height, center)
{
this.body.setSize(width, height, center);
return this;
},
/**
* Sets the size of this physics body. Setting the size does not adjust the dimensions of the parent Game Object.
*
* @method Phaser.Physics.Arcade.Components.Size#setBodySize
* @since 3.24.0
*
* @param {number} width - The new width of the physics body, in pixels.
* @param {number} height - The new height of the physics body, in pixels.
* @param {boolean} [center=true] - Should the body be re-positioned so its center aligns with the parent Game Object?
*
* @return {this} This Game Object.
*/
setBodySize: function (width, height, center)
{
this.body.setSize(width, height, center);
return this;
},
/**
* Sets this physics body to use a circle for collision instead of a rectangle.
*
* @method Phaser.Physics.Arcade.Components.Size#setCircle
* @since 3.0.0
*
* @param {number} radius - The radius of the physics body, in pixels.
* @param {number} [offsetX] - The amount to offset the body from the parent Game Object along the x-axis.
* @param {number} [offsetY] - The amount to offset the body from the parent Game Object along the y-axis.
*
* @return {this} This Game Object.
*/
setCircle: function (radius, offsetX, offsetY)
{
this.body.setCircle(radius, offsetX, offsetY);
return this;
}
};
module.exports = Size;