mirror of
https://github.com/photonstorm/phaser
synced 2024-11-23 21:24:09 +00:00
1293 lines
37 KiB
HTML
1293 lines
37 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Phaser Source: utils/Debug.js</title>
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
|
|
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
|
|
|
|
</head>
|
|
|
|
<body>
|
|
<div class="container-fluid">
|
|
<div class="navbar navbar-fixed-top navbar-inverse">
|
|
<div class="navbar-inner">
|
|
<a class="brand" href="index.html">Phaser</a>
|
|
<ul class="nav">
|
|
|
|
<li class="dropdown">
|
|
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
|
|
class="caret"></b></a>
|
|
|
|
<ul class="dropdown-menu ">
|
|
|
|
<li>
|
|
<a href="Phaser.html">Phaser</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="dropdown">
|
|
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
|
|
class="caret"></b></a>
|
|
|
|
<ul class="dropdown-menu ">
|
|
|
|
<li>
|
|
<a href="Phaser.Animation.html">Animation</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.AnimationManager.html">AnimationManager</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.AnimationParser.html">AnimationParser</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.BitmapData.html">BitmapData</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.BitmapText.html">BitmapText</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Button.html">Button</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Cache.html">Cache</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Camera.html">Camera</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Canvas.html">Canvas</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Circle.html">Circle</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Color.html">Color</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Device.html">Device</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Easing.html">Easing</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Easing.Back.html">Back</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Easing.Bounce.html">Bounce</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Easing.Circular.html">Circular</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Easing.Cubic.html">Cubic</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Easing.Elastic.html">Elastic</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Easing.Exponential.html">Exponential</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Easing.Linear.html">Linear</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Easing.Quartic.html">Quartic</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Easing.Quintic.html">Quintic</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Ellipse.html">Ellipse</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Events.html">Events</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Filter.html">Filter</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Frame.html">Frame</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.FrameData.html">FrameData</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Game.html">Game</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Gamepad.html">Gamepad</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.GamepadButton.html">GamepadButton</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Graphics.html">Graphics</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Group.html">Group</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Image.html">Image</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Input.html">Input</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.InputHandler.html">InputHandler</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Key.html">Key</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Keyboard.html">Keyboard</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Line.html">Line</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.LinkedList.html">LinkedList</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Loader.html">Loader</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.LoaderParser.html">LoaderParser</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Math.html">Math</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Mouse.html">Mouse</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.MSPointer.html">MSPointer</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Net.html">Net</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Particles.html">Particles</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.html">Physics</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.Arcade.html">Arcade</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.Ninja.html">Ninja</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.P2.html">P2</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.P2.Body.html">Body</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.P2.Material.html">Material</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Plugin.html">Plugin</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.PluginManager.html">PluginManager</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Point.html">Point</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Pointer.html">Pointer</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Polygon.html">Polygon</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.QuadTree.html">QuadTree</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Rectangle.html">Rectangle</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.RenderTexture.html">RenderTexture</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.RetroFont.html">RetroFont</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.ScaleManager.html">ScaleManager</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Signal.html">Signal</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.SinglePad.html">SinglePad</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Sound.html">Sound</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.SoundManager.html">SoundManager</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Sprite.html">Sprite</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Stage.html">Stage</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.State.html">State</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.StateManager.html">StateManager</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Text.html">Text</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Tile.html">Tile</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Tilemap.html">Tilemap</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.TilemapParser.html">TilemapParser</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Tileset.html">Tileset</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.TileSprite.html">TileSprite</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Time.html">Time</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Timer.html">Timer</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.TimerEvent.html">TimerEvent</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Touch.html">Touch</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Tween.html">Tween</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.TweenManager.html">TweenManager</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Utils.html">Utils</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Utils.Debug.html">Debug</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.World.html">World</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="SignalBinding.html">SignalBinding</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span12">
|
|
|
|
<div id="main">
|
|
|
|
|
|
|
|
<h1 class="page-title">Source: utils/Debug.js</h1>
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="sunlight-highlight-javascript linenums">/**
|
|
* @author Richard Davey <rich@photonstorm.com>
|
|
* @copyright 2014 Photon Storm Ltd.
|
|
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
|
|
*/
|
|
|
|
/**
|
|
* A collection of methods for displaying debug information about game objects.
|
|
* If your game is running in WebGL then Debug will create a Sprite that is placed at the top of the Stage display list and bind a canvas texture
|
|
* to it, which must be uploaded every frame. Be advised: this is expenive.
|
|
* If your game is using a Canvas renderer then the debug information is literally drawn on the top of the active game canvas and no Sprite is used.
|
|
*
|
|
* @class Phaser.Utils.Debug
|
|
* @constructor
|
|
* @param {Phaser.Game} game - A reference to the currently running game.
|
|
*/
|
|
Phaser.Utils.Debug = function (game) {
|
|
|
|
/**
|
|
* @property {Phaser.Game} game - A reference to the currently running Game.
|
|
*/
|
|
this.game = game;
|
|
|
|
/**
|
|
* @property {PIXI.Sprite} sprite - If debugging in WebGL mode we need this.
|
|
*/
|
|
this.sprite = null;
|
|
|
|
/**
|
|
* @property {HTMLCanvasElement} canvas - The canvas to which this BitmapData draws.
|
|
*/
|
|
this.canvas = null;
|
|
|
|
/**
|
|
* @property {PIXI.BaseTexture} baseTexture - Required Pixi var.
|
|
*/
|
|
this.baseTexture = null;
|
|
|
|
/**
|
|
* @property {PIXI.Texture} texture - Required Pixi var.
|
|
*/
|
|
this.texture = null;
|
|
|
|
/**
|
|
* @property {Phaser.Frame} textureFrame - Dimensions of the renderable area.
|
|
*/
|
|
this.textureFrame = null;
|
|
|
|
/**
|
|
* @property {CanvasRenderingContext2D} context - The 2d context of the canvas.
|
|
*/
|
|
this.context = null;
|
|
|
|
/**
|
|
* @property {string} font - The font that the debug information is rendered in.
|
|
* @default '14px Courier'
|
|
*/
|
|
this.font = '14px Courier';
|
|
|
|
/**
|
|
* @property {number} columnWidth - The spacing between columns.
|
|
*/
|
|
this.columnWidth = 100;
|
|
|
|
/**
|
|
* @property {number} lineHeight - The line height between the debug text.
|
|
*/
|
|
this.lineHeight = 16;
|
|
|
|
/**
|
|
* @property {boolean} renderShadow - Should the text be rendered with a slight shadow? Makes it easier to read on different types of background.
|
|
*/
|
|
this.renderShadow = true;
|
|
|
|
/**
|
|
* @property {Context} currentX - The current X position the debug information will be rendered at.
|
|
* @default
|
|
*/
|
|
this.currentX = 0;
|
|
|
|
/**
|
|
* @property {number} currentY - The current Y position the debug information will be rendered at.
|
|
* @default
|
|
*/
|
|
this.currentY = 0;
|
|
|
|
/**
|
|
* @property {number} currentAlpha - The current alpha the debug information will be rendered at.
|
|
* @default
|
|
*/
|
|
this.currentAlpha = 1;
|
|
|
|
/**
|
|
* @property {boolean} dirty - Does the canvas need re-rendering?
|
|
*/
|
|
this.dirty = false;
|
|
|
|
};
|
|
|
|
Phaser.Utils.Debug.prototype = {
|
|
|
|
/**
|
|
* Internal method that boots the debug displayer.
|
|
*
|
|
* @method Phaser.Utils.Debug#boot
|
|
* @protected
|
|
*/
|
|
boot: function () {
|
|
|
|
if (this.game.renderType === Phaser.CANVAS)
|
|
{
|
|
this.context = this.game.context;
|
|
}
|
|
else
|
|
{
|
|
this.canvas = Phaser.Canvas.create(this.game.width, this.game.height, '', true);
|
|
this.context = this.canvas.getContext('2d');
|
|
this.baseTexture = new PIXI.BaseTexture(this.canvas);
|
|
this.texture = new PIXI.Texture(this.baseTexture);
|
|
this.textureFrame = new Phaser.Frame(0, 0, 0, this.game.width, this.game.height, 'debug', this.game.rnd.uuid());
|
|
this.sprite = this.game.make.image(0, 0, this.texture, this.textureFrame);
|
|
this.game.stage.addChild(this.sprite);
|
|
}
|
|
|
|
},
|
|
|
|
/**
|
|
* Internal method that clears the canvas (if a Sprite) ready for a new debug session.
|
|
*
|
|
* @method Phaser.Utils.Debug#preUpdate
|
|
*/
|
|
preUpdate: function () {
|
|
|
|
if (this.dirty && this.sprite)
|
|
{
|
|
this.context.clearRect(0, 0, this.game.width, this.game.height);
|
|
this.dirty = false;
|
|
}
|
|
|
|
},
|
|
|
|
/**
|
|
* Internal method that resets and starts the debug output values.
|
|
*
|
|
* @method Phaser.Utils.Debug#start
|
|
* @protected
|
|
* @param {number} [x=0] - The X value the debug info will start from.
|
|
* @param {number} [y=0] - The Y value the debug info will start from.
|
|
* @param {string} [color='rgb(255,255,255)'] - The color the debug text will drawn in.
|
|
* @param {number} [columnWidth=0] - The spacing between columns.
|
|
*/
|
|
start: function (x, y, color, columnWidth) {
|
|
|
|
if (typeof x !== 'number') { x = 0; }
|
|
if (typeof y !== 'number') { y = 0; }
|
|
color = color || 'rgb(255,255,255)';
|
|
if (typeof columnWidth === 'undefined') { columnWidth = 0; }
|
|
|
|
this.currentX = x;
|
|
this.currentY = y;
|
|
this.currentColor = color;
|
|
this.currentAlpha = this.context.globalAlpha;
|
|
this.columnWidth = columnWidth;
|
|
|
|
if (this.sprite)
|
|
{
|
|
this.dirty = true;
|
|
}
|
|
|
|
this.context.save();
|
|
this.context.setTransform(1, 0, 0, 1, 0, 0);
|
|
this.context.strokeStyle = color;
|
|
this.context.fillStyle = color;
|
|
this.context.font = this.font;
|
|
this.context.globalAlpha = 1;
|
|
|
|
},
|
|
|
|
/**
|
|
* Internal method that stops the debug output.
|
|
*
|
|
* @method Phaser.Utils.Debug#stop
|
|
* @protected
|
|
*/
|
|
stop: function () {
|
|
|
|
this.context.restore();
|
|
this.context.globalAlpha = this.currentAlpha;
|
|
|
|
if (this.sprite)
|
|
{
|
|
PIXI.updateWebGLTexture(this.baseTexture, this.game.renderer.gl);
|
|
}
|
|
|
|
},
|
|
|
|
/**
|
|
* Internal method that outputs a single line of text split over as many columns as needed, one per parameter.
|
|
*
|
|
* @method Phaser.Utils.Debug#line
|
|
* @protected
|
|
*/
|
|
line: function () {
|
|
|
|
var x = this.currentX;
|
|
|
|
for (var i = 0; i < arguments.length; i++)
|
|
{
|
|
if (this.renderShadow)
|
|
{
|
|
this.context.fillStyle = 'rgb(0,0,0)';
|
|
this.context.fillText(arguments[i], x + 1, this.currentY + 1);
|
|
this.context.fillStyle = this.currentColor;
|
|
}
|
|
|
|
this.context.fillText(arguments[i], x, this.currentY);
|
|
|
|
x += this.columnWidth;
|
|
}
|
|
|
|
this.currentY += this.lineHeight;
|
|
|
|
},
|
|
|
|
/**
|
|
* Render Sound information, including decoded state, duration, volume and more.
|
|
*
|
|
* @method Phaser.Utils.Debug#soundInfo
|
|
* @param {Phaser.Sound} sound - The sound object to debug.
|
|
* @param {number} x - X position of the debug info to be rendered.
|
|
* @param {number} y - Y position of the debug info to be rendered.
|
|
* @param {string} [color='rgb(255,255,255)'] - color of the debug info to be rendered. (format is css color string).
|
|
*/
|
|
soundInfo: function (sound, x, y, color) {
|
|
|
|
this.start(x, y, color);
|
|
this.line('Sound: ' + sound.key + ' Locked: ' + sound.game.sound.touchLocked);
|
|
this.line('Is Ready?: ' + this.game.cache.isSoundReady(sound.key) + ' Pending Playback: ' + sound.pendingPlayback);
|
|
this.line('Decoded: ' + sound.isDecoded + ' Decoding: ' + sound.isDecoding);
|
|
this.line('Total Duration: ' + sound.totalDuration + ' Playing: ' + sound.isPlaying);
|
|
this.line('Time: ' + sound.currentTime);
|
|
this.line('Volume: ' + sound.volume + ' Muted: ' + sound.mute);
|
|
this.line('WebAudio: ' + sound.usingWebAudio + ' Audio: ' + sound.usingAudioTag);
|
|
|
|
if (sound.currentMarker !== '')
|
|
{
|
|
this.line('Marker: ' + sound.currentMarker + ' Duration: ' + sound.duration);
|
|
this.line('Start: ' + sound.markers[sound.currentMarker].start + ' Stop: ' + sound.markers[sound.currentMarker].stop);
|
|
this.line('Position: ' + sound.position);
|
|
}
|
|
|
|
this.stop();
|
|
|
|
},
|
|
|
|
/**
|
|
* Render camera information including dimensions and location.
|
|
*
|
|
* @method Phaser.Utils.Debug#cameraInfo
|
|
* @param {Phaser.Camera} camera - The Phaser.Camera to show the debug information for.
|
|
* @param {number} x - X position of the debug info to be rendered.
|
|
* @param {number} y - Y position of the debug info to be rendered.
|
|
* @param {string} [color='rgb(255,255,255)'] - color of the debug info to be rendered. (format is css color string).
|
|
*/
|
|
cameraInfo: function (camera, x, y, color) {
|
|
|
|
this.start(x, y, color);
|
|
this.line('Camera (' + camera.width + ' x ' + camera.height + ')');
|
|
this.line('X: ' + camera.x + ' Y: ' + camera.y);
|
|
this.line('Bounds x: ' + camera.bounds.x + ' Y: ' + camera.bounds.y + ' w: ' + camera.bounds.width + ' h: ' + camera.bounds.height);
|
|
this.line('View x: ' + camera.view.x + ' Y: ' + camera.view.y + ' w: ' + camera.view.width + ' h: ' + camera.view.height);
|
|
this.stop();
|
|
|
|
},
|
|
|
|
/**
|
|
* Renders the Pointer.circle object onto the stage in green if down or red if up along with debug text.
|
|
*
|
|
* @method Phaser.Utils.Debug#pointer
|
|
* @param {Phaser.Pointer} pointer - The Pointer you wish to display.
|
|
* @param {boolean} [hideIfUp=false] - Doesn't render the circle if the pointer is up.
|
|
* @param {string} [downColor='rgba(0,255,0,0.5)'] - The color the circle is rendered in if down.
|
|
* @param {string} [upColor='rgba(255,0,0,0.5)'] - The color the circle is rendered in if up (and hideIfUp is false).
|
|
* @param {string} [color='rgb(255,255,255)'] - color of the debug info to be rendered. (format is css color string).
|
|
*/
|
|
pointer: function (pointer, hideIfUp, downColor, upColor, color) {
|
|
|
|
if (pointer == null)
|
|
{
|
|
return;
|
|
}
|
|
|
|
if (typeof hideIfUp === 'undefined') { hideIfUp = false; }
|
|
downColor = downColor || 'rgba(0,255,0,0.5)';
|
|
upColor = upColor || 'rgba(255,0,0,0.5)';
|
|
|
|
if (hideIfUp === true && pointer.isUp === true)
|
|
{
|
|
return;
|
|
}
|
|
|
|
this.start(pointer.x, pointer.y - 100, color);
|
|
this.context.beginPath();
|
|
this.context.arc(pointer.x, pointer.y, pointer.circle.radius, 0, Math.PI * 2);
|
|
|
|
if (pointer.active)
|
|
{
|
|
this.context.fillStyle = downColor;
|
|
}
|
|
else
|
|
{
|
|
this.context.fillStyle = upColor;
|
|
}
|
|
|
|
this.context.fill();
|
|
this.context.closePath();
|
|
|
|
// Render the points
|
|
this.context.beginPath();
|
|
this.context.moveTo(pointer.positionDown.x, pointer.positionDown.y);
|
|
this.context.lineTo(pointer.position.x, pointer.position.y);
|
|
this.context.lineWidth = 2;
|
|
this.context.stroke();
|
|
this.context.closePath();
|
|
|
|
// Render the text
|
|
this.line('ID: ' + pointer.id + " Active: " + pointer.active);
|
|
this.line('World X: ' + pointer.worldX + " World Y: " + pointer.worldY);
|
|
this.line('Screen X: ' + pointer.x + " Screen Y: " + pointer.y);
|
|
this.line('Duration: ' + pointer.duration + " ms");
|
|
this.line('is Down: ' + pointer.isDown + " is Up: " + pointer.isUp);
|
|
this.stop();
|
|
|
|
},
|
|
|
|
/**
|
|
* Render Sprite Input Debug information.
|
|
*
|
|
* @method Phaser.Utils.Debug#spriteInputInfo
|
|
* @param {Phaser.Sprite|Phaser.Image} sprite - The sprite to display the input data for.
|
|
* @param {number} x - X position of the debug info to be rendered.
|
|
* @param {number} y - Y position of the debug info to be rendered.
|
|
* @param {string} [color='rgb(255,255,255)'] - color of the debug info to be rendered. (format is css color string).
|
|
*/
|
|
spriteInputInfo: function (sprite, x, y, color) {
|
|
|
|
this.start(x, y, color);
|
|
this.line('Sprite Input: (' + sprite.width + ' x ' + sprite.height + ')');
|
|
this.line('x: ' + sprite.input.pointerX().toFixed(1) + ' y: ' + sprite.input.pointerY().toFixed(1));
|
|
this.line('over: ' + sprite.input.pointerOver() + ' duration: ' + sprite.input.overDuration().toFixed(0));
|
|
this.line('down: ' + sprite.input.pointerDown() + ' duration: ' + sprite.input.downDuration().toFixed(0));
|
|
this.line('just over: ' + sprite.input.justOver() + ' just out: ' + sprite.input.justOut());
|
|
this.stop();
|
|
|
|
},
|
|
|
|
/**
|
|
* Renders Phaser.Key object information.
|
|
*
|
|
* @method Phaser.Utils.Debug#key
|
|
* @param {Phaser.Key} key - The Key to render the information for.
|
|
* @param {number} x - X position of the debug info to be rendered.
|
|
* @param {number} y - Y position of the debug info to be rendered.
|
|
* @param {string} [color='rgb(255,255,255)'] - color of the debug info to be rendered. (format is css color string).
|
|
*/
|
|
key: function (key, x, y, color) {
|
|
|
|
this.start(x, y, color, 150);
|
|
|
|
this.line('Key:', key.keyCode, 'isDown:', key.isDown);
|
|
this.line('justPressed:', key.justPressed(), 'justReleased:', key.justReleased());
|
|
this.line('Time Down:', key.timeDown.toFixed(0), 'duration:', key.duration.toFixed(0));
|
|
|
|
this.stop();
|
|
|
|
},
|
|
|
|
/**
|
|
* Render debug information about the Input object.
|
|
*
|
|
* @method Phaser.Utils.Debug#inputInfo
|
|
* @param {number} x - X position of the debug info to be rendered.
|
|
* @param {number} y - Y position of the debug info to be rendered.
|
|
* @param {string} [color='rgb(255,255,255)'] - color of the debug info to be rendered. (format is css color string).
|
|
*/
|
|
inputInfo: function (x, y, color) {
|
|
|
|
this.start(x, y, color);
|
|
this.line('Input');
|
|
this.line('X: ' + this.game.input.x + ' Y: ' + this.game.input.y);
|
|
this.line('World X: ' + this.game.input.worldX + ' World Y: ' + this.game.input.worldY);
|
|
this.line('Scale X: ' + this.game.input.scale.x.toFixed(1) + ' Scale Y: ' + this.game.input.scale.x.toFixed(1));
|
|
this.line('Screen X: ' + this.game.input.activePointer.screenX + ' Screen Y: ' + this.game.input.activePointer.screenY);
|
|
this.stop();
|
|
|
|
},
|
|
|
|
/**
|
|
* Renders the Sprites bounds. Note: This is really expensive as it has to calculate the bounds every time you call it!
|
|
*
|
|
* @method Phaser.Utils.Debug#spriteBounds
|
|
* @param {Phaser.Sprite|Phaser.Image} sprite - The sprite to display the bounds of.
|
|
* @param {string} [color] - Color of the debug info to be rendered (format is css color string).
|
|
* @param {boolean} [filled=true] - Render the rectangle as a fillRect (default, true) or a strokeRect (false)
|
|
*/
|
|
spriteBounds: function (sprite, color, filled) {
|
|
|
|
var bounds = sprite.getBounds();
|
|
|
|
bounds.x += this.game.camera.x;
|
|
bounds.y += this.game.camera.y;
|
|
|
|
this.rectangle(bounds, color, filled);
|
|
|
|
},
|
|
|
|
/**
|
|
* Render debug infos (including name, bounds info, position and some other properties) about the Sprite.
|
|
*
|
|
* @method Phaser.Utils.Debug#spriteInfo
|
|
* @param {Phaser.Sprite} sprite - The Sprite to display the information of.
|
|
* @param {number} x - X position of the debug info to be rendered.
|
|
* @param {number} y - Y position of the debug info to be rendered.
|
|
* @param {string} [color='rgb(255,255,255)'] - color of the debug info to be rendered. (format is css color string).
|
|
*/
|
|
spriteInfo: function (sprite, x, y, color) {
|
|
|
|
this.start(x, y, color);
|
|
|
|
this.line('Sprite: ' + ' (' + sprite.width + ' x ' + sprite.height + ') anchor: ' + sprite.anchor.x + ' x ' + sprite.anchor.y);
|
|
this.line('x: ' + sprite.x.toFixed(1) + ' y: ' + sprite.y.toFixed(1));
|
|
this.line('angle: ' + sprite.angle.toFixed(1) + ' rotation: ' + sprite.rotation.toFixed(1));
|
|
this.line('visible: ' + sprite.visible + ' in camera: ' + sprite.inCamera);
|
|
|
|
this.stop();
|
|
|
|
},
|
|
|
|
/**
|
|
* Renders the sprite coordinates in local, positional and world space.
|
|
*
|
|
* @method Phaser.Utils.Debug#spriteCoords
|
|
* @param {Phaser.Sprite|Phaser.Image} sprite - The sprite to display the coordinates for.
|
|
* @param {number} x - X position of the debug info to be rendered.
|
|
* @param {number} y - Y position of the debug info to be rendered.
|
|
* @param {string} [color='rgb(255,255,255)'] - color of the debug info to be rendered. (format is css color string).
|
|
*/
|
|
spriteCoords: function (sprite, x, y, color) {
|
|
|
|
this.start(x, y, color, 100);
|
|
|
|
if (sprite.name)
|
|
{
|
|
this.line(sprite.name);
|
|
}
|
|
|
|
this.line('x:', sprite.x.toFixed(2), 'y:', sprite.y.toFixed(2));
|
|
this.line('pos x:', sprite.position.x.toFixed(2), 'pos y:', sprite.position.y.toFixed(2));
|
|
this.line('world x:', sprite.world.x.toFixed(2), 'world y:', sprite.world.y.toFixed(2));
|
|
|
|
this.stop();
|
|
|
|
},
|
|
|
|
/**
|
|
* Renders Line information in the given color.
|
|
*
|
|
* @method Phaser.Utils.Debug#lineInfo
|
|
* @param {Phaser.Line} line - The Line to display the data for.
|
|
* @param {number} x - X position of the debug info to be rendered.
|
|
* @param {number} y - Y position of the debug info to be rendered.
|
|
* @param {string} [color='rgb(255,255,255)'] - color of the debug info to be rendered. (format is css color string).
|
|
*/
|
|
lineInfo: function (line, x, y, color) {
|
|
|
|
this.start(x, y, color, 80);
|
|
this.line('start.x:', line.start.x.toFixed(2), 'start.y:', line.start.y.toFixed(2));
|
|
this.line('end.x:', line.end.x.toFixed(2), 'end.y:', line.end.y.toFixed(2));
|
|
this.line('length:', line.length.toFixed(2), 'angle:', line.angle);
|
|
this.stop();
|
|
|
|
},
|
|
|
|
/**
|
|
* Renders a single pixel at the given size.
|
|
*
|
|
* @method Phaser.Utils.Debug#pixel
|
|
* @param {number} x - X position of the pixel to be rendered.
|
|
* @param {number} y - Y position of the pixel to be rendered.
|
|
* @param {string} [color] - Color of the pixel (format is css color string).
|
|
* @param {number} [size=2] - The 'size' to render the pixel at.
|
|
*/
|
|
pixel: function (x, y, color, size) {
|
|
|
|
size = size || 2;
|
|
|
|
this.start();
|
|
this.context.fillStyle = color;
|
|
this.context.fillRect(x, y, size, size);
|
|
this.stop();
|
|
|
|
},
|
|
|
|
/**
|
|
* Renders a Phaser geometry object including Rectangle, Circle, Point or Line.
|
|
*
|
|
* @method Phaser.Utils.Debug#geom
|
|
* @param {Phaser.Rectangle|Phaser.Circle|Phaser.Point|Phaser.Line} object - The geometry object to render.
|
|
* @param {string} [color] - Color of the debug info to be rendered (format is css color string).
|
|
* @param {boolean} [filled=true] - Render the objected as a filled (default, true) or a stroked (false)
|
|
* @param {number} [forceType=0] - Force rendering of a specific type. If 0 no type will be forced, otherwise 1 = Rectangle, 2 = Circle, 3 = Point and 4 = Line.
|
|
*/
|
|
geom: function (object, color, filled, forceType) {
|
|
|
|
if (typeof filled === 'undefined') { filled = true; }
|
|
if (typeof forceType === 'undefined') { forceType = 0; }
|
|
|
|
color = color || 'rgba(0,255,0,0.4)';
|
|
|
|
this.start();
|
|
|
|
this.context.fillStyle = color;
|
|
this.context.strokeStyle = color;
|
|
|
|
if (object instanceof Phaser.Rectangle || forceType === 1)
|
|
{
|
|
if (filled)
|
|
{
|
|
this.context.fillRect(object.x - this.game.camera.x, object.y - this.game.camera.y, object.width, object.height);
|
|
}
|
|
else
|
|
{
|
|
this.context.strokeRect(object.x - this.game.camera.x, object.y - this.game.camera.y, object.width, object.height);
|
|
}
|
|
}
|
|
else if (object instanceof Phaser.Circle || forceType === 2)
|
|
{
|
|
this.context.beginPath();
|
|
this.context.arc(object.x - this.game.camera.x, object.y - this.game.camera.y, object.radius, 0, Math.PI * 2, false);
|
|
this.context.closePath();
|
|
|
|
if (filled)
|
|
{
|
|
this.context.fill();
|
|
}
|
|
else
|
|
{
|
|
this.context.stroke();
|
|
}
|
|
}
|
|
else if (object instanceof Phaser.Point || forceType === 3)
|
|
{
|
|
this.context.fillRect(object.x - this.game.camera.x, object.y - this.game.camera.y, 4, 4);
|
|
}
|
|
else if (object instanceof Phaser.Line || forceType === 4)
|
|
{
|
|
this.context.lineWidth = 1;
|
|
this.context.beginPath();
|
|
this.context.moveTo((object.start.x + 0.5) - this.game.camera.x, (object.start.y + 0.5) - this.game.camera.y);
|
|
this.context.lineTo((object.end.x + 0.5) - this.game.camera.x, (object.end.y + 0.5) - this.game.camera.y);
|
|
this.context.closePath();
|
|
this.context.stroke();
|
|
}
|
|
|
|
this.stop();
|
|
|
|
},
|
|
|
|
/**
|
|
* Renders a Rectangle.
|
|
*
|
|
* @method Phaser.Utils.Debug#geom
|
|
* @param {Phaser.Rectangle|object} object - The geometry object to render.
|
|
* @param {string} [color] - Color of the debug info to be rendered (format is css color string).
|
|
* @param {boolean} [filled=true] - Render the objected as a filled (default, true) or a stroked (false)
|
|
*/
|
|
rectangle: function (object, color, filled) {
|
|
|
|
if (typeof filled === 'undefined') { filled = true; }
|
|
|
|
color = color || 'rgba(0, 255, 0, 0.4)';
|
|
|
|
this.start();
|
|
|
|
if (filled)
|
|
{
|
|
this.context.fillStyle = color;
|
|
this.context.fillRect(object.x - this.game.camera.x, object.y - this.game.camera.y, object.width, object.height);
|
|
}
|
|
else
|
|
{
|
|
this.context.strokeStyle = color;
|
|
this.context.strokeRect(object.x - this.game.camera.x, object.y - this.game.camera.y, object.width, object.height);
|
|
}
|
|
|
|
this.stop();
|
|
|
|
},
|
|
|
|
/**
|
|
* Render a string of text.
|
|
*
|
|
* @method Phaser.Utils.Debug#text
|
|
* @param {string} text - The line of text to draw.
|
|
* @param {number} x - X position of the debug info to be rendered.
|
|
* @param {number} y - Y position of the debug info to be rendered.
|
|
* @param {string} [color] - Color of the debug info to be rendered (format is css color string).
|
|
* @param {string} [font] - The font of text to draw.
|
|
*/
|
|
text: function (text, x, y, color, font) {
|
|
|
|
color = color || 'rgb(255,255,255)';
|
|
font = font || '16px Courier';
|
|
|
|
this.start();
|
|
this.context.font = font;
|
|
|
|
if (this.renderShadow)
|
|
{
|
|
this.context.fillStyle = 'rgb(0,0,0)';
|
|
this.context.fillText(text, x + 1, y + 1);
|
|
}
|
|
|
|
this.context.fillStyle = color;
|
|
this.context.fillText(text, x, y);
|
|
|
|
this.stop();
|
|
|
|
},
|
|
|
|
/**
|
|
* Visually renders a QuadTree to the display.
|
|
*
|
|
* @method Phaser.Utils.Debug#quadTree
|
|
* @param {Phaser.QuadTree} quadtree - The quadtree to render.
|
|
* @param {string} color - The color of the lines in the quadtree.
|
|
*/
|
|
quadTree: function (quadtree, color) {
|
|
|
|
color = color || 'rgba(255,0,0,0.3)';
|
|
|
|
this.start();
|
|
|
|
var bounds = quadtree.bounds;
|
|
|
|
if (quadtree.nodes.length === 0)
|
|
{
|
|
this.context.strokeStyle = color;
|
|
this.context.strokeRect(bounds.x, bounds.y, bounds.width, bounds.height);
|
|
this.text('size: ' + quadtree.objects.length, bounds.x + 4, bounds.y + 16, 'rgb(0,200,0)', '12px Courier');
|
|
|
|
this.context.strokeStyle = 'rgb(0,255,0)';
|
|
|
|
for (var i = 0; i < quadtree.objects.length; i++)
|
|
{
|
|
this.context.strokeRect(quadtree.objects[i].x, quadtree.objects[i].y, quadtree.objects[i].width, quadtree.objects[i].height);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
for (var i = 0; i < quadtree.nodes.length; i++)
|
|
{
|
|
this.quadTree(quadtree.nodes[i]);
|
|
}
|
|
}
|
|
|
|
this.stop();
|
|
|
|
},
|
|
|
|
/**
|
|
* Render a Sprites Physics body if it has one set. Note this only works for Arcade Physics.
|
|
* To display a P2 body you should enable debug mode on the body when creating it.
|
|
*
|
|
* @method Phaser.Utils.Debug#body
|
|
* @param {Phaser.Sprite} sprite - The sprite whos body will be rendered.
|
|
* @param {string} [color='rgb(255,255,255)'] - color of the debug info to be rendered. (format is css color string).
|
|
* @param {boolean} [filled=true] - Render the objected as a filled (default, true) or a stroked (false)
|
|
*/
|
|
body: function (sprite, color, filled) {
|
|
|
|
if (sprite.body)
|
|
{
|
|
if (sprite.body.type === Phaser.Physics.ARCADE)
|
|
{
|
|
this.start();
|
|
Phaser.Physics.Arcade.Body.render(this.context, sprite.body, color, filled);
|
|
this.stop();
|
|
}
|
|
}
|
|
|
|
},
|
|
|
|
/**
|
|
* Render a Sprites Physic Body information.
|
|
*
|
|
* @method Phaser.Utils.Debug#bodyInfo
|
|
* @param {Phaser.Sprite} sprite - The sprite to be rendered.
|
|
* @param {number} x - X position of the debug info to be rendered.
|
|
* @param {number} y - Y position of the debug info to be rendered.
|
|
* @param {string} [color='rgb(255,255,255)'] - color of the debug info to be rendered. (format is css color string).
|
|
*/
|
|
bodyInfo: function (sprite, x, y, color) {
|
|
|
|
if (sprite.body)
|
|
{
|
|
if (sprite.body.type === Phaser.Physics.ARCADE)
|
|
{
|
|
this.start(x, y, color, 210);
|
|
Phaser.Physics.Arcade.Body.renderBodyInfo(this, sprite.body);
|
|
this.stop();
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
};
|
|
|
|
Phaser.Utils.Debug.prototype.constructor = Phaser.Utils.Debug;
|
|
</pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="clearfix"></div>
|
|
<footer>
|
|
|
|
|
|
<span class="copyright">
|
|
Phaser Copyright © 2012-2014 Photon Storm Ltd.
|
|
</span>
|
|
<br />
|
|
|
|
<span class="jsdoc-message">
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
|
|
on Mon Mar 24 2014 12:38:38 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
|
|
</span>
|
|
</footer>
|
|
</div>
|
|
|
|
|
|
<br clear="both">
|
|
</div>
|
|
|
|
</div>
|
|
<script src="scripts/sunlight.js"></script>
|
|
<script src="scripts/sunlight.javascript.js"></script>
|
|
<script src="scripts/sunlight-plugin.doclinks.js"></script>
|
|
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
|
|
<script src="scripts/sunlight-plugin.menu.js"></script>
|
|
<script src="scripts/jquery.min.js"></script>
|
|
<script src="scripts/jquery.scrollTo.js"></script>
|
|
<script src="scripts/jquery.localScroll.js"></script>
|
|
<script src="scripts/bootstrap-dropdown.js"></script>
|
|
<script src="scripts/toc.js"></script>
|
|
|
|
|
|
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
|
|
|
|
<script>
|
|
$( function () {
|
|
$( "#toc" ).toc( {
|
|
anchorName : function(i, heading, prefix) {
|
|
return $(heading).attr("id") || ( prefix + i );
|
|
},
|
|
selectors : "h1,h2,h3,h4",
|
|
showAndHide : false,
|
|
scrollTo : 60
|
|
} );
|
|
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
|
|
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
|
|
|
} );
|
|
</script>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|