<!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/sunlight.default.css"> <link type="text/css" rel="stylesheet" href="styles/site.cerulean.css"> </head> <body> <div class="container-fluid"> <div class="navbar navbar-fixed-top navbar-inverse"> <div class="navbar-inner"> <a class="brand" href="index.html">Phaser</a> <ul class="nav"> <li class="dropdown"> <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a> <ul class="dropdown-menu "> <li> <a href="Phaser.html">Phaser</a> </li> </ul> </li> <li class="dropdown"> <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a> <ul class="dropdown-menu "> <li> <a href="Phaser.Animation.html">Animation</a> </li> <li> <a href="Phaser.AnimationManager.html">AnimationManager</a> </li> <li> <a href="Phaser.AnimationParser.html">AnimationParser</a> </li> <li> <a href="Phaser.BitmapData.html">BitmapData</a> </li> <li> <a href="Phaser.BitmapText.html">BitmapText</a> </li> <li> <a href="Phaser.Button.html">Button</a> </li> <li> <a href="Phaser.Cache.html">Cache</a> </li> <li> <a href="Phaser.Camera.html">Camera</a> </li> <li> <a href="Phaser.Canvas.html">Canvas</a> </li> <li> <a href="Phaser.Circle.html">Circle</a> </li> <li> <a href="Phaser.Color.html">Color</a> </li> <li> <a href="Phaser.Device.html">Device</a> </li> <li> <a href="Phaser.DOMSprite.html">DOMSprite</a> </li> <li> <a href="Phaser.Easing.html">Easing</a> </li> <li> <a href="Phaser.Easing.Back.html">Back</a> </li> <li> <a href="Phaser.Easing.Bounce.html">Bounce</a> </li> <li> <a href="Phaser.Easing.Circular.html">Circular</a> </li> <li> <a href="Phaser.Easing.Cubic.html">Cubic</a> </li> <li> <a href="Phaser.Easing.Elastic.html">Elastic</a> </li> <li> <a href="Phaser.Easing.Exponential.html">Exponential</a> </li> <li> <a href="Phaser.Easing.Linear.html">Linear</a> </li> <li> <a href="Phaser.Easing.Quadratic.html">Quadratic</a> </li> <li> <a href="Phaser.Easing.Quartic.html">Quartic</a> </li> <li> <a href="Phaser.Easing.Quintic.html">Quintic</a> </li> <li> <a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a> </li> <li> <a href="Phaser.Events.html">Events</a> </li> <li> <a href="Phaser.Filter.html">Filter</a> </li> <li> <a href="Phaser.Frame.html">Frame</a> </li> <li> <a href="Phaser.FrameData.html">FrameData</a> </li> <li> <a href="Phaser.Game.html">Game</a> </li> <li> <a href="Phaser.GameObjectFactory.html">GameObjectFactory</a> </li> <li> <a href="Phaser.Gamepad.html">Gamepad</a> </li> <li> <a href="Phaser.GamepadButton.html">GamepadButton</a> </li> <li> <a href="Phaser.Graphics.html">Graphics</a> </li> <li> <a href="Phaser.Group.html">Group</a> </li> <li> <a href="Phaser.Image.html">Image</a> </li> <li> <a href="Phaser.Input.html">Input</a> </li> <li> <a href="Phaser.InputHandler.html">InputHandler</a> </li> <li> <a href="Phaser.Key.html">Key</a> </li> <li> <a href="Phaser.Keyboard.html">Keyboard</a> </li> <li> <a href="Phaser.Line.html">Line</a> </li> <li> <a href="Phaser.LinkedList.html">LinkedList</a> </li> <li> <a href="Phaser.Loader.html">Loader</a> </li> <li> <a href="Phaser.LoaderParser.html">LoaderParser</a> </li> <li> <a href="Phaser.Math.html">Math</a> </li> <li> <a href="Phaser.Mouse.html">Mouse</a> </li> <li> <a href="Phaser.MSPointer.html">MSPointer</a> </li> <li> <a href="Phaser.Net.html">Net</a> </li> <li> <a href="Phaser.Particles.html">Particles</a> </li> <li> <a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a> </li> <li> <a href="Phaser.Physics.html">Physics</a> </li> <li> <a href="Phaser.Physics.Arcade.html">Arcade</a> </li> <li> <a href="Phaser.Physics.Arcade.Body.html">Body</a> </li> <li> <a href="Phaser.Plugin.html">Plugin</a> </li> <li> <a href="Phaser.PluginManager.html">PluginManager</a> </li> <li> <a href="Phaser.Point.html">Point</a> </li> <li> <a href="Phaser.Pointer.html">Pointer</a> </li> <li> <a href="Phaser.Polygon.html">Polygon</a> </li> <li> <a href="Phaser.QuadTree.html">QuadTree</a> </li> <li> <a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a> </li> <li> <a href="Phaser.Rectangle.html">Rectangle</a> </li> <li> <a href="Phaser.RenderTexture.html">RenderTexture</a> </li> <li> <a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a> </li> <li> <a href="Phaser.Signal.html">Signal</a> </li> <li> <a href="Phaser.SinglePad.html">SinglePad</a> </li> <li> <a href="Phaser.Sound.html">Sound</a> </li> <li> <a href="Phaser.SoundManager.html">SoundManager</a> </li> <li> <a href="Phaser.Sprite.html">Sprite</a> </li> <li> <a href="Phaser.Stage.html">Stage</a> </li> <li> <a href="Phaser.StageScaleMode.html">StageScaleMode</a> </li> <li> <a href="Phaser.State.html">State</a> </li> <li> <a href="Phaser.StateManager.html">StateManager</a> </li> <li> <a href="Phaser.Text.html">Text</a> </li> <li> <a href="Phaser.Tile.html">Tile</a> </li> <li> <a href="Phaser.Tilemap.html">Tilemap</a> </li> <li> <a href="Phaser.TilemapLayer.html">TilemapLayer</a> </li> <li> <a href="Phaser.TilemapParser.html">TilemapParser</a> </li> <li> <a href="Phaser.Tileset.html">Tileset</a> </li> <li> <a href="Phaser.TileSprite.html">TileSprite</a> </li> <li> <a href="Phaser.Time.html">Time</a> </li> <li> <a href="Phaser.Timer.html">Timer</a> </li> <li> <a href="Phaser.TimerEvent.html">TimerEvent</a> </li> <li> <a href="Phaser.Touch.html">Touch</a> </li> <li> <a href="Phaser.Tween.html">Tween</a> </li> <li> <a href="Phaser.TweenManager.html">TweenManager</a> </li> <li> <a href="Phaser.Utils.html">Utils</a> </li> <li> <a href="Phaser.Utils.Debug.html">Debug</a> </li> <li> <a href="Phaser.World.html">World</a> </li> <li> <a href="SignalBinding.html">SignalBinding</a> </li> </ul> </li> <li class="dropdown"> <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a> <ul class="dropdown-menu "> <li> <a href="global.html#canUseNewCanvasBlendModes">canUseNewCanvasBlendModes</a> </li> <li> <a href="global.html#getNextPowerOfTwo">getNextPowerOfTwo</a> </li> <li> <a href="global.html#hex2rgb">hex2rgb</a> </li> <li> <a href="global.html#hitTest">hitTest</a> </li> <li> <a href="global.html#rgb2hex">rgb2hex</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>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. "Hell, there are no rules here - we're trying to accomplish something." Thomas A. Edison</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><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Game constructor</p> <p>Instantiate a new <code>Phaser.Game</code> 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>width</code></td> <td class="type"> <span class="param-type">number</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.</p></td> </tr> <tr> <td class="name"><code>height</code></td> <td class="type"> <span class="param-type">number</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.</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>Anti-alias graphics.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-25">line 25</a> </li></ul></dd> </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"></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>add</code></td> <td class="type"> <span class="param-type"><a href="Phaser.GameObjectFactory.html">Phaser.GameObjectFactory</a></span> </td> <td class="description last"><p>Reference to the GameObject Factory.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-119">line 119</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="antialias"><span class="type-signature"></span>antialias<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>antialias</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Anti-alias graphics (in WebGL this helps with edges, in Canvas2D it retains pixel-art quality).</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>true</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-65">line 65</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="cache"><span class="type-signature"></span>cache<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>cache</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Cache.html">Phaser.Cache</a></span> </td> <td class="description last"><p>Reference to the assets cache.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-125">line 125</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="camera"><span class="type-signature"></span>camera<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>camera</code></td> <td class="type"> <span class="param-type">Phaser.Physics.PhysicsManager</span> </td> <td class="description last"><p>A handy reference to world.camera.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-203">line 203</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="canvas"><span class="type-signature"></span>canvas<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>canvas</code></td> <td class="type"> <span class="param-type">HTMLCanvasElement</span> </td> <td class="description last"><p>A handy reference to renderer.view.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-209">line 209</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="config"><span class="type-signature"></span>config<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>config</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"><p>The Phaser.Game configuration object.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-35">line 35</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="context"><span class="type-signature"></span>context<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>context</code></td> <td class="type"> <span class="param-type">Context</span> </td> <td class="description last"><p>A handy reference to renderer.context (only set for CANVAS games)</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-215">line 215</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="debug"><span class="type-signature"></span>debug<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>debug</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Utils.Debug.html">Phaser.Utils.Debug</a></span> </td> <td class="description last"><p>A set of useful debug utilitie.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-221">line 221</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="device"><span class="type-signature"></span>device<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>device</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Device.html">Phaser.Device</a></span> </td> <td class="description last"><p>Contains device information and capabilities.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-197">line 197</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="height"><span class="type-signature"></span>height<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>height</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The Game height (in pixels).</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>600</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-53">line 53</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="id"><span class="type-signature"></span>id<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">number</span> </td> <td class="description last"><p>Phaser Game ID (for when Pixi supports multiple instances).</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-30">line 30</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="input"><span class="type-signature"></span>input<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>input</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Input.html">Phaser.Input</a></span> </td> <td class="description last"><p>Reference to the input manager</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-131">line 131</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="isBooted"><span class="type-signature"></span>isBooted<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>isBooted</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Whether the game engine is booted, aka available.</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:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-101">line 101</a> </li></ul></dd> </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:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-107">line 107</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="load"><span class="type-signature"></span>load<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>load</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span> </td> <td class="description last"><p>Reference to the assets loader.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-137">line 137</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="math"><span class="type-signature"></span>math<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>math</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Math.html">Phaser.Math</a></span> </td> <td class="description last"><p>Reference to the math helper.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-143">line 143</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="net"><span class="type-signature"></span>net<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>net</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Net.html">Phaser.Net</a></span> </td> <td class="description last"><p>Reference to the network class.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-149">line 149</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="parent"><span class="type-signature"></span>parent<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>parent</code></td> <td class="type"> <span class="param-type">HTMLElement</span> </td> <td class="description last"><p>The Games DOM parent.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-41">line 41</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="particles"><span class="type-signature"></span>particles<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>particles</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Particles.html">Phaser.Particles</a></span> </td> <td class="description last"><p>The Particle Manager.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-227">line 227</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="paused"><span class="type-signature"></span>paused<span class="type-signature"></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.</p> </div> <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>paused</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Gets and sets the paused state of the Game.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-706">line 706</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="pendingStep"><span class="type-signature"><readonly> </span>pendingStep<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>stepping</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>An internal property used by enableStep, but also useful to query from your own game objects.</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:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-241">line 241</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="physics"><span class="type-signature"></span>physics<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>physics</code></td> <td class="type"> <span class="param-type">Phaser.Physics.PhysicsManager</span> </td> <td class="description last"><p>Reference to the physics manager.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-185">line 185</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="raf"><span class="type-signature"></span>raf<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>raf</code></td> <td class="type"> <span class="param-type"><a href="Phaser.RequestAnimationFrame.html">Phaser.RequestAnimationFrame</a></span> </td> <td class="description last"><p>Automatically handles the core game loop via requestAnimationFrame or setTimeout</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-113">line 113</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="renderer"><span class="type-signature"></span>renderer<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>renderer</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The Pixi Renderer</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-71">line 71</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="renderType"><span class="type-signature"></span>renderType<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>renderType</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The Renderer this Phaser.Game will use. Either Phaser.RENDERER_AUTO, Phaser.RENDERER_CANVAS or Phaser.RENDERER_WEBGL.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-76">line 76</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="rnd"><span class="type-signature"></span>rnd<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>rnd</code></td> <td class="type"> <span class="param-type"><a href="Phaser.RandomDataGenerator.html">Phaser.RandomDataGenerator</a></span> </td> <td class="description last"><p>Instance of repeatable random data generator helper.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-191">line 191</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="sound"><span class="type-signature"></span>sound<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>sound</code></td> <td class="type"> <span class="param-type"><a href="Phaser.SoundManager.html">Phaser.SoundManager</a></span> </td> <td class="description last"><p>Reference to the sound manager.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-155">line 155</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="stage"><span class="type-signature"></span>stage<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>stage</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Stage.html">Phaser.Stage</a></span> </td> <td class="description last"><p>Reference to the stage.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-161">line 161</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="state"><span class="type-signature"></span>state<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>state</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The StateManager.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-81">line 81</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="stepCount"><span class="type-signature"><readonly> </span>stepCount<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>stepCount</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>When stepping is enabled this contains the current step cycle.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-248">line 248</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="stepping"><span class="type-signature"><readonly> </span>stepping<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>stepping</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Enable core loop stepping with Game.enableStep().</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:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-234">line 234</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="time"><span class="type-signature"></span>time<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>time</code></td> <td class="type"> <span class="param-type">Phaser.TimeManager</span> </td> <td class="description last"><p>Reference to game clock.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-167">line 167</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="transparent"><span class="type-signature"></span>transparent<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>transparent</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Use a transparent canvas background or not.</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:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-59">line 59</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="tweens"><span class="type-signature"></span>tweens<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>tweens</code></td> <td class="type"> <span class="param-type"><a href="Phaser.TweenManager.html">Phaser.TweenManager</a></span> </td> <td class="description last"><p>Reference to the tween manager.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-173">line 173</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="width"><span class="type-signature"></span>width<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>width</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The Game width (in pixels).</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>800</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-47">line 47</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="world"><span class="type-signature"></span>world<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>world</code></td> <td class="type"> <span class="param-type"><a href="Phaser.World.html">Phaser.World</a></span> </td> <td class="description last"><p>Reference to the world.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-179">line 179</a> </li></ul></dd> </dl> </dd> </dl> <h3 class="subsection-title">Methods</h3> <dl> <dt> <h4 class="name" id="boot"><span class="type-signature"><protected> </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="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-406">line 406</a> </li></ul></dd> </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>Nuke the entire game from orbit</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-677">line 677</a> </li></ul></dd> </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:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-652">line 652</a> </li></ul></dd> </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 to hard to track down errors!</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-638">line 638</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="loadComplete"><span class="type-signature"><protected> </span>loadComplete<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Called when the load has finished, after preload was run.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-570">line 570</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="parseConfig"><span class="type-signature"><protected> </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="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-313">line 313</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="parseDimension"><span class="type-signature"><protected> </span>parseDimension<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Get dimension.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-365">line 365</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="setUpRenderer"><span class="type-signature"><protected> </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="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-521">line 521</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="showDebugHeader"><span class="type-signature"><protected> </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="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-475">line 475</a> </li></ul></dd> </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:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-664">line 664</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="update"><span class="type-signature"><protected> </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="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-584">line 584</a> </li></ul></dd> </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 Sat Feb 08 2014 07:19:45 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( { 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>