2013-10-02 11:11:22 +00:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<title>Phaser Source: core/World.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/World.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 world is but a canvas to our imagination." - Henry David Thoreau
|
|
|
|
|
* <p>
|
|
|
|
|
* A game has only one world. The world is an abstract place in which all game objects live. It is not bound
|
|
|
|
|
* by stage limits and can be any size. You look into the world via cameras. All game objects live within
|
|
|
|
|
* the world at world-based coordinates. By default a world is created the same size as your Stage.
|
|
|
|
|
*
|
|
|
|
|
* @class Phaser.World
|
|
|
|
|
* @constructor
|
|
|
|
|
* @param {Phaser.Game} game - Reference to the current game instance.
|
|
|
|
|
*/
|
|
|
|
|
Phaser.World = function (game) {
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {Phaser.Game} game - A reference to the currently running Game.
|
|
|
|
|
*/
|
|
|
|
|
this.game = game;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {Phaser.Rectangle} bounds - Bound of this world that objects can not escape from.
|
|
|
|
|
*/
|
|
|
|
|
this.bounds = new Phaser.Rectangle(0, 0, game.width, game.height);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {Phaser.Camera} camera - Camera instance.
|
|
|
|
|
*/
|
|
|
|
|
this.camera = null;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {number} currentRenderOrderID - Reset each frame, keeps a count of the total number of objects updated.
|
|
|
|
|
*/
|
|
|
|
|
this.currentRenderOrderID = 0;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @property {Phaser.Group} group - Object container stores every object created with `create*` methods.
|
|
|
|
|
*/
|
|
|
|
|
this.group = null;
|
|
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
Phaser.World.prototype = {
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Initialises the game world.
|
|
|
|
|
*
|
|
|
|
|
* @method Phaser.World#boot
|
|
|
|
|
* @protected
|
|
|
|
|
*/
|
|
|
|
|
boot: function () {
|
|
|
|
|
|
|
|
|
|
this.camera = new Phaser.Camera(this.game, 0, 0, 0, this.game.width, this.game.height);
|
|
|
|
|
|
|
|
|
|
this.game.camera = this.camera;
|
|
|
|
|
|
|
|
|
|
this.group = new Phaser.Group(this.game, null, '__world', true);
|
|
|
|
|
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This is called automatically every frame, and is where main logic happens.
|
|
|
|
|
*
|
|
|
|
|
* @method Phaser.World#update
|
|
|
|
|
*/
|
|
|
|
|
update: function () {
|
|
|
|
|
|
|
|
|
|
this.camera.update();
|
|
|
|
|
|
|
|
|
|
this.currentRenderOrderID = 0;
|
|
|
|
|
|
|
|
|
|
if (this.game.stage._stage.first._iNext)
|
|
|
|
|
{
|
|
|
|
|
var currentNode = this.game.stage._stage.first._iNext;
|
|
|
|
|
|
|
|
|
|
do
|
|
|
|
|
{
|
|
|
|
|
if (currentNode['preUpdate'])
|
|
|
|
|
{
|
|
|
|
|
currentNode.preUpdate();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (currentNode['update'])
|
|
|
|
|
{
|
|
|
|
|
currentNode.update();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
currentNode = currentNode._iNext;
|
|
|
|
|
}
|
|
|
|
|
while (currentNode != this.game.stage._stage.last._iNext)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This is called automatically every frame, and is where main logic happens.
|
|
|
|
|
* @method Phaser.World#postUpdate
|
|
|
|
|
*/
|
|
|
|
|
postUpdate: function () {
|
|
|
|
|
|
|
|
|
|
if (this.game.stage._stage.first._iNext)
|
|
|
|
|
{
|
|
|
|
|
var currentNode = this.game.stage._stage.first._iNext;
|
|
|
|
|
|
|
|
|
|
do
|
|
|
|
|
{
|
|
|
|
|
if (currentNode['postUpdate'])
|
|
|
|
|
{
|
|
|
|
|
currentNode.postUpdate();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
currentNode = currentNode._iNext;
|
|
|
|
|
}
|
|
|
|
|
while (currentNode != this.game.stage._stage.last._iNext)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Updates the size of this world.
|
|
|
|
|
* @method Phaser.World#setSize
|
|
|
|
|
* @param {number} width - New width of the world.
|
|
|
|
|
* @param {number} height - New height of the world.
|
|
|
|
|
*/
|
|
|
|
|
setSize: function (width, height) {
|
|
|
|
|
|
|
|
|
|
if (width >= this.game.width)
|
|
|
|
|
{
|
|
|
|
|
this.bounds.width = width;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (height >= this.game.height)
|
|
|
|
|
{
|
|
|
|
|
this.bounds.height = height;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Destroyer of worlds.
|
|
|
|
|
* @method Phaser.World#destroy
|
|
|
|
|
*/
|
|
|
|
|
destroy: function () {
|
|
|
|
|
|
|
|
|
|
this.camera.x = 0;
|
|
|
|
|
this.camera.y = 0;
|
|
|
|
|
|
|
|
|
|
this.game.input.reset(true);
|
|
|
|
|
|
|
|
|
|
this.group.removeAll();
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @name Phaser.World#width
|
|
|
|
|
* @property {number} width - Gets or sets the current width of the game world.
|
|
|
|
|
*/
|
|
|
|
|
Object.defineProperty(Phaser.World.prototype, "width", {
|
|
|
|
|
|
|
|
|
|
get: function () {
|
|
|
|
|
return this.bounds.width;
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
set: function (value) {
|
|
|
|
|
this.bounds.width = value;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @name Phaser.World#height
|
|
|
|
|
* @property {number} height - Gets or sets the current height of the game world.
|
|
|
|
|
*/
|
|
|
|
|
Object.defineProperty(Phaser.World.prototype, "height", {
|
|
|
|
|
|
|
|
|
|
get: function () {
|
|
|
|
|
return this.bounds.height;
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
set: function (value) {
|
|
|
|
|
this.bounds.height = value;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @name Phaser.World#centerX
|
|
|
|
|
* @property {number} centerX - Gets the X position corresponding to the center point of the world.
|
|
|
|
|
* @readonly
|
|
|
|
|
*/
|
|
|
|
|
Object.defineProperty(Phaser.World.prototype, "centerX", {
|
|
|
|
|
|
|
|
|
|
get: function () {
|
|
|
|
|
return this.bounds.halfWidth;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @name Phaser.World#centerY
|
|
|
|
|
* @property {number} centerY - Gets the Y position corresponding to the center point of the world.
|
|
|
|
|
* @readonly
|
|
|
|
|
*/
|
|
|
|
|
Object.defineProperty(Phaser.World.prototype, "centerY", {
|
|
|
|
|
|
|
|
|
|
get: function () {
|
|
|
|
|
return this.bounds.halfHeight;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @name Phaser.World#randomX
|
|
|
|
|
* @property {number} randomX - Gets a random integer which is lesser than or equal to the current width of the game world.
|
|
|
|
|
* @readonly
|
|
|
|
|
*/
|
|
|
|
|
Object.defineProperty(Phaser.World.prototype, "randomX", {
|
|
|
|
|
|
|
|
|
|
get: function () {
|
|
|
|
|
return Math.round(Math.random() * this.bounds.width);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @name Phaser.World#randomY
|
|
|
|
|
* @property {number} randomY - Gets a random integer which is lesser than or equal to the current height of the game world.
|
|
|
|
|
* @readonly
|
|
|
|
|
*/
|
|
|
|
|
Object.defineProperty(Phaser.World.prototype, "randomY", {
|
|
|
|
|
|
|
|
|
|
get: function () {
|
|
|
|
|
return Math.round(Math.random() * this.bounds.height);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
});
|
|
|
|
|
</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>
|
