Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-09-21 15:01:57 +00:00
Code Issues Projects Releases Packages Wiki Activity
phaser/docs/Phaser.StateManager.html

3438 lines
45 KiB
HTML
Raw Normal View History

More docs.
2013-10-02 11:11:22 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Class: StateManager</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">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
More docs.
2013-10-02 11:11:22 +00:00
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.html">Phaser</a>
More docs.
2013-10-02 11:11:22 +00:00
</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>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.AnimationManager.html">AnimationManager</a>
More docs.
2013-10-02 11:11:22 +00:00
</li>
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.AnimationParser.html">AnimationParser</a>
More docs.
2013-10-02 11:11:22 +00:00
</li>
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<li>
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
<li>
<a href="Phaser.Button.html">Button</a>
</li>
More docs.
2013-10-02 11:11:22 +00:00
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Cache.html">Cache</a>
More docs.
2013-10-02 11:11:22 +00:00
</li>
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Camera.html">Camera</a>
More docs.
2013-10-02 11:11:22 +00:00
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Canvas.html">Canvas</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li>
More docs.
2013-10-02 11:11:22 +00:00
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Circle.html">Circle</a>
More docs.
2013-10-02 11:11:22 +00:00
</li>
More Docs!
2013-10-03 00:21:08 +00:00
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Color.html">Color</a>
More Docs!
2013-10-03 00:21:08 +00:00
</li>
More docs.
2013-10-02 11:11:22 +00:00
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Device.html">Device</a>
More docs.
2013-10-02 11:11:22 +00:00
</li>
More Docs!
2013-10-03 00:21:08 +00:00
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<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>
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<li>
<a href="Phaser.Events.html">Events</a>
</li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<li>
<a href="Phaser.Frame.html">Frame</a>
</li>
<li>
<a href="Phaser.FrameData.html">FrameData</a>
More Docs!
2013-10-03 00:21:08 +00:00
</li>
More docs.
2013-10-02 11:11:22 +00:00
<li>
<a href="Phaser.Game.html">Game</a>
</li>
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<li>
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
<li>
<a href="Phaser.Graphics.html">Graphics</a>
</li>
More docs.
2013-10-02 11:11:22 +00:00
<li>
<a href="Phaser.Group.html">Group</a>
</li>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<li>
<a href="Phaser.Input.html">Input</a>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<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>
More docs.
2013-10-02 11:11:22 +00:00
<li>
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
<li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.Loader.html">Loader</a>
</li>
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.LoaderParser.html">LoaderParser</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</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>
More docs.
2013-10-02 11:11:22 +00:00
</li>
Yet more documentation done.
2013-10-02 19:18:24 +00:00
<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>
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<li>
<a href="Phaser.Physics.html">Physics</a>
</li>
<li>
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
Updated docs and more tidying up.
2013-10-25 16:30:37 +00:00
<li>
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
More docs.
2013-10-02 11:11:22 +00:00
<li>
<a href="Phaser.Plugin.html">Plugin</a>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li>
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
More docs.
2013-10-02 11:11:22 +00:00
<li>
<a href="Phaser.Point.html">Point</a>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li>
<a href="Phaser.Pointer.html">Pointer</a>
</li>
Added in a Group.sort demo, also updated the documentation and build files.
2013-11-07 06:10:15 +00:00
<li>
<a href="Phaser.Polygon.html">Polygon</a>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li>
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
<li>
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
More docs.
2013-10-02 11:11:22 +00:00
<li>
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<li>
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
More Docs!
2013-10-03 00:21:08 +00:00
<li>
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
More docs.
2013-10-02 11:11:22 +00:00
<li>
<a href="Phaser.Signal.html">Signal</a>
</li>
More Docs!
2013-10-03 00:21:08 +00:00
<li>
<a href="Phaser.Sound.html">Sound</a>
</li>
<li>
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<li>
<a href="Phaser.Sprite.html">Sprite</a>
</li>
More docs.
2013-10-02 11:11:22 +00:00
<li>
<a href="Phaser.Stage.html">Stage</a>
</li>
More Docs!
2013-10-03 00:21:08 +00:00
<li>
<a href="Phaser.StageScaleMode.html">StageScaleMode</a>
</li>
More docs.
2013-10-02 11:11:22 +00:00
<li>
<a href="Phaser.State.html">State</a>
</li>
<li>
<a href="Phaser.StateManager.html">StateManager</a>
</li>
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<li>
<a href="Phaser.Text.html">Text</a>
</li>
<li>
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<li>
<a href="Phaser.Time.html">Time</a>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li>
<a href="Phaser.Touch.html">Touch</a>
</li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<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>
More docs.
2013-10-02 11:11:22 +00:00
<li>
<a href="Phaser.World.html">World</a>
</li>
<li>
<a href="SignalBinding.html">SignalBinding</a>
</li>
</ul>
</li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
class="caret"></b></a>
<ul class="dropdown-menu ">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<li>
<a href="global.html#bottom">bottom</a>
</li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<li>
<a href="global.html#HEXtoRGB">HEXtoRGB</a>
</li>
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<li>
<a href="global.html#right">right</a>
</li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
</ul>
</li>
More docs.
2013-10-02 11:11:22 +00:00
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<h1 class="page-title">Class: StateManager</h1>
<section>
<header>
<h2>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
More docs.
2013-10-02 11:11:22 +00:00
StateManager
</h2>
<div class="class-description"><p>Phaser.StateManager</p></div>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="StateManager"><span class="type-signature"></span>new StateManager<span class="signature">(game, <span class="optional">pendingState</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The State Manager is responsible for loading, setting up and switching game states.</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>game</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>A reference to the currently running game.</p></td>
</tr>
<tr>
<td class="name"><code>pendingState</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.State.html">Phaser.State</a></span>
|
<span class="param-type">Object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>A State object to seed the manager with.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-15">line 15</a>
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="current"><span class="type-signature"></span>current<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The current active State object (defaults to null).</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>current</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-68">line 68</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="game"><span class="type-signature"></span>game<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A reference to the currently running game.</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>game.</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-21">line 21</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="game"><span class="type-signature"></span>game<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A reference to the currently running game.</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>game.</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-42">line 42</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="onCreateCallback"><span class="type-signature"></span>onCreateCallback<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This will be called when create states (setup states...).</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>onCreateCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-86">line 86</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="onInitCallback"><span class="type-signature"></span>onInitCallback<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This will be called when the state is started (i.e. set as the current active state).</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>onInitCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-74">line 74</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="onLoadRenderCallback"><span class="type-signature"></span>onLoadRenderCallback<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This will be called when the State is rendered but only during the load process.</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>onLoadRenderCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-116">line 116</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="onLoadUpdateCallback"><span class="type-signature"></span>onLoadUpdateCallback<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This will be called when the State is updated but only during the load process.</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>onLoadUpdateCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-110">line 110</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="onPausedCallback"><span class="type-signature"></span>onPausedCallback<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This will be called when states paused.</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>onPausedCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-122">line 122</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="onPreloadCallback"><span class="type-signature"></span>onPreloadCallback<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This will be called when init states (loading assets...).</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>onPreloadCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-80">line 80</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="onPreRenderCallback"><span class="type-signature"></span>onPreRenderCallback<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This will be called before the State is rendered and before the stage is cleared.</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>onPreRenderCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-104">line 104</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="onRenderCallback"><span class="type-signature"></span>onRenderCallback<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This will be called when the State is rendered, this doesn't happen during load (see onLoadRenderCallback).</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>onRenderCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-98">line 98</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="onShutDownCallback"><span class="type-signature"></span>onShutDownCallback<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This will be called when the state is shut down (i.e. swapped to another state).</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>onShutDownCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-128">line 128</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="onUpdateCallback"><span class="type-signature"></span>onUpdateCallback<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This will be called when State is updated, this doesn't happen during load (@see onLoadUpdateCallback).</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>onUpdateCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-92">line 92</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="states"><span class="type-signature"></span>states<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Description.</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>states.</code></td>
<td class="type">
<span class="param-type">Description</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-27">line 27</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="states"><span class="type-signature"></span>states<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The state to be switched to in the next frame.</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>states</code></td>
<td class="type">
<span class="param-type">Description</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-62">line 62</a>
</li></ul></dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="add"><span class="type-signature"></span>add<span class="signature">(key, state, autoStart)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add a new State.</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>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>A unique key you use to reference this state, i.e. &quot;MainMenu&quot;, &quot;Level1&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>state</code></td>
<td class="type">
<span class="param-type">State</span>
</td>
<td class="description last"><p>The state you want to switch to.</p></td>
</tr>
<tr>
<td class="name"><code>autoStart</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Start the state immediately after creating it? (default true)</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-158">line 158</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="checkState"><span class="type-signature"></span>checkState<span class="signature">(key)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Description.</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>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The key of the state you want to check.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-326">line 326</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Description.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</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="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-499">line 499</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="link"><span class="type-signature">&lt;protected> </span>link<span class="signature">(key)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Links game properties to the State given by the key.</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>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>State key.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-364">line 364</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="loadComplete"><span class="type-signature">&lt;protected> </span>loadComplete<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-425">line 425</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="preRender"><span class="type-signature">&lt;protected> </span>preRender<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-466">line 466</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="remove"><span class="type-signature"></span>remove<span class="signature">(key)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Delete the given state.</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>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>A unique key you use to reference this state, i.e. &quot;MainMenu&quot;, &quot;Level1&quot;.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-212">line 212</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="render"><span class="type-signature">&lt;protected> </span>render<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-479">line 479</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setCurrentState"><span class="type-signature">&lt;protected> </span>setCurrentState<span class="signature">(key)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Sets the current State. Should not be called directly (use StateManager.start)</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>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>State key.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-391">line 391</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="start"><span class="type-signature"></span>start<span class="signature">(key, <span class="optional">clearWorld</span>, <span class="optional">clearCache</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Start the given state</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The key of the state you want to start.</p></td>
</tr>
<tr>
<td class="name"><code>clearWorld</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>clear everything in the world? (Default to true)</p></td>
</tr>
<tr>
<td class="name"><code>clearCache</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>clear asset cache? (Default to false and ONLY available when clearWorld=true)</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-240">line 240</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="update"><span class="type-signature">&lt;protected> </span>update<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-446">line 446</a>
</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Phaser Copyright © 2012-2013 Photon Storm Ltd.
</span>
<br />
<span class="jsdoc-message">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
Added in a Group.sort demo, also updated the documentation and build files.
2013-11-07 06:10:15 +00:00
on Thu Nov 07 2013 06:07:41 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
More docs.
2013-10-02 11:11:22 +00:00
</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>
Reference in a new issue Copy permalink