mirror of
https://github.com/photonstorm/phaser
synced 2024-11-23 21:24:09 +00:00
782 lines
17 KiB
HTML
782 lines
17 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Phaser Source: core/PluginManager.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="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.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.Graphics.html">Graphics</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Group.html">Group</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.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.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.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#bottom">bottom</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="global.html#HEXtoRGB">HEXtoRGB</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="global.html#render">render</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="global.html#renderXY">renderXY</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="global.html#right">right</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span12">
|
|
|
|
<div id="main">
|
|
|
|
|
|
|
|
<h1 class="page-title">Source: core/PluginManager.js</h1>
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="sunlight-highlight-javascript linenums">/* jshint newcap: false */
|
|
|
|
/**
|
|
* @author Richard Davey <rich@photonstorm.com>
|
|
* @copyright 2013 Photon Storm Ltd.
|
|
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
|
|
*/
|
|
|
|
/**
|
|
* The Plugin Manager is responsible for the loading, running and unloading of Phaser Plugins.
|
|
*
|
|
* @class Phaser.PluginManager
|
|
* @classdesc Phaser - PluginManager
|
|
* @constructor
|
|
* @param {Phaser.Game} game - A reference to the currently running game.
|
|
* @param {Description} parent - Description.
|
|
*/
|
|
Phaser.PluginManager = function(game, parent) {
|
|
|
|
/**
|
|
* @property {Phaser.Game} game - A reference to the currently running game.
|
|
*/
|
|
this.game = game;
|
|
|
|
/**
|
|
* @property {Description} _parent - Description.
|
|
* @private
|
|
*/
|
|
this._parent = parent;
|
|
|
|
/**
|
|
* @property {array} plugins - Description.
|
|
*/
|
|
this.plugins = [];
|
|
|
|
/**
|
|
* @property {array} _pluginsLength - Description.
|
|
* @private
|
|
* @default
|
|
*/
|
|
this._pluginsLength = 0;
|
|
|
|
};
|
|
|
|
Phaser.PluginManager.prototype = {
|
|
|
|
/**
|
|
* Add a new Plugin to the PluginManager.
|
|
* The plugin's game and parent reference are set to this game and pluginmanager parent.
|
|
* @method Phaser.PluginManager#add
|
|
* @param {Phaser.Plugin} plugin - Description.
|
|
* @return {Phaser.Plugin} Description.
|
|
*/
|
|
add: function (plugin) {
|
|
|
|
var result = false;
|
|
|
|
// Prototype?
|
|
if (typeof plugin === 'function')
|
|
{
|
|
plugin = new plugin(this.game, this._parent);
|
|
}
|
|
else
|
|
{
|
|
plugin.game = this.game;
|
|
plugin.parent = this._parent;
|
|
}
|
|
|
|
// Check for methods now to avoid having to do this every loop
|
|
if (typeof plugin['preUpdate'] === 'function')
|
|
{
|
|
plugin.hasPreUpdate = true;
|
|
result = true;
|
|
}
|
|
|
|
if (typeof plugin['update'] === 'function')
|
|
{
|
|
plugin.hasUpdate = true;
|
|
result = true;
|
|
}
|
|
|
|
if (typeof plugin['postUpdate'] === 'function')
|
|
{
|
|
plugin.hasPostUpdate = true;
|
|
result = true;
|
|
}
|
|
|
|
if (typeof plugin['render'] === 'function')
|
|
{
|
|
plugin.hasRender = true;
|
|
result = true;
|
|
}
|
|
|
|
if (typeof plugin['postRender'] === 'function')
|
|
{
|
|
plugin.hasPostRender = true;
|
|
result = true;
|
|
}
|
|
|
|
// The plugin must have at least one of the above functions to be added to the PluginManager.
|
|
if (result)
|
|
{
|
|
if (plugin.hasPreUpdate || plugin.hasUpdate || plugin.hasPostUpdate)
|
|
{
|
|
plugin.active = true;
|
|
}
|
|
|
|
if (plugin.hasRender || plugin.hasPostRender)
|
|
{
|
|
plugin.visible = true;
|
|
}
|
|
|
|
this._pluginsLength = this.plugins.push(plugin);
|
|
|
|
// Allows plugins to run potentially destructive code outside of the constructor, and only if being added to the PluginManager
|
|
if (typeof plugin['init'] === 'function')
|
|
{
|
|
plugin.init();
|
|
}
|
|
|
|
return plugin;
|
|
}
|
|
else
|
|
{
|
|
return null;
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Remove a Plugin from the PluginManager.
|
|
* @method Phaser.PluginManager#remove
|
|
* @param {Phaser.Plugin} plugin - The plugin to be removed.
|
|
*/
|
|
remove: function (plugin) {
|
|
|
|
if (this._pluginsLength === 0)
|
|
{
|
|
return;
|
|
}
|
|
|
|
for (this._p = 0; this._p < this._pluginsLength; this._p++)
|
|
{
|
|
if (this.plugins[this._p] === plugin)
|
|
{
|
|
plugin.destroy();
|
|
this.plugins.splice(this._p, 1);
|
|
this._pluginsLength--;
|
|
return;
|
|
}
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Removes all Plugins from the PluginManager.
|
|
* @method Phaser.PluginManager#removeAll
|
|
*/
|
|
removeAll: function() {
|
|
|
|
for (this._p = 0; this._p < this._pluginsLength; this._p++)
|
|
{
|
|
this.plugins[this._p].destroy();
|
|
}
|
|
this.plugins.length = 0;
|
|
this._pluginsLength = 0;
|
|
},
|
|
|
|
/**
|
|
* Pre-update is called at the very start of the update cycle, before any other subsystems have been updated (including Physics).
|
|
* It only calls plugins who have active=true.
|
|
*
|
|
* @method Phaser.PluginManager#preUpdate
|
|
*/
|
|
preUpdate: function () {
|
|
|
|
if (this._pluginsLength === 0)
|
|
{
|
|
return;
|
|
}
|
|
|
|
for (this._p = 0; this._p < this._pluginsLength; this._p++)
|
|
{
|
|
if (this.plugins[this._p].active && this.plugins[this._p].hasPreUpdate)
|
|
{
|
|
this.plugins[this._p].preUpdate();
|
|
}
|
|
}
|
|
|
|
},
|
|
|
|
/**
|
|
* Update is called after all the core subsystems (Input, Tweens, Sound, etc) and the State have updated, but before the render.
|
|
* It only calls plugins who have active=true.
|
|
*
|
|
* @method Phaser.PluginManager#update
|
|
*/
|
|
update: function () {
|
|
|
|
if (this._pluginsLength === 0)
|
|
{
|
|
return;
|
|
}
|
|
|
|
for (this._p = 0; this._p < this._pluginsLength; this._p++)
|
|
{
|
|
if (this.plugins[this._p].active && this.plugins[this._p].hasUpdate)
|
|
{
|
|
this.plugins[this._p].update();
|
|
}
|
|
}
|
|
|
|
},
|
|
|
|
/**
|
|
* PostUpdate is the last thing to be called before the world render.
|
|
* In particular, it is called after the world postUpdate, which means the camera has been adjusted.
|
|
* It only calls plugins who have active=true.
|
|
*
|
|
* @method Phaser.PluginManager#postUpdate
|
|
*/
|
|
postUpdate: function () {
|
|
|
|
if (this._pluginsLength === 0)
|
|
{
|
|
return;
|
|
}
|
|
|
|
for (this._p = 0; this._p < this._pluginsLength; this._p++)
|
|
{
|
|
if (this.plugins[this._p].active && this.plugins[this._p].hasPostUpdate)
|
|
{
|
|
this.plugins[this._p].postUpdate();
|
|
}
|
|
}
|
|
|
|
},
|
|
|
|
/**
|
|
* Render is called right after the Game Renderer completes, but before the State.render.
|
|
* It only calls plugins who have visible=true.
|
|
*
|
|
* @method Phaser.PluginManager#render
|
|
*/
|
|
render: function () {
|
|
|
|
if (this._pluginsLength === 0)
|
|
{
|
|
return;
|
|
}
|
|
|
|
for (this._p = 0; this._p < this._pluginsLength; this._p++)
|
|
{
|
|
if (this.plugins[this._p].visible && this.plugins[this._p].hasRender)
|
|
{
|
|
this.plugins[this._p].render();
|
|
}
|
|
}
|
|
|
|
},
|
|
|
|
/**
|
|
* Post-render is called after the Game Renderer and State.render have run.
|
|
* It only calls plugins who have visible=true.
|
|
*
|
|
* @method Phaser.PluginManager#postRender
|
|
*/
|
|
postRender: function () {
|
|
|
|
if (this._pluginsLength === 0)
|
|
{
|
|
return;
|
|
}
|
|
|
|
for (this._p = 0; this._p < this._pluginsLength; this._p++)
|
|
{
|
|
if (this.plugins[this._p].visible && this.plugins[this._p].hasPostRender)
|
|
{
|
|
this.plugins[this._p].postRender();
|
|
}
|
|
}
|
|
|
|
},
|
|
|
|
/**
|
|
* Clear down this PluginManager and null out references
|
|
*
|
|
* @method Phaser.PluginManager#destroy
|
|
*/
|
|
destroy: function () {
|
|
|
|
this.plugins.length = 0;
|
|
this._pluginsLength = 0;
|
|
this.game = null;
|
|
this._parent = null;
|
|
|
|
}
|
|
|
|
};
|
|
</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.3.0-dev</a>
|
|
on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
|
|
</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>
|