<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Phaser Class: Game</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-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.ArrayList.html">ArrayList</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.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.Circle.html">Circle</a> </li> <li class="class-depth-1"> <a href="Phaser.Color.html">Color</a> </li> <li class="class-depth-1"> <a href="Phaser.Device.html">Device</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.GamepadButton.html">GamepadButton</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.Image.html">Image</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.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.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.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-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-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.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.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.World.html">World</a> </li> <li class="class-depth-1"> <a href="PIXI.AbstractFilter.html">AbstractFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.AjaxRequest.html">AjaxRequest</a> </li> <li class="class-depth-1"> <a href="PIXI.AlphaMaskFilter.html">AlphaMaskFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.AsciiFilter.html">AsciiFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.AssetLoader.html">AssetLoader</a> </li> <li class="class-depth-1"> <a href="PIXI.AtlasLoader.html">AtlasLoader</a> </li> <li class="class-depth-1"> <a href="PIXI.BaseTexture.html">BaseTexture</a> </li> <li class="class-depth-1"> <a href="PIXI.BitmapFontLoader.html">BitmapFontLoader</a> </li> <li class="class-depth-1"> <a href="PIXI.BitmapText.html">BitmapText</a> </li> <li class="class-depth-1"> <a href="PIXI.BlurFilter.html">BlurFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.BlurXFilter.html">BlurXFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.BlurYFilter.html">BlurYFilter</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.Circle.html">Circle</a> </li> <li class="class-depth-1"> <a href="PIXI.ColorMatrixFilter.html">ColorMatrixFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.ColorStepFilter.html">ColorStepFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.ComplexPrimitiveShader.html">ComplexPrimitiveShader</a> </li> <li class="class-depth-1"> <a href="PIXI.ConvolutionFilter.html">ConvolutionFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.CrossHatchFilter.html">CrossHatchFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.DisplacementFilter.html">DisplacementFilter</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.DotScreenFilter.html">DotScreenFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.Ellipse.html">Ellipse</a> </li> <li class="class-depth-1"> <a href="PIXI.Event.html">Event</a> </li> <li class="class-depth-1"> <a href="PIXI.EventTarget.html">EventTarget</a> </li> <li class="class-depth-1"> <a href="PIXI.FilterBlock.html">FilterBlock</a> </li> <li class="class-depth-1"> <a href="PIXI.FilterTexture.html">FilterTexture</a> </li> <li class="class-depth-1"> <a href="PIXI.Graphics.html">Graphics</a> </li> <li class="class-depth-1"> <a href="PIXI.GraphicsData.html">GraphicsData</a> </li> <li class="class-depth-1"> <a href="PIXI.GrayFilter.html">GrayFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.ImageLoader.html">ImageLoader</a> </li> <li class="class-depth-1"> <a href="PIXI.InteractionData.html">InteractionData</a> </li> <li class="class-depth-1"> <a href="PIXI.InteractionManager.html">InteractionManager</a> </li> <li class="class-depth-1"> <a href="PIXI.InvertFilter.html">InvertFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.JsonLoader.html">JsonLoader</a> </li> <li class="class-depth-1"> <a href="PIXI.Matrix.html">Matrix</a> </li> <li class="class-depth-1"> <a href="PIXI.MovieClip.html">MovieClip</a> </li> <li class="class-depth-1"> <a href="PIXI.NoiseFilter.html">NoiseFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.NormalMapFilter.html">NormalMapFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.PixelateFilter.html">PixelateFilter</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.Point.html">Point</a> </li> <li class="class-depth-1"> <a href="PIXI.Polygon.html">Polygon</a> </li> <li class="class-depth-1"> <a href="PIXI.PolyK.html">PolyK</a> </li> <li class="class-depth-1"> <a href="PIXI.PrimitiveShader.html">PrimitiveShader</a> </li> <li class="class-depth-1"> <a href="PIXI.Rectangle.html">Rectangle</a> </li> <li class="class-depth-1"> <a href="PIXI.RenderTexture.html">RenderTexture</a> </li> <li class="class-depth-1"> <a href="PIXI.RGBSplitFilter.html">RGBSplitFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.Rope.html">Rope</a> </li> <li class="class-depth-1"> <a href="PIXI.RoundedRectangle.html">RoundedRectangle</a> </li> <li class="class-depth-1"> <a href="PIXI.SepiaFilter.html">SepiaFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.SmartBlurFilter.html">SmartBlurFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.Spine.html">Spine</a> </li> <li class="class-depth-1"> <a href="PIXI.SpineLoader.html">SpineLoader</a> </li> <li class="class-depth-1"> <a href="PIXI.SpineTextureLoader.html">SpineTextureLoader</a> </li> <li class="class-depth-1"> <a href="PIXI.Sprite.html">Sprite</a> </li> <li class="class-depth-1"> <a href="PIXI.SpriteBatch.html">SpriteBatch</a> </li> <li class="class-depth-1"> <a href="PIXI.SpriteSheetLoader.html">SpriteSheetLoader</a> </li> <li class="class-depth-1"> <a href="PIXI.Stage.html">Stage</a> </li> <li class="class-depth-1"> <a href="PIXI.Strip.html">Strip</a> </li> <li class="class-depth-1"> <a href="PIXI.StripShader.html">StripShader</a> </li> <li class="class-depth-1"> <a href="PIXI.Text.html">Text</a> </li> <li class="class-depth-1"> <a href="PIXI.Texture.html">Texture</a> </li> <li class="class-depth-1"> <a href="PIXI.TilingSprite.html">TilingSprite</a> </li> <li class="class-depth-1"> <a href="PIXI.TiltShiftFilter.html">TiltShiftFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.TiltShiftXFilter.html">TiltShiftXFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.TiltShiftYFilter.html">TiltShiftYFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.TwistFilter.html">TwistFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.VideoTexture.html">VideoTexture</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="#" class="dropdown-toggle" data-toggle="dropdown">Core<b class="caret"></b></a> <ul class="dropdown-menu "> <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.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.InputManager.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.Emitter.html">Emitter</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.Rectangle.html">Rectangle</a></li> <li class="class-depth-1"><a href="Phaser.Point.html">Point</a></li> <li class="class-depth-1"><a href="Phaser.Line.html">Line</a></li> <li class="class-depth-1"><a href="Phaser.Ellipse.html">Ellipse</a></li> <li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</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-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.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.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="https://github.com/photonstorm/phaser">Phaser Github</a></li> <li class="class-depth-1"><a href="http://examples.phaser.io">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="https://confirmsubscription.com/h/r/369DE48E3E86AF1E">Newsletter</a></li> <li class="class-depth-1"><a href="https://twitter.com/photonstorm">Twitter</a></li> <li class="class-depth-1"><a href="http://www.html5gamedevs.com/topic/4470-official-phaserio-irc-channel-phaserio-on-freenode/">IRC</a></li> <li class="class-depth-1"><a href="https://www.gittip.com/photonstorm/">GitTip</a></li> </ul> </li> </ul> </div> </div> <div class="row-fluid"> <div class="span8"> <div id="main"> <!--<h1 class="page-title">Class: Game</h1>--> <section> <header> <h2> <span class="ancestors"><a href="Phaser.html">Phaser</a>.</span> Game </h2> <div class="class-description"><p>Phaser.Game</p></div> </header> <article> <div class="container-overview"> <dt> <h4 class="name " id="Game"><span class="type-signature"></span>new Game<span class="signature">(<span class="optional">width</span>, <span class="optional">height</span>, <span class="optional">renderer</span>, <span class="optional">parent</span>, <span class="optional">state</span>, <span class="optional">transparent</span>, <span class="optional">antialias</span>, <span class="optional">physicsConfig</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>This is where the magic happens. The Game object is the heart of your game, providing quick access to common functions and handling the boot process.</p> <p>"Hell, there are no rules here - we're trying to accomplish something." Thomas A. Edison</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>width</code></td> <td class="type"> <span class="param-type">number</span> | <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 800 </td> <td class="description last"><p>The width of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage width of the parent container, or the browser window if no parent is given.</p></td> </tr> <tr> <td class="name"><code>height</code></td> <td class="type"> <span class="param-type">number</span> | <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 600 </td> <td class="description last"><p>The height of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage height of the parent container, or the browser window if no parent is given.</p></td> </tr> <tr> <td class="name"><code>renderer</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> Phaser.AUTO </td> <td class="description last"><p>Which renderer to use: Phaser.AUTO will auto-detect, Phaser.WEBGL, Phaser.CANVAS or Phaser.HEADLESS (no rendering at all).</p></td> </tr> <tr> <td class="name"><code>parent</code></td> <td class="type"> <span class="param-type">string</span> | <span class="param-type">HTMLElement</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> '' </td> <td class="description last"><p>The DOM element into which this games canvas will be injected. Either a DOM ID (string) or the element itself.</p></td> </tr> <tr> <td class="name"><code>state</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last"><p>The default state object. A object consisting of Phaser.State functions (preload, create, update, render) or null.</p></td> </tr> <tr> <td class="name"><code>transparent</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>Use a transparent canvas background or not.</p></td> </tr> <tr> <td class="name"><code>antialias</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>Draw all image textures anti-aliased or not. The default is for smooth textures, but disable if your game features pixel art.</p></td> </tr> <tr> <td class="name"><code>physicsConfig</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last"><p>A physics configuration object to pass to the Physics world on creation.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-25">line 25</a> </dt> </dl> </dd> </div> <h3 class="subsection-title">Members</h3> <dl> <dt> <h4 class="name " id="add"><span class="type-signature"></span>add<span class="type-signature"> :<a href="Phaser.GameObjectFactory.html">Phaser.GameObjectFactory</a></span></h4> </dt> <dd> <div class="description"> <p>Reference to the Phaser.GameObjectFactory.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-135">line 135</a> </dt> </dl> </dd> <dt> <h4 class="name " id="antialias"><span class="type-signature"></span>antialias<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>Anti-alias graphics. By default scaled images are smoothed in Canvas and WebGL, set anti-alias to false to disable this globally.</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>true</li></ul></dd> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-92">line 92</a> </dt> </dl> </dd> <dt> <h4 class="name " id="cache"><span class="type-signature"></span>cache<span class="type-signature"> :<a href="Phaser.Cache.html">Phaser.Cache</a></span></h4> </dt> <dd> <div class="description"> <p>Reference to the assets cache.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-145">line 145</a> </dt> </dl> </dd> <dt> <h4 class="name " id="camera"><span class="type-signature"></span>camera<span class="type-signature"> :<a href="Phaser.Camera.html">Phaser.Camera</a></span></h4> </dt> <dd> <div class="description"> <p>A handy reference to world.camera.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-215">line 215</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>A handy reference to renderer.view, the canvas that the game is being rendered in to.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-220">line 220</a> </dt> </dl> </dd> <dt> <h4 class="name " id="config"><span class="type-signature"></span>config<span class="type-signature"> :object</span></h4> </dt> <dd> <div class="description"> <p>The Phaser.Game configuration object.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-35">line 35</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>A handy reference to renderer.context (only set for CANVAS games, not WebGL)</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-225">line 225</a> </dt> </dl> </dd> <dt> <h4 class="name " id="debug"><span class="type-signature"></span>debug<span class="type-signature"> :<a href="Phaser.Utils.Debug.html">Phaser.Utils.Debug</a></span></h4> </dt> <dd> <div class="description"> <p>A set of useful debug utilitie.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-230">line 230</a> </dt> </dl> </dd> <dt> <h4 class="name " id="device"><span class="type-signature"></span>device<span class="type-signature"> :<a href="Phaser.Device.html">Phaser.Device</a></span></h4> </dt> <dd> <div class="description"> <p>Contains device information and capabilities.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-210">line 210</a> </dt> </dl> </dd> <dt> <h4 class="name " id="forceSingleUpdate"><span class="type-signature"></span>forceSingleUpdate<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>Should the game loop force a logic update, regardless of the delta timer? Set to true if you know you need this. You can toggle it on the fly.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-318">line 318</a> </dt> </dl> </dd> <dt> <h4 class="name " id="fpsProblemNotifier"><span class="type-signature"></span>fpsProblemNotifier<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4> </dt> <dd> <div class="description"> <p>if the game is struggling to maintain the desiredFps, this signal will be dispatched to suggest that the program adjust it's fps closer to the Time.suggestedFps value</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-313">line 313</a> </dt> </dl> </dd> <dt> <h4 class="name " id="height"><span class="type-signature"><readonly> </span>height<span class="type-signature"> :integer</span></h4> </dt> <dd> <div class="description"> <p>The current Game Height in pixels.</p> <p><em>Do not modify this property directly:</em> use <a href="Phaser.ScaleManager.html#setGameSize">Phaser.ScaleManager#setGameSize</a> - eg. <code>game.scale.setGameSize(width, height)</code> - instead.</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>600</li></ul></dd> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-68">line 68</a> </dt> </dl> </dd> <dt> <h4 class="name " id="id"><span class="type-signature"></span>id<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>Phaser Game ID (for when Pixi supports multiple instances).</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-30">line 30</a> </dt> </dl> </dd> <dt> <h4 class="name " id="input"><span class="type-signature"></span>input<span class="type-signature"> :<a href="Phaser.Input.html">Phaser.Input</a></span></h4> </dt> <dd> <div class="description"> <p>Reference to the input manager</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-150">line 150</a> </dt> </dl> </dd> <dt> <h4 class="name " id="isBooted"><span class="type-signature"></span>isBooted<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>Whether the game engine is booted, aka available.</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-119">line 119</a> </dt> </dl> </dd> <dt> <h4 class="name " id="isRunning"><span class="type-signature"></span>isRunning<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>id</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Is game running or paused?</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-125">line 125</a> </dt> </dl> </dd> <dt> <h4 class="name " id="load"><span class="type-signature"></span>load<span class="type-signature"> :<a href="Phaser.Loader.html">Phaser.Loader</a></span></h4> </dt> <dd> <div class="description"> <p>Reference to the assets loader.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-155">line 155</a> </dt> </dl> </dd> <dt> <h4 class="name " id="make"><span class="type-signature"></span>make<span class="type-signature"> :<a href="Phaser.GameObjectCreator.html">Phaser.GameObjectCreator</a></span></h4> </dt> <dd> <div class="description"> <p>Reference to the GameObject Creator.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-140">line 140</a> </dt> </dl> </dd> <dt> <h4 class="name " id="math"><span class="type-signature"></span>math<span class="type-signature"> :<a href="Phaser.Math.html">Phaser.Math</a></span></h4> </dt> <dd> <div class="description"> <p>Reference to the math helper.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-160">line 160</a> </dt> </dl> </dd> <dt> <h4 class="name " id="net"><span class="type-signature"></span>net<span class="type-signature"> :<a href="Phaser.Net.html">Phaser.Net</a></span></h4> </dt> <dd> <div class="description"> <p>Reference to the network class.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-165">line 165</a> </dt> </dl> </dd> <dt> <h4 class="name " id="onBlur"><span class="type-signature"></span>onBlur<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4> </dt> <dd> <div class="description"> <p>This event is fired when the game no longer has focus (typically on page hide).</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-271">line 271</a> </dt> </dl> </dd> <dt> <h4 class="name " id="onFocus"><span class="type-signature"></span>onFocus<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4> </dt> <dd> <div class="description"> <p>This event is fired when the game has focus (typically on page show).</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-276">line 276</a> </dt> </dl> </dd> <dt> <h4 class="name " id="onPause"><span class="type-signature"></span>onPause<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4> </dt> <dd> <div class="description"> <p>This event is fired when the game pauses.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-261">line 261</a> </dt> </dl> </dd> <dt> <h4 class="name " id="onResume"><span class="type-signature"></span>onResume<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4> </dt> <dd> <div class="description"> <p>This event is fired when the game resumes from a paused state.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-266">line 266</a> </dt> </dl> </dd> <dt> <h4 class="name " id="parent"><span class="type-signature"></span>parent<span class="type-signature"> :string|HTMLElement</span></h4> </dt> <dd> <div class="description"> <p>The Games DOM parent.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> | <span class="param-type">HTMLElement</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-46">line 46</a> </dt> </dl> </dd> <dt> <h4 class="name " id="particles"><span class="type-signature"></span>particles<span class="type-signature"> :<a href="Phaser.Particles.html">Phaser.Particles</a></span></h4> </dt> <dd> <div class="description"> <p>The Particle Manager.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-235">line 235</a> </dt> </dl> </dd> <dt> <h4 class="name " id="paused"><span class="type-signature"></span>paused<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>The paused state of the Game. A paused game doesn't update any of its subsystems. When a game is paused the onPause event is dispatched. When it is resumed the onResume event is dispatched. Gets and sets the paused state of the Game.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-980">line 980</a> </dt> </dl> </dd> <dt> <h4 class="name " id="pendingStep"><span class="type-signature"><readonly> </span>pendingStep<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>An internal property used by enableStep, but also useful to query from your own game objects.</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-249">line 249</a> </dt> </dl> </dd> <dt> <h4 class="name " id="physics"><span class="type-signature"></span>physics<span class="type-signature"> :<a href="Phaser.Physics.html">Phaser.Physics</a></span></h4> </dt> <dd> <div class="description"> <p>Reference to the physics manager.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-200">line 200</a> </dt> </dl> </dd> <dt> <h4 class="name " id="physicsConfig"><span class="type-signature"></span>physicsConfig<span class="type-signature"> :object</span></h4> </dt> <dd> <div class="description"> <p>The Phaser.Physics.World configuration object.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-40">line 40</a> </dt> </dl> </dd> <dt> <h4 class="name " id="preserveDrawingBuffer"><span class="type-signature"></span>preserveDrawingBuffer<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-98">line 98</a> </dt> </dl> </dd> <dt> <h4 class="name " id="raf"><span class="type-signature"></span>raf<span class="type-signature"> :<a href="Phaser.RequestAnimationFrame.html">Phaser.RequestAnimationFrame</a></span></h4> </dt> <dd> <div class="description"> <p>Automatically handles the core game loop via requestAnimationFrame or setTimeout</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-130">line 130</a> </dt> </dl> </dd> <dt> <h4 class="name " id="renderer"><span class="type-signature"></span>renderer<span class="type-signature"> :<a href="PIXI.CanvasRenderer.html">PIXI.CanvasRenderer</a>|<a href="PIXI.WebGLRenderer.html">PIXI.WebGLRenderer</a></span></h4> </dt> <dd> <div class="description"> <p>The Pixi Renderer.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="PIXI.CanvasRenderer.html">PIXI.CanvasRenderer</a></span> | <span class="param-type"><a href="PIXI.WebGLRenderer.html">PIXI.WebGLRenderer</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-103">line 103</a> </dt> </dl> </dd> <dt> <h4 class="name " id="renderType"><span class="type-signature"></span>renderType<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>The Renderer this game will use. Either Phaser.AUTO, Phaser.CANVAS or Phaser.WEBGL.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-108">line 108</a> </dt> </dl> </dd> <dt> <h4 class="name " id="rnd"><span class="type-signature"></span>rnd<span class="type-signature"> :<a href="Phaser.RandomDataGenerator.html">Phaser.RandomDataGenerator</a></span></h4> </dt> <dd> <div class="description"> <p>Instance of repeatable random data generator helper.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-205">line 205</a> </dt> </dl> </dd> <dt> <h4 class="name " id="scale"><span class="type-signature"></span>scale<span class="type-signature"> :<a href="Phaser.ScaleManager.html">Phaser.ScaleManager</a></span></h4> </dt> <dd> <div class="description"> <p>The game scale manager.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-170">line 170</a> </dt> </dl> </dd> <dt> <h4 class="name " id="sound"><span class="type-signature"></span>sound<span class="type-signature"> :<a href="Phaser.SoundManager.html">Phaser.SoundManager</a></span></h4> </dt> <dd> <div class="description"> <p>Reference to the sound manager.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-175">line 175</a> </dt> </dl> </dd> <dt> <h4 class="name " id="stage"><span class="type-signature"></span>stage<span class="type-signature"> :<a href="Phaser.Stage.html">Phaser.Stage</a></span></h4> </dt> <dd> <div class="description"> <p>Reference to the stage.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-180">line 180</a> </dt> </dl> </dd> <dt> <h4 class="name " id="state"><span class="type-signature"></span>state<span class="type-signature"> :<a href="Phaser.StateManager.html">Phaser.StateManager</a></span></h4> </dt> <dd> <div class="description"> <p>The StateManager.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-113">line 113</a> </dt> </dl> </dd> <dt> <h4 class="name " id="stepCount"><span class="type-signature"><readonly> </span>stepCount<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>When stepping is enabled this contains the current step cycle.</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-256">line 256</a> </dt> </dl> </dd> <dt> <h4 class="name " id="stepping"><span class="type-signature"><readonly> </span>stepping<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>Enable core loop stepping with Game.enableStep().</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-242">line 242</a> </dt> </dl> </dd> <dt> <h4 class="name " id="time"><span class="type-signature"></span>time<span class="type-signature"> :<a href="Phaser.Time.html">Phaser.Time</a></span></h4> </dt> <dd> <div class="description"> <p>Reference to the core game clock.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-185">line 185</a> </dt> </dl> </dd> <dt> <h4 class="name " id="transparent"><span class="type-signature"></span>transparent<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>Use a transparent canvas background or not.</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-86">line 86</a> </dt> </dl> </dd> <dt> <h4 class="name " id="tweens"><span class="type-signature"></span>tweens<span class="type-signature"> :<a href="Phaser.TweenManager.html">Phaser.TweenManager</a></span></h4> </dt> <dd> <div class="description"> <p>Reference to the tween manager.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-190">line 190</a> </dt> </dl> </dd> <dt> <h4 class="name " id="width"><span class="type-signature"><readonly> </span>width<span class="type-signature"> :integer</span></h4> </dt> <dd> <div class="description"> <p>The current Game Width in pixels.</p> <p><em>Do not modify this property directly:</em> use <a href="Phaser.ScaleManager.html#setGameSize">Phaser.ScaleManager#setGameSize</a> - eg. <code>game.scale.setGameSize(width, height)</code> - instead.</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>800</li></ul></dd> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-57">line 57</a> </dt> </dl> </dd> <dt> <h4 class="name " id="world"><span class="type-signature"></span>world<span class="type-signature"> :<a href="Phaser.World.html">Phaser.World</a></span></h4> </dt> <dd> <div class="description"> <p>Reference to the world.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-195">line 195</a> </dt> </dl> </dd> </dl> <h3 class="subsection-title">Methods</h3> <dl> <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>Initialize engine sub modules and start the game.</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="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-453">line 453</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>Nukes the entire game from orbit.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-842">line 842</a> </dt> </dl> </dd> <dt> <h4 class="name " id="disableStep"><span class="type-signature"></span>disableStep<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Disables core game loop stepping.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-817">line 817</a> </dt> </dl> </dd> <dt> <h4 class="name " id="enableStep"><span class="type-signature"></span>enableStep<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Enable core game loop stepping. When enabled you must call game.step() directly (perhaps via a DOM button?) Calling step will advance the game loop by one frame. This is extremely useful for hard to track down errors!</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-803">line 803</a> </dt> </dl> </dd> <dt> <h4 class="name " id="focusGain"><span class="type-signature"><internal> </span>focusGain<span class="signature">(event)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Called by the Stage visibility handler.</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>event</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"><p>The DOM event that caused the game to pause, if any.</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="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-958">line 958</a> </dt> </dl> </dd> <dt> <h4 class="name " id="focusLoss"><span class="type-signature"><internal> </span>focusLoss<span class="signature">(event)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Called by the Stage visibility handler.</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>event</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"><p>The DOM event that caused the game to pause, if any.</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="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-940">line 940</a> </dt> </dl> </dd> <dt> <h4 class="name " id="gamePaused"><span class="type-signature"><internal> </span>gamePaused<span class="signature">(event)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Called by the Stage visibility handler.</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>event</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"><p>The DOM event that caused the game to pause, if any.</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="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-899">line 899</a> </dt> </dl> </dd> <dt> <h4 class="name " id="gameResumed"><span class="type-signature"><internal> </span>gameResumed<span class="signature">(event)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Called by the Stage visibility handler.</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>event</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"><p>The DOM event that caused the game to pause, if any.</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="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-919">line 919</a> </dt> </dl> </dd> <dt> <h4 class="name " id="parseConfig"><span class="type-signature"><internal> </span>parseConfig<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Parses a Game configuration object.</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="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-378">line 378</a> </dt> </dl> </dd> <dt> <h4 class="name " id="setUpRenderer"><span class="type-signature"><internal> </span>setUpRenderer<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Checks if the device is capable of using the requested renderer and sets it up or an alternative if not.</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="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-591">line 591</a> </dt> </dl> </dd> <dt> <h4 class="name " id="showDebugHeader"><span class="type-signature"><internal> </span>showDebugHeader<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Displays a Phaser version debug header in the console.</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="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-529">line 529</a> </dt> </dl> </dd> <dt> <h4 class="name " id="step"><span class="type-signature"></span>step<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>When stepping is enabled you must call this function directly (perhaps via a DOM button?) to advance the game loop by one frame. This is extremely useful to hard to track down errors! Use the internal stepCount property to monitor progress.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-829">line 829</a> </dt> </dl> </dd> <dt> <h4 class="name " id="update"><span class="type-signature"><internal> </span>update<span class="signature">(time)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>The core game loop.</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>time</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The current time as provided by RequestAnimationFrame.</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="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-666">line 666</a> </dt> </dl> </dd> <dt> <h4 class="name " id="updateLogic"><span class="type-signature"><internal> </span>updateLogic<span class="signature">(timeStep)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Updates all logic subsystems in Phaser. Called automatically by Game.update.</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>timeStep</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The current timeStep value as determined by Game.update.</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="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-740">line 740</a> </dt> </dl> </dd> <dt> <h4 class="name " id="updateRender"><span class="type-signature"><internal> </span>updateRender<span class="signature">(elapsedTime)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Renders the display list. Called automatically by Game.update.</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>elapsedTime</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The time elapsed since the last update.</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="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-785">line 785</a> </dt> </dl> </dd> </dl> </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 Tue Nov 25 2014 00:17:33 GMT-0000 (GMT) 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>