phaser
Version:
A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers from the team at Phaser Studio Inc.
127 lines (107 loc) • 3.6 kB
JavaScript
/**
* @author Richard Davey <rich@phaser.io>
* @copyright 2013-2026 Phaser Studio Inc.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
/**
* The Debug component is a mixin that provides methods and properties for controlling the
* debug visualization of an Arcade Physics Body. When Arcade Physics debug mode is enabled
* globally, individual bodies can render their collision outlines and velocity vectors to the
* display, making it easier to visualize physics shapes and movement during development.
* This component lets you toggle those visuals per body and customize the outline color.
* Debug rendering carries a performance overhead and should never be enabled in production builds.
*
* @namespace Phaser.Physics.Arcade.Components.Debug
* @since 3.0.0
*/
var Debug = {
/**
* Sets the debug values of this body.
*
* Bodies will only draw their debug if debug has been enabled for Arcade Physics as a whole.
* Note that there is a performance cost in drawing debug displays. It should never be used in production.
*
* @method Phaser.Physics.Arcade.Components.Debug#setDebug
* @since 3.0.0
*
* @param {boolean} showBody - Set to `true` to have this body render its outline to the debug display.
* @param {boolean} showVelocity - Set to `true` to have this body render a velocity marker to the debug display.
* @param {number} bodyColor - The color of the body outline when rendered to the debug display.
*
* @return {this} This Game Object.
*/
setDebug: function (showBody, showVelocity, bodyColor)
{
this.debugShowBody = showBody;
this.debugShowVelocity = showVelocity;
this.debugBodyColor = bodyColor;
return this;
},
/**
* Sets the color of the body outline when it renders to the debug display.
*
* @method Phaser.Physics.Arcade.Components.Debug#setDebugBodyColor
* @since 3.0.0
*
* @param {number} value - The color of the body outline when rendered to the debug display.
*
* @return {this} This Game Object.
*/
setDebugBodyColor: function (value)
{
this.body.debugBodyColor = value;
return this;
},
/**
* Set to `true` to have this body render its outline to the debug display.
*
* @name Phaser.Physics.Arcade.Components.Debug#debugShowBody
* @type {boolean}
* @since 3.0.0
*/
debugShowBody: {
get: function ()
{
return this.body.debugShowBody;
},
set: function (value)
{
this.body.debugShowBody = value;
}
},
/**
* Set to `true` to have this body render a velocity marker to the debug display.
*
* @name Phaser.Physics.Arcade.Components.Debug#debugShowVelocity
* @type {boolean}
* @since 3.0.0
*/
debugShowVelocity: {
get: function ()
{
return this.body.debugShowVelocity;
},
set: function (value)
{
this.body.debugShowVelocity = value;
}
},
/**
* The color of the body outline when it renders to the debug display.
*
* @name Phaser.Physics.Arcade.Components.Debug#debugBodyColor
* @type {number}
* @since 3.0.0
*/
debugBodyColor: {
get: function ()
{
return this.body.debugBodyColor;
},
set: function (value)
{
this.body.debugBodyColor = value;
}
}
};
module.exports = Debug;