mirror of
https://github.com/photonstorm/phaser
synced 2024-12-24 20:13:35 +00:00
530 lines
14 KiB
HTML
530 lines
14 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<title>Phaser Source: animation/AnimationManager.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>
|
||
|
|
|
||
|
|
|
||
|
|
</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.Game.html">Game</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="Phaser.Group.html">Group</a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="row-fluid">
|
||
|
|
|
||
|
|
|
||
|
|
<div class="span12">
|
||
|
|
|
||
|
|
<div id="main">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h1 class="page-title">Source: animation/AnimationManager.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}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The Animation Manager is used to add, play and update Phaser Animations.
|
||
|
|
* Any Game Object such as Phaser.Sprite that supports animation contains a single AnimationManager instance.
|
||
|
|
*
|
||
|
|
* @class Phaser.AnimationManager
|
||
|
|
* @constructor
|
||
|
|
* @param {Phaser.Sprite} sprite - A reference to the Game Object that owns this AnimationManager.
|
||
|
|
*/
|
||
|
|
Phaser.AnimationManager = function (sprite) {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @property {Phaser.Sprite} sprite - A reference to the parent Sprite that owns this AnimationManager.
|
||
|
|
*/
|
||
|
|
this.sprite = sprite;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @property {Phaser.Game} game - A reference to the currently running Game.
|
||
|
|
*/
|
||
|
|
this.game = sprite.game;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @property {Phaser.Animation.Frame} currentFrame - The currently displayed Frame of animation, if any.
|
||
|
|
* @default
|
||
|
|
*/
|
||
|
|
this.currentFrame = null;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @property {boolean} updateIfVisible - Should the animation data continue to update even if the Sprite.visible is set to false.
|
||
|
|
* @default
|
||
|
|
*/
|
||
|
|
this.updateIfVisible = true;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @property {Phaser.Animation.FrameData} _frameData - A temp. var for holding the currently playing Animations FrameData.
|
||
|
|
* @private
|
||
|
|
* @default
|
||
|
|
*/
|
||
|
|
this._frameData = null;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @property {object} _anims - An internal object that stores all of the Animation instances.
|
||
|
|
* @private
|
||
|
|
*/
|
||
|
|
this._anims = {};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @property {object} _outputFrames - An internal object to help avoid gc.
|
||
|
|
* @private
|
||
|
|
*/
|
||
|
|
this._outputFrames = [];
|
||
|
|
|
||
|
|
};
|
||
|
|
|
||
|
|
Phaser.AnimationManager.prototype = {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Loads FrameData into the internal temporary vars and resets the frame index to zero.
|
||
|
|
* This is called automatically when a new Sprite is created.
|
||
|
|
*
|
||
|
|
* @method Phaser.AnimationManager#loadFrameData
|
||
|
|
* @private
|
||
|
|
* @param {Phaser.Animation.FrameData} frameData - The FrameData set to load.
|
||
|
|
*/
|
||
|
|
loadFrameData: function (frameData) {
|
||
|
|
|
||
|
|
this._frameData = frameData;
|
||
|
|
this.frame = 0;
|
||
|
|
|
||
|
|
},
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Adds a new animation under the given key. Optionally set the frames, frame rate and loop.
|
||
|
|
* Animations added in this way are played back with the play function.
|
||
|
|
*
|
||
|
|
* @method Phaser.AnimationManager#add
|
||
|
|
* @param {string} name - The unique (within this Sprite) name for the animation, i.e. "run", "fire", "walk".
|
||
|
|
* @param {Array} [frames=null] - An array of numbers/strings that correspond to the frames to add to this animation and in which order. e.g. [1, 2, 3] or ['run0', 'run1', run2]). If null then all frames will be used.
|
||
|
|
* @param {number} [frameRate=60] - The speed at which the animation should play. The speed is given in frames per second.
|
||
|
|
* @param {boolean} [loop=false] - Whether or not the animation is looped or just plays once.
|
||
|
|
* @param {boolean} [useNumericIndex=true] - Are the given frames using numeric indexes (default) or strings?
|
||
|
|
* @return {Phaser.Animation} The Animation object that was created.
|
||
|
|
*/
|
||
|
|
add: function (name, frames, frameRate, loop, useNumericIndex) {
|
||
|
|
|
||
|
|
if (this._frameData == null)
|
||
|
|
{
|
||
|
|
console.warn('No FrameData available for Phaser.Animation ' + name);
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
frameRate = frameRate || 60;
|
||
|
|
|
||
|
|
if (typeof loop === 'undefined') { loop = false; }
|
||
|
|
if (typeof useNumericIndex === 'undefined') { useNumericIndex = true; }
|
||
|
|
|
||
|
|
// Create the signals the AnimationManager will emit
|
||
|
|
if (this.sprite.events.onAnimationStart == null)
|
||
|
|
{
|
||
|
|
this.sprite.events.onAnimationStart = new Phaser.Signal();
|
||
|
|
this.sprite.events.onAnimationComplete = new Phaser.Signal();
|
||
|
|
this.sprite.events.onAnimationLoop = new Phaser.Signal();
|
||
|
|
}
|
||
|
|
|
||
|
|
this._outputFrames.length = 0;
|
||
|
|
|
||
|
|
this._frameData.getFrameIndexes(frames, useNumericIndex, this._outputFrames);
|
||
|
|
|
||
|
|
this._anims[name] = new Phaser.Animation(this.game, this.sprite, name, this._frameData, this._outputFrames, frameRate, loop);
|
||
|
|
this.currentAnim = this._anims[name];
|
||
|
|
this.currentFrame = this.currentAnim.currentFrame;
|
||
|
|
this.sprite.setTexture(PIXI.TextureCache[this.currentFrame.uuid]);
|
||
|
|
|
||
|
|
return this._anims[name];
|
||
|
|
|
||
|
|
},
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Check whether the frames in the given array are valid and exist.
|
||
|
|
*
|
||
|
|
* @method Phaser.AnimationManager#validateFrames
|
||
|
|
* @param {Array} frames - An array of frames to be validated.
|
||
|
|
* @param {boolean} [useNumericIndex=true] - Validate the frames based on their numeric index (true) or string index (false)
|
||
|
|
* @return {boolean} True if all given Frames are valid, otherwise false.
|
||
|
|
*/
|
||
|
|
validateFrames: function (frames, useNumericIndex) {
|
||
|
|
|
||
|
|
if (typeof useNumericIndex == 'undefined') { useNumericIndex = true; }
|
||
|
|
|
||
|
|
for (var i = 0; i < frames.length; i++)
|
||
|
|
{
|
||
|
|
if (useNumericIndex == true)
|
||
|
|
{
|
||
|
|
if (frames[i] > this._frameData.total)
|
||
|
|
{
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
else
|
||
|
|
{
|
||
|
|
if (this._frameData.checkFrameName(frames[i]) == false)
|
||
|
|
{
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return true;
|
||
|
|
|
||
|
|
},
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Play an animation based on the given key. The animation should previously have been added via sprite.animations.add()
|
||
|
|
* If the requested animation is already playing this request will be ignored. If you need to reset an already running animation do so directly on the Animation object itself.
|
||
|
|
*
|
||
|
|
* @method Phaser.AnimationManager#play
|
||
|
|
* @param {string} name - The name of the animation to be played, e.g. "fire", "walk", "jump".
|
||
|
|
* @param {number} [frameRate=null] - The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used.
|
||
|
|
* @param {boolean} [loop=null] - Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.
|
||
|
|
* @return {Phaser.Animation} A reference to playing Animation instance.
|
||
|
|
*/
|
||
|
|
play: function (name, frameRate, loop) {
|
||
|
|
|
||
|
|
if (this._anims[name])
|
||
|
|
{
|
||
|
|
if (this.currentAnim == this._anims[name])
|
||
|
|
{
|
||
|
|
if (this.currentAnim.isPlaying == false)
|
||
|
|
{
|
||
|
|
return this.currentAnim.play(frameRate, loop);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
else
|
||
|
|
{
|
||
|
|
this.currentAnim = this._anims[name];
|
||
|
|
return this.currentAnim.play(frameRate, loop);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
},
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Stop playback of an animation. If a name is given that specific animation is stopped, otherwise the current animation is stopped.
|
||
|
|
* The currentAnim property of the AnimationManager is automatically set to the animation given.
|
||
|
|
*
|
||
|
|
* @method Phaser.AnimationManager#stop
|
||
|
|
* @param {string} [name=null] - The name of the animation to be stopped, e.g. "fire". If none is given the currently running animation is stopped.
|
||
|
|
* @param {boolean} [resetFrame=false] - When the animation is stopped should the currentFrame be set to the first frame of the animation (true) or paused on the last frame displayed (false)
|
||
|
|
*/
|
||
|
|
stop: function (name, resetFrame) {
|
||
|
|
|
||
|
|
if (typeof resetFrame == 'undefined') { resetFrame = false; }
|
||
|
|
|
||
|
|
if (typeof name == 'string')
|
||
|
|
{
|
||
|
|
if (this._anims[name])
|
||
|
|
{
|
||
|
|
this.currentAnim = this._anims[name];
|
||
|
|
this.currentAnim.stop(resetFrame);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
else
|
||
|
|
{
|
||
|
|
if (this.currentAnim)
|
||
|
|
{
|
||
|
|
this.currentAnim.stop(resetFrame);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
},
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The main update function is called by the Sprites update loop. It's responsible for updating animation frames and firing related events.
|
||
|
|
*
|
||
|
|
* @method Phaser.AnimationManager#update
|
||
|
|
* @protected
|
||
|
|
* @return {boolean} True if a new animation frame has been set, otherwise false.
|
||
|
|
*/
|
||
|
|
update: function () {
|
||
|
|
|
||
|
|
if (this.updateIfVisible && this.sprite.visible == false)
|
||
|
|
{
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (this.currentAnim && this.currentAnim.update() == true)
|
||
|
|
{
|
||
|
|
this.currentFrame = this.currentAnim.currentFrame;
|
||
|
|
this.sprite.currentFrame = this.currentFrame;
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
return false;
|
||
|
|
|
||
|
|
},
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Destroys all references this AnimationManager contains. Sets the _anims to a new object and nulls the current animation.
|
||
|
|
*
|
||
|
|
* @method Phaser.AnimationManager#destroy
|
||
|
|
*/
|
||
|
|
destroy: function () {
|
||
|
|
|
||
|
|
this._anims = {};
|
||
|
|
this._frameData = null;
|
||
|
|
this._frameIndex = 0;
|
||
|
|
this.currentAnim = null;
|
||
|
|
this.currentFrame = null;
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name Phaser.AnimationManager#frameData
|
||
|
|
* @property {Phaser.Animation.FrameData} frameData - The current animations FrameData.
|
||
|
|
*/
|
||
|
|
Object.defineProperty(Phaser.AnimationManager.prototype, "frameData", {
|
||
|
|
|
||
|
|
get: function () {
|
||
|
|
return this._frameData;
|
||
|
|
}
|
||
|
|
|
||
|
|
});
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name Phaser.AnimationManager#frameTotal
|
||
|
|
* @property {number} frameTotal - The total number of frames in the currently loaded FrameData, or -1 if no FrameData is loaded.
|
||
|
|
*/
|
||
|
|
Object.defineProperty(Phaser.AnimationManager.prototype, "frameTotal", {
|
||
|
|
|
||
|
|
get: function () {
|
||
|
|
|
||
|
|
if (this._frameData)
|
||
|
|
{
|
||
|
|
return this._frameData.total;
|
||
|
|
}
|
||
|
|
else
|
||
|
|
{
|
||
|
|
return -1;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
});
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name Phaser.AnimationManager#paused
|
||
|
|
* @property {boolean} paused - Gets and sets the paused state of the current animation.
|
||
|
|
*/
|
||
|
|
Object.defineProperty(Phaser.AnimationManager.prototype, "paused", {
|
||
|
|
|
||
|
|
get: function () {
|
||
|
|
|
||
|
|
return this.currentAnim.isPaused;
|
||
|
|
|
||
|
|
},
|
||
|
|
|
||
|
|
set: function (value) {
|
||
|
|
|
||
|
|
this.currentAnim.paused = value;
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
});
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name Phaser.AnimationManager#frame
|
||
|
|
* @property {number} frame - Gets or sets the current frame index and updates the Texture Cache for display.
|
||
|
|
*/
|
||
|
|
Object.defineProperty(Phaser.AnimationManager.prototype, "frame", {
|
||
|
|
|
||
|
|
get: function () {
|
||
|
|
|
||
|
|
if (this.currentFrame)
|
||
|
|
{
|
||
|
|
return this._frameIndex;
|
||
|
|
}
|
||
|
|
|
||
|
|
},
|
||
|
|
|
||
|
|
set: function (value) {
|
||
|
|
|
||
|
|
if (this._frameData && this._frameData.getFrame(value) !== null)
|
||
|
|
{
|
||
|
|
this.currentFrame = this._frameData.getFrame(value);
|
||
|
|
this._frameIndex = value;
|
||
|
|
this.sprite.currentFrame = this.currentFrame;
|
||
|
|
this.sprite.setTexture(PIXI.TextureCache[this.currentFrame.uuid]);
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
});
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name Phaser.AnimationManager#frameName
|
||
|
|
* @property {string} frameName - Gets or sets the current frame name and updates the Texture Cache for display.
|
||
|
|
*/
|
||
|
|
Object.defineProperty(Phaser.AnimationManager.prototype, "frameName", {
|
||
|
|
|
||
|
|
get: function () {
|
||
|
|
|
||
|
|
if (this.currentFrame)
|
||
|
|
{
|
||
|
|
return this.currentFrame.name;
|
||
|
|
}
|
||
|
|
|
||
|
|
},
|
||
|
|
|
||
|
|
set: function (value) {
|
||
|
|
|
||
|
|
if (this._frameData && this._frameData.getFrameByName(value) !== null)
|
||
|
|
{
|
||
|
|
this.currentFrame = this._frameData.getFrameByName(value);
|
||
|
|
this._frameIndex = this.currentFrame.index;
|
||
|
|
this.sprite.currentFrame = this.currentFrame;
|
||
|
|
this.sprite.setTexture(PIXI.TextureCache[this.currentFrame.uuid]);
|
||
|
|
}
|
||
|
|
else
|
||
|
|
{
|
||
|
|
console.warn("Cannot set frameName: " + value);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
});
|
||
|
|
</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>
|
||
|
|
on Wed Oct 02 2013 01:12:17 GMT+0100 (BST) 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>
|