<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Phaser Class: Debug</title> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/default.css"> <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 style="position: absolute; width: 143px; height: 31px; right: 10px; top: 10px; z-index: 1050"><a href="http://phaser.io"><img src="img/phaser.png" border="0" /></a></div> <div class="navbar-inner"> <a class="brand" href="index.html">Phaser API</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 class="class-depth-0"> <a href="Phaser.html">Phaser</a> </li> <li class="class-depth-0"> <a href="PIXI.html">PIXI</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 class="class-depth-0"> <a href="EarCut.html">EarCut</a> </li> <li class="class-depth-0"> <a href="Event.html">Event</a> </li> <li class="class-depth-0"> <a href="EventTarget.html">EventTarget</a> </li> <li class="class-depth-1"> <a href="Phaser.Animation.html">Animation</a> </li> <li class="class-depth-1"> <a href="Phaser.AnimationManager.html">AnimationManager</a> </li> <li class="class-depth-1"> <a href="Phaser.AnimationParser.html">AnimationParser</a> </li> <li class="class-depth-1"> <a href="Phaser.ArraySet.html">ArraySet</a> </li> <li class="class-depth-1"> <a href="Phaser.ArrayUtils.html">ArrayUtils</a> </li> <li class="class-depth-1"> <a href="Phaser.AudioSprite.html">AudioSprite</a> </li> <li class="class-depth-1"> <a href="Phaser.BitmapData.html">BitmapData</a> </li> <li class="class-depth-1"> <a href="Phaser.BitmapText.html">BitmapText</a> </li> <li class="class-depth-1"> <a href="Phaser.Bullet.html">Bullet</a> </li> <li class="class-depth-1"> <a href="Phaser.Button.html">Button</a> </li> <li class="class-depth-1"> <a href="Phaser.Cache.html">Cache</a> </li> <li class="class-depth-1"> <a href="Phaser.Camera.html">Camera</a> </li> <li class="class-depth-1"> <a href="Phaser.Canvas.html">Canvas</a> </li> <li class="class-depth-1"> <a href="Phaser.CanvasPool.html">CanvasPool</a> </li> <li class="class-depth-1"> <a href="Phaser.Circle.html">Circle</a> </li> <li class="class-depth-1"> <a href="Phaser.Color.html">Color</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Angle.html">Angle</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Animation.html">Animation</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.AutoCull.html">AutoCull</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Bounds.html">Bounds</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.BringToTop.html">BringToTop</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Core.html">Core</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Crop.html">Crop</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Delta.html">Delta</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Destroy.html">Destroy</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.FixedToCamera.html">FixedToCamera</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Health.html">Health</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.InCamera.html">InCamera</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.InputEnabled.html">InputEnabled</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.InWorld.html">InWorld</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.LifeSpan.html">LifeSpan</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.LoadTexture.html">LoadTexture</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Overlap.html">Overlap</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.PhysicsBody.html">PhysicsBody</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Reset.html">Reset</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.ScaleMinMax.html">ScaleMinMax</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Smoothed.html">Smoothed</a> </li> <li class="class-depth-1"> <a href="Phaser.Create.html">Create</a> </li> <li class="class-depth-1"> <a href="Phaser.Creature.html">Creature</a> </li> <li class="class-depth-1"> <a href="Phaser.Device.html">Device</a> </li> <li class="class-depth-1"> <a href="Phaser.DeviceButton.html">DeviceButton</a> </li> <li class="class-depth-1"> <a href="Phaser.DOM.html">DOM</a> </li> <li class="class-depth-1"> <a href="Phaser.Easing.html">Easing</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Back.html">Back</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Bounce.html">Bounce</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Circular.html">Circular</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Cubic.html">Cubic</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Elastic.html">Elastic</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Exponential.html">Exponential</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Linear.html">Linear</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Quadratic.html">Quadratic</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Quartic.html">Quartic</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Quintic.html">Quintic</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a> </li> <li class="class-depth-1"> <a href="Phaser.Ellipse.html">Ellipse</a> </li> <li class="class-depth-1"> <a href="Phaser.Events.html">Events</a> </li> <li class="class-depth-1"> <a href="Phaser.Filter.html">Filter</a> </li> <li class="class-depth-1"> <a href="Phaser.FlexGrid.html">FlexGrid</a> </li> <li class="class-depth-1"> <a href="Phaser.FlexLayer.html">FlexLayer</a> </li> <li class="class-depth-1"> <a href="Phaser.Frame.html">Frame</a> </li> <li class="class-depth-1"> <a href="Phaser.FrameData.html">FrameData</a> </li> <li class="class-depth-1"> <a href="Phaser.Game.html">Game</a> </li> <li class="class-depth-1"> <a href="Phaser.GameObjectCreator.html">GameObjectCreator</a> </li> <li class="class-depth-1"> <a href="Phaser.GameObjectFactory.html">GameObjectFactory</a> </li> <li class="class-depth-1"> <a href="Phaser.Gamepad.html">Gamepad</a> </li> <li class="class-depth-1"> <a href="Phaser.Graphics.html">Graphics</a> </li> <li class="class-depth-1"> <a href="Phaser.Group.html">Group</a> </li> <li class="class-depth-1"> <a href="Phaser.Hermite.html">Hermite</a> </li> <li class="class-depth-1"> <a href="Phaser.Image.html">Image</a> </li> <li class="class-depth-1"> <a href="Phaser.ImageCollection.html">ImageCollection</a> </li> <li class="class-depth-1"> <a href="Phaser.Input.html">Input</a> </li> <li class="class-depth-1"> <a href="Phaser.InputHandler.html">InputHandler</a> </li> <li class="class-depth-1"> <a href="Phaser.Key.html">Key</a> </li> <li class="class-depth-1"> <a href="Phaser.Keyboard.html">Keyboard</a> </li> <li class="class-depth-1"> <a href="Phaser.KeyCode.html">KeyCode</a> </li> <li class="class-depth-1"> <a href="Phaser.Line.html">Line</a> </li> <li class="class-depth-1"> <a href="Phaser.LinkedList.html">LinkedList</a> </li> <li class="class-depth-1"> <a href="Phaser.Loader.html">Loader</a> </li> <li class="class-depth-1"> <a href="Phaser.LoaderParser.html">LoaderParser</a> </li> <li class="class-depth-1"> <a href="Phaser.Math.html">Math</a> </li> <li class="class-depth-1"> <a href="Phaser.Matrix.html">Matrix</a> </li> <li class="class-depth-1"> <a href="Phaser.Mouse.html">Mouse</a> </li> <li class="class-depth-1"> <a href="Phaser.MSPointer.html">MSPointer</a> </li> <li class="class-depth-1"> <a href="Phaser.Net.html">Net</a> </li> <li class="class-depth-1"> <a href="Phaser.Particle.html">Particle</a> </li> <li class="class-depth-1"> <a href="Phaser.Particles.html">Particles</a> </li> <li class="class-depth-2"> <a href="Phaser.Particles.Arcade.html">Arcade</a> </li> <li class="class-depth-3"> <a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a> </li> <li class="class-depth-1"> <a href="Phaser.Path.html">Path</a> </li> <li class="class-depth-1"> <a href="Phaser.PathFollower.html">PathFollower</a> </li> <li class="class-depth-1"> <a href="Phaser.PathPoint.html">PathPoint</a> </li> <li class="class-depth-1"> <a href="Phaser.Physics.html">Physics</a> </li> <li class="class-depth-2"> <a href="Phaser.Physics.Arcade.html">Arcade</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.Arcade.Body.html">Body</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.Arcade.TilemapCollision.html">TilemapCollision</a> </li> <li class="class-depth-2"> <a href="Phaser.Physics.Ninja.html">Ninja</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.Ninja.AABB.html">AABB</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.Ninja.Body.html">Body</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.Ninja.Circle.html">Circle</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.Ninja.Tile.html">Tile</a> </li> <li class="class-depth-2"> <a href="Phaser.Physics.P2.html">P2</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.Body.html">Body</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.Material.html">Material</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.Spring.html">Spring</a> </li> <li class="class-depth-1"> <a href="Phaser.Plugin.html">Plugin</a> </li> <li class="class-depth-2"> <a href="Phaser.Plugin.PathManager.html">PathManager</a> </li> <li class="class-depth-1"> <a href="Phaser.PluginManager.html">PluginManager</a> </li> <li class="class-depth-1"> <a href="Phaser.Point.html">Point</a> </li> <li class="class-depth-1"> <a href="Phaser.Pointer.html">Pointer</a> </li> <li class="class-depth-1"> <a href="Phaser.PointerMode.html">PointerMode</a> </li> <li class="class-depth-1"> <a href="Phaser.Polygon.html">Polygon</a> </li> <li class="class-depth-1"> <a href="Phaser.QuadTree.html">QuadTree</a> </li> <li class="class-depth-1"> <a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a> </li> <li class="class-depth-1"> <a href="Phaser.Rectangle.html">Rectangle</a> </li> <li class="class-depth-1"> <a href="Phaser.RenderTexture.html">RenderTexture</a> </li> <li class="class-depth-1"> <a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a> </li> <li class="class-depth-1"> <a href="Phaser.RetroFont.html">RetroFont</a> </li> <li class="class-depth-1"> <a href="Phaser.Rope.html">Rope</a> </li> <li class="class-depth-1"> <a href="Phaser.RoundedRectangle.html">RoundedRectangle</a> </li> <li class="class-depth-1"> <a href="Phaser.ScaleManager.html">ScaleManager</a> </li> <li class="class-depth-1"> <a href="Phaser.Signal.html">Signal</a> </li> <li class="class-depth-1"> <a href="Phaser.SignalBinding.html">SignalBinding</a> </li> <li class="class-depth-1"> <a href="Phaser.SinglePad.html">SinglePad</a> </li> <li class="class-depth-1"> <a href="Phaser.Sound.html">Sound</a> </li> <li class="class-depth-1"> <a href="Phaser.SoundManager.html">SoundManager</a> </li> <li class="class-depth-1"> <a href="Phaser.Sprite.html">Sprite</a> </li> <li class="class-depth-1"> <a href="Phaser.SpriteBatch.html">SpriteBatch</a> </li> <li class="class-depth-1"> <a href="Phaser.Stage.html">Stage</a> </li> <li class="class-depth-1"> <a href="Phaser.State.html">State</a> </li> <li class="class-depth-1"> <a href="Phaser.StateManager.html">StateManager</a> </li> <li class="class-depth-1"> <a href="Phaser.Text.html">Text</a> </li> <li class="class-depth-1"> <a href="Phaser.Tile.html">Tile</a> </li> <li class="class-depth-1"> <a href="Phaser.Tilemap.html">Tilemap</a> </li> <li class="class-depth-1"> <a href="Phaser.TilemapLayer.html">TilemapLayer</a> </li> <li class="class-depth-1"> <a href="Phaser.TilemapParser.html">TilemapParser</a> </li> <li class="class-depth-1"> <a href="Phaser.Tileset.html">Tileset</a> </li> <li class="class-depth-1"> <a href="Phaser.TileSprite.html">TileSprite</a> </li> <li class="class-depth-1"> <a href="Phaser.Time.html">Time</a> </li> <li class="class-depth-1"> <a href="Phaser.Timer.html">Timer</a> </li> <li class="class-depth-1"> <a href="Phaser.TimerEvent.html">TimerEvent</a> </li> <li class="class-depth-1"> <a href="Phaser.Touch.html">Touch</a> </li> <li class="class-depth-1"> <a href="Phaser.Tween.html">Tween</a> </li> <li class="class-depth-1"> <a href="Phaser.TweenData.html">TweenData</a> </li> <li class="class-depth-1"> <a href="Phaser.TweenManager.html">TweenManager</a> </li> <li class="class-depth-1"> <a href="Phaser.Utils.html">Utils</a> </li> <li class="class-depth-2"> <a href="Phaser.Utils.Debug.html">Debug</a> </li> <li class="class-depth-1"> <a href="Phaser.Video.html">Video</a> </li> <li class="class-depth-1"> <a href="Phaser.Weapon.html">Weapon</a> </li> <li class="class-depth-1"> <a href="Phaser.World.html">World</a> </li> <li class="class-depth-1"> <a href="PIXI.BaseTexture.html">BaseTexture</a> </li> <li class="class-depth-1"> <a href="PIXI.CanvasBuffer.html">CanvasBuffer</a> </li> <li class="class-depth-1"> <a href="PIXI.CanvasGraphics.html">CanvasGraphics</a> </li> <li class="class-depth-1"> <a href="PIXI.CanvasMaskManager.html">CanvasMaskManager</a> </li> <li class="class-depth-1"> <a href="PIXI.CanvasRenderer.html">CanvasRenderer</a> </li> <li class="class-depth-1"> <a href="PIXI.CanvasTinter.html">CanvasTinter</a> </li> <li class="class-depth-1"> <a href="PIXI.ComplexPrimitiveShader.html">ComplexPrimitiveShader</a> </li> <li class="class-depth-1"> <a href="PIXI.DisplayObject.html">DisplayObject</a> </li> <li class="class-depth-1"> <a href="PIXI.DisplayObjectContainer.html">DisplayObjectContainer</a> </li> <li class="class-depth-1"> <a href="PIXI.FilterTexture.html">FilterTexture</a> </li> <li class="class-depth-2"> <a href="PIXI.Phaser.GraphicsData.html">Phaser.GraphicsData</a> </li> <li class="class-depth-1"> <a href="PIXI.PIXI.html">PIXI</a> </li> <li class="class-depth-1"> <a href="PIXI.PixiFastShader.html">PixiFastShader</a> </li> <li class="class-depth-1"> <a href="PIXI.PixiShader.html">PixiShader</a> </li> <li class="class-depth-1"> <a href="PIXI.PrimitiveShader.html">PrimitiveShader</a> </li> <li class="class-depth-1"> <a href="PIXI.Sprite.html">Sprite</a> </li> <li class="class-depth-1"> <a href="PIXI.StripShader.html">StripShader</a> </li> <li class="class-depth-1"> <a href="PIXI.Texture.html">Texture</a> </li> <li class="class-depth-1"> <a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a> </li> <li class="class-depth-1"> <a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a> </li> <li class="class-depth-1"> <a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a> </li> <li class="class-depth-1"> <a href="PIXI.WebGLRenderer.html">WebGLRenderer</a> </li> </ul> </li> <li class="dropdown"> <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a> <ul class="dropdown-menu "> <li class="class-depth-0"> <a href="global.html#ANGLE_DOWN">ANGLE_DOWN</a> </li> <li class="class-depth-0"> <a href="global.html#ANGLE_LEFT">ANGLE_LEFT</a> </li> <li class="class-depth-0"> <a href="global.html#ANGLE_NORTH_EAST">ANGLE_NORTH_EAST</a> </li> <li class="class-depth-0"> <a href="global.html#ANGLE_NORTH_WEST">ANGLE_NORTH_WEST</a> </li> <li class="class-depth-0"> <a href="global.html#ANGLE_RIGHT">ANGLE_RIGHT</a> </li> <li class="class-depth-0"> <a href="global.html#ANGLE_SOUTH_EAST">ANGLE_SOUTH_EAST</a> </li> <li class="class-depth-0"> <a href="global.html#ANGLE_SOUTH_WEST">ANGLE_SOUTH_WEST</a> </li> <li class="class-depth-0"> <a href="global.html#ANGLE_UP">ANGLE_UP</a> </li> <li class="class-depth-0"> <a href="global.html#arc">arc</a> </li> <li class="class-depth-0"> <a href="global.html#AUTO">AUTO</a> </li> <li class="class-depth-0"> <a href="global.html#beginFill">beginFill</a> </li> <li class="class-depth-0"> <a href="global.html#bezierCurveTo">bezierCurveTo</a> </li> <li class="class-depth-0"> <a href="global.html#BITMAPDATA">BITMAPDATA</a> </li> <li class="class-depth-0"> <a href="global.html#BITMAPTEXT">BITMAPTEXT</a> </li> <li class="class-depth-0"> <a href="global.html#blendModes">blendModes</a> </li> <li class="class-depth-0"> <a href="global.html#BOTTOM_CENTER">BOTTOM_CENTER</a> </li> <li class="class-depth-0"> <a href="global.html#BOTTOM_LEFT">BOTTOM_LEFT</a> </li> <li class="class-depth-0"> <a href="global.html#BOTTOM_RIGHT">BOTTOM_RIGHT</a> </li> <li class="class-depth-0"> <a href="global.html#BUTTON">BUTTON</a> </li> <li class="class-depth-0"> <a href="global.html#CANVAS">CANVAS</a> </li> <li class="class-depth-0"> <a href="global.html#CANVAS_FILTER">CANVAS_FILTER</a> </li> <li class="class-depth-0"> <a href="global.html#CENTER">CENTER</a> </li> <li class="class-depth-0"> <a href="global.html#CIRCLE">CIRCLE</a> </li> <li class="class-depth-0"> <a href="global.html#clear">clear</a> </li> <li class="class-depth-0"> <a href="global.html#CREATURE">CREATURE</a> </li> <li class="class-depth-0"> <a href="global.html#destroyCachedSprite">destroyCachedSprite</a> </li> <li class="class-depth-0"> <a href="global.html#displayList">displayList</a> </li> <li class="class-depth-0"> <a href="global.html#DOWN">DOWN</a> </li> <li class="class-depth-0"> <a href="global.html#drawCircle">drawCircle</a> </li> <li class="class-depth-0"> <a href="global.html#drawEllipse">drawEllipse</a> </li> <li class="class-depth-0"> <a href="global.html#drawPolygon">drawPolygon</a> </li> <li class="class-depth-0"> <a href="global.html#drawRect">drawRect</a> </li> <li class="class-depth-0"> <a href="global.html#drawRoundedRect">drawRoundedRect</a> </li> <li class="class-depth-0"> <a href="global.html#drawShape">drawShape</a> </li> <li class="class-depth-0"> <a href="global.html#ELLIPSE">ELLIPSE</a> </li> <li class="class-depth-0"> <a href="global.html#emit">emit</a> </li> <li class="class-depth-0"> <a href="global.html#EMITTER">EMITTER</a> </li> <li class="class-depth-0"> <a href="global.html#endFill">endFill</a> </li> <li class="class-depth-0"> <a href="global.html#GAMES">GAMES</a> </li> <li class="class-depth-0"> <a href="global.html#generateTexture">generateTexture</a> </li> <li class="class-depth-0"> <a href="global.html#getBounds">getBounds</a> </li> <li class="class-depth-0"> <a href="global.html#getLocalBounds">getLocalBounds</a> </li> <li class="class-depth-0"> <a href="global.html#GRAPHICS">GRAPHICS</a> </li> <li class="class-depth-0"> <a href="global.html#GROUP">GROUP</a> </li> <li class="class-depth-0"> <a href="global.html#HEADLESS">HEADLESS</a> </li> <li class="class-depth-0"> <a href="global.html#HORIZONTAL">HORIZONTAL</a> </li> <li class="class-depth-0"> <a href="global.html#IMAGE">IMAGE</a> </li> <li class="class-depth-0"> <a href="global.html#LANDSCAPE">LANDSCAPE</a> </li> <li class="class-depth-0"> <a href="global.html#LEFT">LEFT</a> </li> <li class="class-depth-0"> <a href="global.html#LEFT_BOTTOM">LEFT_BOTTOM</a> </li> <li class="class-depth-0"> <a href="global.html#LEFT_CENTER">LEFT_CENTER</a> </li> <li class="class-depth-0"> <a href="global.html#LEFT_TOP">LEFT_TOP</a> </li> <li class="class-depth-0"> <a href="global.html#LINE">LINE</a> </li> <li class="class-depth-0"> <a href="global.html#lineStyle">lineStyle</a> </li> <li class="class-depth-0"> <a href="global.html#lineTo">lineTo</a> </li> <li class="class-depth-0"> <a href="global.html#listeners">listeners</a> </li> <li class="class-depth-0"> <a href="global.html#MATRIX">MATRIX</a> </li> <li class="class-depth-0"> <a href="global.html#mixin">mixin</a> </li> <li class="class-depth-0"> <a href="global.html#moveTo">moveTo</a> </li> <li class="class-depth-0"> <a href="global.html#NONE">NONE</a> </li> <li class="class-depth-0"> <a href="global.html#off">off</a> </li> <li class="class-depth-0"> <a href="global.html#on">on</a> </li> <li class="class-depth-0"> <a href="global.html#once">once</a> </li> <li class="class-depth-0"> <a href="global.html#PENDING_ATLAS">PENDING_ATLAS</a> </li> <li class="class-depth-2"> <a href="global.html#Phaser.Path#numPointsreturn%257Bnumber%257DThetotalnumberofPathPointsinthisPath.">Phaser.Path#numPoints return {number} The total number of PathPoints in this Path.</a> </li> <li class="class-depth-0"> <a href="global.html#POINT">POINT</a> </li> <li class="class-depth-0"> <a href="global.html#POINTER">POINTER</a> </li> <li class="class-depth-0"> <a href="global.html#POLYGON">POLYGON</a> </li> <li class="class-depth-0"> <a href="global.html#PORTRAIT">PORTRAIT</a> </li> <li class="class-depth-0"> <a href="global.html#quadraticCurveTo">quadraticCurveTo</a> </li> <li class="class-depth-0"> <a href="global.html#RECTANGLE">RECTANGLE</a> </li> <li class="class-depth-0"> <a href="global.html#removeAllListeners">removeAllListeners</a> </li> <li class="class-depth-0"> <a href="global.html#RENDERTEXTURE">RENDERTEXTURE</a> </li> <li class="class-depth-0"> <a href="global.html#RETROFONT">RETROFONT</a> </li> <li class="class-depth-0"> <a href="global.html#RIGHT">RIGHT</a> </li> <li class="class-depth-0"> <a href="global.html#RIGHT_BOTTOM">RIGHT_BOTTOM</a> </li> <li class="class-depth-0"> <a href="global.html#RIGHT_CENTER">RIGHT_CENTER</a> </li> <li class="class-depth-0"> <a href="global.html#RIGHT_TOP">RIGHT_TOP</a> </li> <li class="class-depth-0"> <a href="global.html#ROPE">ROPE</a> </li> <li class="class-depth-0"> <a href="global.html#ROUNDEDRECTANGLE">ROUNDEDRECTANGLE</a> </li> <li class="class-depth-0"> <a href="global.html#scaleModes">scaleModes</a> </li> <li class="class-depth-0"> <a href="global.html#SPRITE">SPRITE</a> </li> <li class="class-depth-0"> <a href="global.html#SPRITEBATCH">SPRITEBATCH</a> </li> <li class="class-depth-0"> <a href="global.html#stopImmediatePropagation">stopImmediatePropagation</a> </li> <li class="class-depth-0"> <a href="global.html#stopPropagation">stopPropagation</a> </li> <li class="class-depth-0"> <a href="global.html#TEXT">TEXT</a> </li> <li class="class-depth-0"> <a href="global.html#TILEMAP">TILEMAP</a> </li> <li class="class-depth-0"> <a href="global.html#TILEMAPLAYER">TILEMAPLAYER</a> </li> <li class="class-depth-0"> <a href="global.html#TILESPRITE">TILESPRITE</a> </li> <li class="class-depth-0"> <a href="global.html#TOP_CENTER">TOP_CENTER</a> </li> <li class="class-depth-0"> <a href="global.html#TOP_LEFT">TOP_LEFT</a> </li> <li class="class-depth-0"> <a href="global.html#TOP_RIGHT">TOP_RIGHT</a> </li> <li class="class-depth-0"> <a href="global.html#UP">UP</a> </li> <li class="class-depth-0"> <a href="global.html#updateLocalBounds">updateLocalBounds</a> </li> <li class="class-depth-0"> <a href="global.html#VERSION">VERSION</a> </li> <li class="class-depth-0"> <a href="global.html#VERTICAL">VERTICAL</a> </li> <li class="class-depth-0"> <a href="global.html#VIDEO">VIDEO</a> </li> <li class="class-depth-0"> <a href="global.html#WEBGL">WEBGL</a> </li> <li class="class-depth-0"> <a href="global.html#WEBGL_FILTER">WEBGL_FILTER</a> </li> <li class="class-depth-0"> <a href="global.html#WEBGL_MULTI">WEBGL_MULTI</a> </li> </ul> </li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Core<b class="caret"></b></a> <ul class="dropdown-menu "> <li class="class-depth-1"><a href="Phaser.Game.html">Game</a></li> <li class="class-depth-1"><a href="Phaser.Group.html">Group</a></li> <li class="class-depth-1"><a href="Phaser.World.html">World</a></li> <li class="class-depth-1"><a href="Phaser.Loader.html">Loader</a></li> <li class="class-depth-1"><a href="Phaser.Cache.html">Cache</a></li> <li class="class-depth-1"><a href="Phaser.Time.html">Time</a></li> <li class="class-depth-1"><a href="Phaser.Camera.html">Camera</a></li> <li class="class-depth-1"><a href="Phaser.StateManager.html">State Manager</a></li> <li class="class-depth-1"><a href="Phaser.TweenManager.html">Tween Manager</a></li> <li class="class-depth-1"><a href="Phaser.SoundManager.html">Sound Manager</a></li> <li class="class-depth-1"><a href="Phaser.Input.html">Input Manager</a></li> <li class="class-depth-1"><a href="Phaser.ScaleManager.html">Scale Manager</a></li> </ul> </li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Game Objects<b class="caret"></b></a> <ul class="dropdown-menu "> <li class="class-depth-1"><a href="Phaser.GameObjectFactory.html">Factory (game.add)</a></li> <li class="class-depth-1"><a href="Phaser.GameObjectCreator.html">Creator (game.make)</a></li> <li class="class-depth-1"><a href="Phaser.Sprite.html">Sprite</a></li> <li class="class-depth-1"><a href="Phaser.Image.html">Image</a></li> <li class="class-depth-1"><a href="Phaser.Sound.html">Sound</a></li> <li class="class-depth-1"><a href="Phaser.Video.html">Video</a></li> <li class="class-depth-1"><a href="Phaser.Particles.Arcade.Emitter.html">Particle Emitter</a></li> <li class="class-depth-1"><a href="Phaser.Particle.html">Particle</a></li> <li class="class-depth-1"><a href="Phaser.Text.html">Text</a></li> <li class="class-depth-1"><a href="Phaser.Tween.html">Tween</a></li> <li class="class-depth-1"><a href="Phaser.BitmapText.html">BitmapText</a></li> <li class="class-depth-1"><a href="Phaser.Tilemap.html">Tilemap</a></li> <li class="class-depth-1"><a href="Phaser.BitmapData.html">BitmapData</a></li> <li class="class-depth-1"><a href="Phaser.RetroFont.html">RetroFont</a></li> <li class="class-depth-1"><a href="Phaser.Button.html">Button</a></li> <li class="class-depth-1"><a href="Phaser.Animation.html">Animation</a></li> <li class="class-depth-1"><a href="Phaser.Graphics.html">Graphics</a></li> <li class="class-depth-1"><a href="Phaser.RenderTexture.html">RenderTexture</a></li> <li class="class-depth-1"><a href="Phaser.TileSprite.html">TileSprite</a></li> </ul> </li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Geometry<b class="caret"></b></a> <ul class="dropdown-menu "> <li class="class-depth-1"><a href="Phaser.Circle.html">Circle</a></li> <li class="class-depth-1"><a href="Phaser.Ellipse.html">Ellipse</a></li> <li class="class-depth-1"><a href="Phaser.Line.html">Line</a></li> <li class="class-depth-1"><a href="Phaser.Matrix.html">Matrix</a></li> <li class="class-depth-1"><a href="Phaser.Point.html">Point</a></li> <li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</a></li> <li class="class-depth-1"><a href="Phaser.Rectangle.html">Rectangle</a></li> <li class="class-depth-1"><a href="Phaser.RoundedRectangle.html">Rounded Rectangle</a></li> </ul> </li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Physics<b class="caret"></b></a> <ul class="dropdown-menu "> <li class="class-depth-1"><a href="Phaser.Physics.Arcade.html">Arcade Physics</a></li> <li class="class-depth-2"><a href="Phaser.Physics.Arcade.Body.html">Body</a></li> <li class="class-depth-2"><a href="Phaser.Weapon.html">Weapon</a></li> <li class="class-depth-1"><a href="Phaser.Physics.P2.html">P2 Physics</a></li> <li class="class-depth-2"><a href="Phaser.Physics.P2.Body.html">Body</a></li> <li class="class-depth-2"><a href="Phaser.Physics.P2.Spring.html">Spring</a></li> <li class="class-depth-2"><a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a></li> <li class="class-depth-2"><a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a></li> <li class="class-depth-1"><a href="Phaser.Physics.Ninja.html">Ninja Physics</a></li> <li class="class-depth-2"><a href="Phaser.Physics.Body.html">Body</a></li> </ul> </li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Input<b class="caret"></b></a> <ul class="dropdown-menu "> <li class="class-depth-1"><a href="Phaser.InputHandler.html">Input Handler</a></li> <li class="class-depth-1"><a href="Phaser.Pointer.html">Pointer</a></li> <li class="class-depth-1"><a href="Phaser.DeviceButton.html">Device Button</a></li> <li class="class-depth-1"><a href="Phaser.Mouse.html">Mouse</a></li> <li class="class-depth-1"><a href="Phaser.Keyboard.html">Keyboard</a></li> <li class="class-depth-1"><a href="Phaser.Key.html">Key</a></li> <li class="class-depth-1"><a href="Phaser.KeyCode.html">Key Codes</a></li> <li class="class-depth-1"><a href="Phaser.Gamepad.html">Gamepad</a></li> </ul> </li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Community<b class="caret"></b></a> <ul class="dropdown-menu "> <li class="class-depth-1"><a href="http://phaser.io">Phaser Web Site</a></li> <li class="class-depth-1"><a href="https://github.com/photonstorm/phaser">Phaser Github</a></li> <li class="class-depth-1"><a href="http://phaser.io/examples">Phaser Examples</a></li> <li class="class-depth-1"><a href="https://github.com/photonstorm/phaser-plugins">Phaser Plugins</a></li> <li class="class-depth-1"><a href="http://www.html5gamedevs.com/forum/14-phaser/">Forum</a></li> <li class="class-depth-1"><a href="http://stackoverflow.com/questions/tagged/phaser-framework">Stack Overflow</a></li> <li class="class-depth-1"><a href="http://phaser.io/learn">Tutorials</a></li> <li class="class-depth-1"><a href="http://phaser.io/community/newsletter">Newsletter</a></li> <li class="class-depth-1"><a href="http://phaser.io/community/twitter">Twitter</a></li> <li class="class-depth-1"><a href="http://phaser.io/community/slack">Slack</a></li> <li class="class-depth-1"><a href="http://phaser.io/community/donate">Donate</a></li> <li class="class-depth-1"><a href="https://www.codeandweb.com/texturepacker/phaser">Texture Packer</a></li> </ul> </li> </ul> </div> </div> <div class="row-fluid"> <div class="span8"> <div id="main"> <!--<h1 class="page-title">Class: Debug</h1>--> <section> <header> <h2> <span class="ancestors"><a href="Phaser.html">Phaser</a><a href="Phaser.Utils.html">.Utils</a>.</span> Debug </h2> </header> <article> <div class="container-overview"> <dt> <h4 class="name " id="Debug"><span class="type-signature"></span>new Debug<span class="signature">(game)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>A collection of methods for displaying debug information about game objects.</p> <p>If your game is running in Canvas mode, then you should invoke all of the Debug methods from<br>your games <code>render</code> function. This is because they are drawn directly onto the game canvas<br>itself, so if you call any debug methods outside of <code>render</code> they are likely to be overwritten<br>by the game itself.</p> <p>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<br>to it, which must be uploaded every frame. Be advised: this is very expensive, especially in browsers like Firefox. So please only enable Debug<br>in WebGL mode if you really need it (or your desktop can cope with it well) and disable it for production!</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>game</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span> </td> <td class="description last"><p>A reference to the currently running game.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-23">line 23</a> </dt> </dl> </dd> </div> <h3 class="subsection-title">Members</h3> <dl> <dt> <h4 class="name " id="bmd"><span class="type-signature"></span>bmd<span class="type-signature"> :<a href="Phaser.BitmapData.html">Phaser.BitmapData</a></span></h4> </dt> <dd> <div class="description"> <p>In WebGL mode this BitmapData contains a copy of the debug canvas.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-38">line 38</a> </dt> </dl> </dd> <dt> <h4 class="name " id="canvas"><span class="type-signature"></span>canvas<span class="type-signature"> :HTMLCanvasElement</span></h4> </dt> <dd> <div class="description"> <p>The canvas to which Debug calls draws.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-43">line 43</a> </dt> </dl> </dd> <dt> <h4 class="name " id="columnWidth"><span class="type-signature"></span>columnWidth<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>The spacing between columns.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-59">line 59</a> </dt> </dl> </dd> <dt> <h4 class="name " id="context"><span class="type-signature"></span>context<span class="type-signature"> :CanvasRenderingContext2D</span></h4> </dt> <dd> <div class="description"> <p>The 2d context of the canvas.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-48">line 48</a> </dt> </dl> </dd> <dt> <h4 class="name " id="currentAlpha"><span class="type-signature"></span>currentAlpha<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>The alpha of the Debug context, set before all debug information is rendered to it.</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>1</li></ul></dd> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-87">line 87</a> </dt> </dl> </dd> <dt> <h4 class="name " id="currentX"><span class="type-signature"></span>currentX<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>The current X position the debug information will be rendered at.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-75">line 75</a> </dt> </dl> </dd> <dt> <h4 class="name " id="currentY"><span class="type-signature"></span>currentY<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>The current Y position the debug information will be rendered at.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-81">line 81</a> </dt> </dl> </dd> <dt> <h4 class="name " id="dirty"><span class="type-signature"></span>dirty<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>Does the canvas need re-rendering?</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-92">line 92</a> </dt> </dl> </dd> <dt> <h4 class="name " id="font"><span class="type-signature"></span>font<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>The font that the debug information is rendered in.</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>'14px Courier'</li></ul></dd> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-54">line 54</a> </dt> </dl> </dd> <dt> <h4 class="name " id="game"><span class="type-signature"></span>game<span class="type-signature"> :<a href="Phaser.Game.html">Phaser.Game</a></span></h4> </dt> <dd> <div class="description"> <p>A reference to the currently running Game.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-28">line 28</a> </dt> </dl> </dd> <dt> <h4 class="name " id="lineHeight"><span class="type-signature"></span>lineHeight<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>The line height between the debug text.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-64">line 64</a> </dt> </dl> </dd> <dt> <h4 class="name " id="renderShadow"><span class="type-signature"></span>renderShadow<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>Should the text be rendered with a slight shadow? Makes it easier to read on different types of background.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-69">line 69</a> </dt> </dl> </dd> <dt> <h4 class="name " id="sprite"><span class="type-signature"></span>sprite<span class="type-signature"> :<a href="Phaser.Image.html">Phaser.Image</a></span></h4> </dt> <dd> <div class="description"> <p>If debugging in WebGL mode we need this.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-33">line 33</a> </dt> </dl> </dd> </dl> <h3 class="subsection-title">Methods</h3> <dl> <dt> <h4 class="name " id="body"><span class="type-signature"></span>body<span class="signature">(sprite, <span class="optional">color</span>, <span class="optional">filled</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Render a Sprites Physics body if it has one set. The body is rendered as a filled or stroked rectangle.<br>This only works for Arcade Physics, Ninja Physics (AABB and Circle only) and Box2D Physics bodies.<br>To display a P2 Physics body you should enable debug mode on the body when creating it.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>sprite</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The Sprite who's body will be rendered.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'rgba(0,255,0,0.4)' </td> <td class="description last"><p>Color of the debug rectangle to be rendered. The format is a CSS color string such as '#ff0000' or 'rgba(255,0,0,0.5)'.</p></td> </tr> <tr> <td class="name"><code>filled</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last"><p>Render the body as a filled rectangle (true) or a stroked rectangle (false)</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-747">line 747</a> </dt> </dl> </dd> <dt> <h4 class="name " id="bodyInfo"><span class="type-signature"></span>bodyInfo<span class="signature">(sprite, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Render a Sprites Physic Body information.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>sprite</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The sprite to be rendered.</p></td> </tr> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>X position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>Y position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'rgb(255,255,255)' </td> <td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-781">line 781</a> </dt> </dl> </dd> <dt> <h4 class="name " id="boot"><span class="type-signature"><internal> </span>boot<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Internal method that boots the debug displayer.</p> </div> <dl class="details"> <dt class="important tag-deprecated">Internal:</dt> <dd class="tag-deprecated"><ul> <li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li> </ul></dd> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-98">line 98</a> </dt> </dl> </dd> <dt> <h4 class="name " id="box2dBody"><span class="type-signature"></span>box2dBody<span class="signature">(sprite, <span class="optional">color</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Renders 'debug draw' data for the given Box2D body.<br>This uses the standard debug drawing feature of Box2D, so colors will be decided by the Box2D engine.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>sprite</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The sprite whos body will be rendered.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'rgb(0,255,0)' </td> <td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-828">line 828</a> </dt> </dl> </dd> <dt> <h4 class="name " id="box2dWorld"><span class="type-signature"></span>box2dWorld<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Renders 'debug draw' data for the Box2D world if it exists.<br>This uses the standard debug drawing feature of Box2D, so colors will be decided by<br>the Box2D engine.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-810">line 810</a> </dt> </dl> </dd> <dt> <h4 class="name " id="cameraInfo"><span class="type-signature"></span>cameraInfo<span class="signature">(camera, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Render camera information including dimensions and location.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>camera</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Camera.html">Phaser.Camera</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The Phaser.Camera to show the debug information for.</p></td> </tr> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>X position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>Y position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'rgb(255,255,255)' </td> <td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-285">line 285</a> </dt> </dl> </dd> <dt> <h4 class="name " id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Destroy this object.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-877">line 877</a> </dt> </dl> </dd> <dt> <h4 class="name " id="geom"><span class="type-signature"></span>geom<span class="signature">(object, <span class="optional">color</span>, <span class="optional">filled</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Renders a Rectangle.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>object</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span> | <span class="param-type">object</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The geometry object to render.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>Color of the debug info to be rendered (format is css color string).</p></td> </tr> <tr> <td class="name"><code>filled</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last"><p>Render the objected as a filled (default, true) or a stroked (false)</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-645">line 645</a> </dt> </dl> </dd> <dt> <h4 class="name " id="geom"><span class="type-signature"></span>geom<span class="signature">(object, <span class="optional">color</span>, <span class="optional">filled</span>, <span class="optional">forceType</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Renders a Phaser geometry object including Rectangle, Circle, Point or Line.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>object</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span> | <span class="param-type"><a href="Phaser.Circle.html">Phaser.Circle</a></span> | <span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span> | <span class="param-type"><a href="Phaser.Line.html">Phaser.Line</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The geometry object to render.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>Color of the debug info to be rendered (format is css color string).</p></td> </tr> <tr> <td class="name"><code>filled</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last"><p>Render the objected as a filled (default, true) or a stroked (false)</p></td> </tr> <tr> <td class="name"><code>forceType</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>Force rendering of a specific type. If 0 no type will be forced, otherwise 1 = Rectangle, 2 = Circle, 3 = Point and 4 = Line.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-580">line 580</a> </dt> </dl> </dd> <dt> <h4 class="name " id="inputInfo"><span class="type-signature"></span>inputInfo<span class="signature">(x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Render debug information about the Input object.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>X position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>Y position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'rgb(255,255,255)' </td> <td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-433">line 433</a> </dt> </dl> </dd> <dt> <h4 class="name " id="key"><span class="type-signature"></span>key<span class="signature">(key, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Renders Phaser.Key object information.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Key.html">Phaser.Key</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The Key to render the information for.</p></td> </tr> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>X position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>Y position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'rgb(255,255,255)' </td> <td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-412">line 412</a> </dt> </dl> </dd> <dt> <h4 class="name " id="line"><span class="type-signature"><internal> </span>line<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Internal method that outputs a single line of text split over as many columns as needed, one per parameter.</p> </div> <dl class="details"> <dt class="important tag-deprecated">Internal:</dt> <dd class="tag-deprecated"><ul> <li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li> </ul></dd> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-226">line 226</a> </dt> </dl> </dd> <dt> <h4 class="name " id="lineInfo"><span class="type-signature"></span>lineInfo<span class="signature">(line, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Renders Line information in the given color.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>line</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Line.html">Phaser.Line</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The Line to display the data for.</p></td> </tr> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>X position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>Y position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'rgb(255,255,255)' </td> <td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-541">line 541</a> </dt> </dl> </dd> <dt> <h4 class="name " id="pixel"><span class="type-signature"></span>pixel<span class="signature">(x, y, <span class="optional">color</span>, <span class="optional">size</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Renders a single pixel at the given size.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>X position of the pixel to be rendered.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>Y position of the pixel to be rendered.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>Color of the pixel (format is css color string).</p></td> </tr> <tr> <td class="name"><code>size</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 2 </td> <td class="description last"><p>The 'size' to render the pixel at.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-560">line 560</a> </dt> </dl> </dd> <dt> <h4 class="name " id="pointer"><span class="type-signature"></span>pointer<span class="signature">(pointer, <span class="optional">hideIfUp</span>, <span class="optional">downColor</span>, <span class="optional">upColor</span>, <span class="optional">color</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Renders the Pointer.circle object onto the stage in green if down or red if up along with debug text.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>pointer</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The Pointer you wish to display.</p></td> </tr> <tr> <td class="name"><code>hideIfUp</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>Doesn't render the circle if the pointer is up.</p></td> </tr> <tr> <td class="name"><code>downColor</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'rgba(0,255,0,0.5)' </td> <td class="description last"><p>The color the circle is rendered in if down.</p></td> </tr> <tr> <td class="name"><code>upColor</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'rgba(255,0,0,0.5)' </td> <td class="description last"><p>The color the circle is rendered in if up (and hideIfUp is false).</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'rgb(255,255,255)' </td> <td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-331">line 331</a> </dt> </dl> </dd> <dt> <h4 class="name " id="preUpdate"><span class="type-signature"><internal> </span>preUpdate<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Internal method that clears the canvas (if a Sprite) ready for a new debug session.</p> </div> <dl class="details"> <dt class="important tag-deprecated">Internal:</dt> <dd class="tag-deprecated"><ul> <li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li> </ul></dd> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-143">line 143</a> </dt> </dl> </dd> <dt> <h4 class="name " id="quadTree"><span class="type-signature"></span>quadTree<span class="signature">(quadtree, color)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Visually renders a QuadTree to the display.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>quadtree</code></td> <td class="type"> <span class="param-type"><a href="Phaser.QuadTree.html">Phaser.QuadTree</a></span> </td> <td class="description last"><p>The quadtree to render.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>The color of the lines in the quadtree.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-707">line 707</a> </dt> </dl> </dd> <dt> <h4 class="name " id="reset"><span class="type-signature"></span>reset<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Clears the Debug canvas.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-162">line 162</a> </dt> </dl> </dd> <dt> <h4 class="name " id="resize"><span class="type-signature"><internal> </span>resize<span class="signature">(scaleManager, width, height)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Internal method that resizes the BitmapData and Canvas.<br>Called by ScaleManager.onSizeChange only in WebGL mode.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>scaleManager</code></td> <td class="type"> <span class="param-type"><a href="Phaser.ScaleManager.html">Phaser.ScaleManager</a></span> </td> <td class="description last"><p>The Phaser ScaleManager.</p></td> </tr> <tr> <td class="name"><code>width</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The new width of the game.</p></td> </tr> <tr> <td class="name"><code>height</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The new height of the game.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="important tag-deprecated">Internal:</dt> <dd class="tag-deprecated"><ul> <li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li> </ul></dd> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-124">line 124</a> </dt> </dl> </dd> <dt> <h4 class="name " id="ropeSegments"><span class="type-signature"></span>ropeSegments<span class="signature">(rope, <span class="optional">color</span>, <span class="optional">filled</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Renders the Rope's segments. Note: This is really expensive as it has to calculate new segments every time you call it</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>rope</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Rope.html">Phaser.Rope</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The rope to display the segments of.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>Color of the debug info to be rendered (format is css color string).</p></td> </tr> <tr> <td class="name"><code>filled</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last"><p>Render the rectangle as a fillRect (default, true) or a strokeRect (false)</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-472">line 472</a> </dt> </dl> </dd> <dt> <h4 class="name " id="soundInfo"><span class="type-signature"></span>soundInfo<span class="signature">(sound, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Render Sound information, including decoded state, duration, volume and more.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>sound</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Sound.html">Phaser.Sound</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The sound object to debug.</p></td> </tr> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>X position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>Y position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'rgb(255,255,255)' </td> <td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-254">line 254</a> </dt> </dl> </dd> <dt> <h4 class="name " id="spriteBounds"><span class="type-signature"></span>spriteBounds<span class="signature">(sprite, <span class="optional">color</span>, <span class="optional">filled</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Renders the Sprites bounds. Note: This is really expensive as it has to calculate the bounds every time you call it!</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>sprite</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span> | <span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The sprite to display the bounds of.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>Color of the debug info to be rendered (format is css color string).</p></td> </tr> <tr> <td class="name"><code>filled</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last"><p>Render the rectangle as a fillRect (default, true) or a strokeRect (false)</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-453">line 453</a> </dt> </dl> </dd> <dt> <h4 class="name " id="spriteCoords"><span class="type-signature"></span>spriteCoords<span class="signature">(sprite, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Renders the sprite coordinates in local, positional and world space.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>sprite</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span> | <span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The sprite to display the coordinates for.</p></td> </tr> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>X position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>Y position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'rgb(255,255,255)' </td> <td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-515">line 515</a> </dt> </dl> </dd> <dt> <h4 class="name " id="spriteInfo"><span class="type-signature"></span>spriteInfo<span class="signature">(sprite, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Render debug infos (including name, bounds info, position and some other properties) about the Sprite.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>sprite</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The Sprite to display the information of.</p></td> </tr> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>X position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>Y position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'rgb(255,255,255)' </td> <td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-492">line 492</a> </dt> </dl> </dd> <dt> <h4 class="name " id="spriteInputInfo"><span class="type-signature"></span>spriteInputInfo<span class="signature">(sprite, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Render Sprite Input Debug information.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>sprite</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span> | <span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The sprite to display the input data for.</p></td> </tr> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>X position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>Y position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'rgb(255,255,255)' </td> <td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-391">line 391</a> </dt> </dl> </dd> <dt> <h4 class="name " id="start"><span class="type-signature"><internal> </span>start<span class="signature">(<span class="optional">x</span>, <span class="optional">y</span>, <span class="optional">color</span>, <span class="optional">columnWidth</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Internal method that resets and starts the debug output values.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>The X value the debug info will start from.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>The Y value the debug info will start from.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'rgb(255,255,255)' </td> <td class="description last"><p>The color the debug text will drawn in.</p></td> </tr> <tr> <td class="name"><code>columnWidth</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>The spacing between columns.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="important tag-deprecated">Internal:</dt> <dd class="tag-deprecated"><ul> <li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li> </ul></dd> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-181">line 181</a> </dt> </dl> </dd> <dt> <h4 class="name " id="stop"><span class="type-signature"><internal> </span>stop<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Internal method that stops the debug output.</p> </div> <dl class="details"> <dt class="important tag-deprecated">Internal:</dt> <dd class="tag-deprecated"><ul> <li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li> </ul></dd> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-214">line 214</a> </dt> </dl> </dd> <dt> <h4 class="name " id="text"><span class="type-signature"></span>text<span class="signature">(text, x, y, <span class="optional">color</span>, <span class="optional">font</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Render a string of text.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>text</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last"><p>The line of text to draw.</p></td> </tr> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="description last"><p>X position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="description last"><p>Y position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>Color of the debug info to be rendered (format is css color string).</p></td> </tr> <tr> <td class="name"><code>font</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The font of text to draw.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-676">line 676</a> </dt> </dl> </dd> <dt> <h4 class="name " id="timer"><span class="type-signature"></span>timer<span class="signature">(timer, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Render Timer information.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>timer</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Timer.html">Phaser.Timer</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The Phaser.Timer to show the debug information for.</p></td> </tr> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>X position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>Y position of the debug info to be rendered.</p></td> </tr> <tr> <td class="name"><code>color</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'rgb(255,255,255)' </td> <td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-312">line 312</a> </dt> </dl> </dd> </dl> </article> </section> </div> <div class="clearfix"></div> <footer> <span class="copyright"> Phaser Copyright © 2012-2016 Photon Storm Ltd. </span> <br /> <span class="jsdoc-message"> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Dec 05 2016 10:04:39 GMT+0000 (GMT Standard Time) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. </span> </footer> </div> <div class="span3"> <div id="toc"></div> </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>