2013-10-02 11:11:22 +00:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<title>Phaser Source: core/State.js</title>
|
|
|
|
|
|
|
|
|
|
<!--[if lt IE 9]>
|
|
|
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
|
|
|
<![endif]-->
|
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
<div class="container-fluid">
|
|
|
|
|
<div class="navbar navbar-fixed-top navbar-inverse">
|
|
|
|
|
<div class="navbar-inner">
|
|
|
|
|
<a class="brand" href="index.html">Phaser</a>
|
|
|
|
|
<ul class="nav">
|
|
|
|
|
|
|
|
|
|
<li class="dropdown">
|
|
|
|
|
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b
|
|
|
|
|
class="caret"></b></a>
|
|
|
|
|
|
|
|
|
|
<ul class="dropdown-menu ">
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="module-Phaser.html">Phaser</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="PluginManager.html">PluginManager</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.Animation.Frame.html">Frame</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="Phaser.Animation.FrameData.html">FrameData</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="Phaser.Animation.Parser.html">Parser</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="Phaser.AnimationManager.html">AnimationManager</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="Phaser.Camera.html">Camera</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="Phaser.Circle.html">Circle</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="Phaser.Game.html">Game</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="Phaser.Group.html">Group</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
2013-10-02 12:18:58 +00:00
|
|
|
<li>
|
|
|
|
|
<a href="Phaser.Input.html">Input</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
2013-10-02 11:11:22 +00:00
|
|
|
<li>
|
|
|
|
|
<a href="Phaser.LinkedList.html">LinkedList</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="PluginManager-Phaser.PluginManager.html">PluginManager</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="Phaser.Plugin.html">Plugin</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="Phaser.Point.html">Point</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="Phaser.Rectangle.html">Rectangle</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="Phaser.Signal.html">Signal</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="Phaser.Stage.html">Stage</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="Phaser.State.html">State</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="Phaser.StateManager.html">StateManager</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="Phaser.World.html">World</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="SignalBinding.html">SignalBinding</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="span12">
|
|
|
|
|
|
|
|
|
|
<div id="main">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h1 class="page-title">Source: core/State.js</h1>
|
|
|
|
|
|
|
|
|
|
<section>
|
|
|
|
|
<article>
|
|
|
|
|
<pre class="sunlight-highlight-javascript linenums">/**
|
|
|
|
|
* @author Richard Davey <rich@photonstorm.com>
|
|
|
|
|
* @copyright 2013 Photon Storm Ltd.
|
|
|
|
|
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This is a base State class which can be extended if you are creating your own game.
|
|
|
|
|
* It provides quick access to common functions such as the camera, cache, input, match, sound and more.
|
|
|
|
|
*
|
|
|
|
|
* @class Phaser.State
|
|
|
|
|
* @constructor
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
Phaser.State = function () {
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {Phaser.Game} game - A reference to the currently running Game.
|
|
|
|
|
*/
|
|
|
|
|
this.game = null;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {Phaser.GameObjectFactory} add - Reference to the GameObjectFactory.
|
|
|
|
|
* @default
|
|
|
|
|
*/
|
|
|
|
|
this.add = null;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {Phaser.Physics.PhysicsManager} camera - A handy reference to world.camera.
|
|
|
|
|
* @default
|
|
|
|
|
*/
|
|
|
|
|
this.camera = null;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {Phaser.Cache} cache - Reference to the assets cache.
|
|
|
|
|
* @default
|
|
|
|
|
*/
|
|
|
|
|
this.cache = null;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {Phaser.Input} input - Reference to the input manager
|
|
|
|
|
* @default
|
|
|
|
|
*/
|
|
|
|
|
this.input = null;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {Phaser.Loader} load - Reference to the assets loader.
|
|
|
|
|
* @default
|
|
|
|
|
*/
|
|
|
|
|
this.load = null;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {Phaser.GameMath} math - Reference to the math helper.
|
|
|
|
|
* @default
|
|
|
|
|
*/
|
|
|
|
|
this.math = null;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {Phaser.SoundManager} sound - Reference to the sound manager.
|
|
|
|
|
* @default
|
|
|
|
|
*/
|
|
|
|
|
this.sound = null;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {Phaser.Stage} stage - Reference to the stage.
|
|
|
|
|
* @default
|
|
|
|
|
*/
|
|
|
|
|
this.stage = null;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {Phaser.TimeManager} time - Reference to game clock.
|
|
|
|
|
* @default
|
|
|
|
|
*/
|
|
|
|
|
this.time = null;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {Phaser.TweenManager} tweens - Reference to the tween manager.
|
|
|
|
|
* @default
|
|
|
|
|
*/
|
|
|
|
|
this.tweens = null;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {Phaser.World} world - Reference to the world.
|
|
|
|
|
* @default
|
|
|
|
|
*/
|
|
|
|
|
this.world = null;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {Description} add - Description.
|
|
|
|
|
* @default
|
|
|
|
|
*/
|
|
|
|
|
this.particles = null;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {Phaser.Physics.PhysicsManager} physics - Reference to the physics manager.
|
|
|
|
|
* @default
|
|
|
|
|
*/
|
|
|
|
|
this.physics = null;
|
|
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
Phaser.State.prototype = {
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Override this method to add some load operations.
|
|
|
|
|
* If you need to use the loader, you may need to use them here.
|
|
|
|
|
*
|
|
|
|
|
* @method Phaser.State#preload
|
|
|
|
|
*/
|
|
|
|
|
preload: function () {
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Put update logic here.
|
|
|
|
|
*
|
|
|
|
|
* @method Phaser.State#loadUpdate
|
|
|
|
|
*/
|
|
|
|
|
loadUpdate: function () {
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Put render operations here.
|
|
|
|
|
*
|
|
|
|
|
* @method Phaser.State#loadRender
|
|
|
|
|
*/
|
|
|
|
|
loadRender: function () {
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This method is called after the game engine successfully switches states.
|
|
|
|
|
* Feel free to add any setup code here (do not load anything here, override preload() instead).
|
|
|
|
|
*
|
|
|
|
|
* @method Phaser.State#create
|
|
|
|
|
*/
|
|
|
|
|
create: function () {
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Put update logic here.
|
|
|
|
|
*
|
|
|
|
|
* @method Phaser.State#update
|
|
|
|
|
*/
|
|
|
|
|
update: function () {
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Put render operations here.
|
|
|
|
|
*
|
|
|
|
|
* @method Phaser.State#render
|
|
|
|
|
*/
|
|
|
|
|
render: function () {
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This method will be called when game paused.
|
|
|
|
|
*
|
|
|
|
|
* @method Phaser.State#paused
|
|
|
|
|
*/
|
|
|
|
|
paused: function () {
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This method will be called when the state is destroyed.
|
|
|
|
|
* @method Phaser.State#destroy
|
|
|
|
|
*/
|
|
|
|
|
destroy: function () {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
};
|
|
|
|
|
</pre>
|
|
|
|
|
</article>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="clearfix"></div>
|
|
|
|
|
<footer>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="copyright">
|
|
|
|
|
Phaser Copyright © 2012-2013 Photon Storm Ltd.
|
|
|
|
|
</span>
|
|
|
|
|
<br />
|
|
|
|
|
|
|
|
|
|
<span class="jsdoc-message">
|
|
|
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
|
2013-10-02 12:18:58 +00:00
|
|
|
on Wed Oct 02 2013 12:28:25 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
|
2013-10-02 11:11:22 +00:00
|
|
|
</span>
|
|
|
|
|
</footer>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<br clear="both">
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
<script src="scripts/sunlight.js"></script>
|
|
|
|
|
<script src="scripts/sunlight.javascript.js"></script>
|
|
|
|
|
<script src="scripts/sunlight-plugin.doclinks.js"></script>
|
|
|
|
|
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
|
|
|
|
|
<script src="scripts/sunlight-plugin.menu.js"></script>
|
|
|
|
|
<script src="scripts/jquery.min.js"></script>
|
|
|
|
|
<script src="scripts/jquery.scrollTo.js"></script>
|
|
|
|
|
<script src="scripts/jquery.localScroll.js"></script>
|
|
|
|
|
<script src="scripts/bootstrap-dropdown.js"></script>
|
|
|
|
|
<script src="scripts/toc.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
|
|
|
$( function () {
|
|
|
|
|
$( "#toc" ).toc( {
|
|
|
|
|
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>
|
