wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-07-17 01:30:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

Lots of doc updates!

Browse Source
This commit is contained in:
photonstorm
2013-10-25 16:54:40 +01:00
parent 0463bb4333
commit 9f9e6a2a57
147 changed files with 60434 additions and 972 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Game.js.html
+141 -13
View File
@@ -54,6 +54,18 @@
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
<li>
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
<li>
<a href="Phaser.Bullet.html">Bullet</a>
</li>
<li>
<a href="Phaser.Button.html">Button</a>
</li>
<li>
<a href="Phaser.Cache.html">Cache</a>
</li>
@@ -126,6 +138,10 @@
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
<li>
<a href="Phaser.Events.html">Events</a>
</li>
<li>
<a href="Phaser.Frame.html">Frame</a>
</li>
@@ -138,6 +154,14 @@
<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>
@@ -194,6 +218,14 @@
<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.Plugin.html">Plugin</a>
</li>
@@ -222,6 +254,10 @@
<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>
@@ -238,6 +274,10 @@
<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>
@@ -254,6 +294,14 @@
<a href="Phaser.StateManager.html">StateManager</a>
</li>
<li>
<a href="Phaser.Text.html">Text</a>
</li>
<li>
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
<li>
<a href="Phaser.Time.html">Time</a>
</li>
@@ -296,10 +344,82 @@
<ul class="dropdown-menu ">
<li>
<a href="global.html#audio">audio</a>
</li>
<li>
<a href="global.html#bitmapText">bitmapText</a>
</li>
<li>
<a href="global.html#bottom">bottom</a>
</li>
<li>
<a href="global.html#button">button</a>
</li>
<li>
<a href="global.html#child">child</a>
</li>
<li>
<a href="global.html#emitter">emitter</a>
</li>
<li>
<a href="global.html#existing.">existing.</a>
</li>
<li>
<a href="global.html#graphics">graphics</a>
</li>
<li>
<a href="global.html#group">group</a>
</li>
<li>
<a href="global.html#HEXtoRGB">HEXtoRGB</a>
</li>
<li>
<a href="global.html#renderTexture">renderTexture</a>
</li>
<li>
<a href="global.html#right">right</a>
</li>
<li>
<a href="global.html#sprite">sprite</a>
</li>
<li>
<a href="global.html#text">text</a>
</li>
<li>
<a href="global.html#tilemap">tilemap</a>
</li>
<li>
<a href="global.html#tilemaplayer">tilemaplayer</a>
</li>
<li>
<a href="global.html#tileset">tileset</a>
</li>
<li>
<a href="global.html#tileSprite">tileSprite</a>
</li>
<li>
<a href="global.html#tween">tween</a>
</li>
</ul>
</li>
@@ -355,7 +475,7 @@ Phaser.Game = function (width, height, renderer, parent, state, transparent, ant
if (typeof transparent == 'undefined') { transparent = false; }
if (typeof antialias == 'undefined') { antialias = true; }
/**
* @property {number} id - Phaser Game ID (for when Pixi supports multiple instances).
*/
@@ -574,7 +694,7 @@ Phaser.Game.prototype = {
/**
* Initialize engine sub modules and start the game.
*
*
* @method Phaser.Game#boot
* @protected
*/
@@ -638,10 +758,13 @@ Phaser.Game.prototype = {
console.log('%cPhaser ' + Phaser.VERSION + ' initialized. Rendering to WebGL', 'color: #ffff33; background: #000000');
}
if (Phaser.VERSION.substr(-5) == '-beta')
{
console.warn('You are using a beta version of Phaser. Some things may not work.');
}
var pos = Phaser.VERSION.indexOf('-');
var versionQualifier = (pos >= 0) ? Phaser.VERSION.substr(pos + 1) : null;
if (versionQualifier)
{
var article = ['a', 'e', 'i', 'o', 'u', 'y'].indexOf(versionQualifier.charAt(0)) >= 0 ? 'an' : 'a';
console.warn('You are using %s %s version of Phaser. Some things may not work.', article, versionQualifier);
}
this.isRunning = true;
this._loadComplete = false;
@@ -652,10 +775,10 @@ Phaser.Game.prototype = {
}
},
/**
* Checks if the device is capable of using the requested renderer and sets it up or an alternative if not.
*
*
* @method Phaser.Game#setUpRenderer
* @protected
*/
@@ -692,7 +815,7 @@ Phaser.Game.prototype = {
/**
* Called when the load has finished, after preload was run.
*
*
* @method Phaser.Game#loadComplete
* @protected
*/
@@ -706,7 +829,7 @@ Phaser.Game.prototype = {
/**
* The core game loop.
*
*
* @method Phaser.Game#update
* @protected
* @param {number} time - The current time as provided by RequestAnimationFrame.
@@ -720,6 +843,7 @@ Phaser.Game.prototype = {
this.plugins.preUpdate();
this.physics.preUpdate();
this.stage.update();
this.input.update();
this.tweens.update();
this.sound.update();
@@ -741,11 +865,15 @@ Phaser.Game.prototype = {
/**
* Nuke the entire game from orbit
*
*
* @method Phaser.Game#destroy
*/
destroy: function () {
this.raf.stop();
this.input.destroy();
this.state.destroy();
this.state = null;
@@ -820,8 +948,8 @@ Object.defineProperty(Phaser.Game.prototype, "paused", {
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Fri Oct 25 2013 16:16:43 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>