Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-09-20 14:31:55 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added in support for blending animations with addMix, getMix and removeMix.

Browse source
This commit is contained in:
Richard Davey 2020-09-07 15:33:57 +01:00
parent 438fe3c0d1
commit 98dc69ed23
2 changed files with 168 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

152
src/animations/AnimationManager.js
View file

@ -86,6 +86,17 @@ var AnimationManager = new Class({
*/
this.anims = new CustomMap();
/**
* A list of animation mix times.
*
* See the {@link #setMix} method for more details.
*
* @name Phaser.Animations.AnimationManager#mixes
* @type {Phaser.Structs.Map.<string>}
* @since 3.50.0
*/
this.mixes = new CustomMap();
/**
* Whether the Animation Manager is paused along with all of its Animations.
*
@ -122,6 +133,144 @@ var AnimationManager = new Class({
this.game.events.once(GameEvents.DESTROY, this.destroy, this);
},
/**
* Adds a mix between two animations.
*
* Mixing allows you to specify a unique delay between a pairing of animations.
*
* When playing Animation A on a Game Object, if you then play Animation B, and a
* mix exists, it will wait for the specified delay to be over before playing Animation B.
*
* This allows you to customise smoothing between different types of animation, such
* as blending between an idle and a walk state, or a running and a firing state.
*
* Note that mixing is only applied if you use the `Sprite.play` method. If you opt to use
* `playAfterRepeat` or `playAfterDelay` instead, those will take pririty and the mix
* delay will not be used.
*
* To update an existing mix, just call this method with the new delay.
*
* To remove a mix pairing, see the `removeMix` method.
*
* @method Phaser.Animations.AnimationManager#addMix
* @since 3.50.0
*
* @param {(string|Phaser.Animations.Animation)} animA - The string-based key, or instance of, Animation A.
* @param {(string|Phaser.Animations.Animation)} animB - The string-based key, or instance of, Animation B.
* @param {number} delay - The delay, in milliseconds, to wait when transitioning from Animation A to B.
*
* @return {this} This Animation Manager.
*/
addMix: function (animA, animB, delay)
{
var anims = this.anims;
var mixes = this.mixes;
var keyA = (typeof(animA) === 'string') ? animA : animA.key;
var keyB = (typeof(animB) === 'string') ? animB : animB.key;
if (anims.has(keyA) && anims.has(keyB))
{
var mixObj = mixes.get(keyA);
if (!mixObj)
{
mixObj = {};
}
mixObj[keyB] = delay;
mixes.set(keyA, mixObj);
}
return this;
},
/**
* Removes a mix between two animations.
*
* Mixing allows you to specify a unique delay between a pairing of animations.
*
* Calling this method lets you remove those pairings. You can either remove
* it between `animA` and `animB`, or if you do not provide the `animB` parameter,
* it will remove all `animA` mixes.
*
* If you wish to update an existing mix instead, call the `addMix` method with the
* new delay.
*
* @method Phaser.Animations.AnimationManager#removeMix
* @since 3.50.0
*
* @param {(string|Phaser.Animations.Animation)} animA - The string-based key, or instance of, Animation A.
* @param {(string|Phaser.Animations.Animation)} [animB] - The string-based key, or instance of, Animation B. If not given, all mixes for Animation A will be removed.
*
* @return {this} This Animation Manager.
*/
removeMix: function (animA, animB)
{
var mixes = this.mixes;
var keyA = (typeof(animA) === 'string') ? animA : animA.key;
var mixObj = mixes.get(keyA);
if (mixObj)
{
if (animB)
{
var keyB = (typeof(animB) === 'string') ? animB : animB.key;
if (mixObj.hasOwnProperty(keyB))
{
// Remove just this pairing
delete mixObj[keyB];
}
}
else if (!animB)
{
// Remove everything for animA
mixes.delete(keyA);
}
}
return this;
},
/**
* Returns the mix delay between two animations.
*
* If no mix has been set-up, this method will return zero.
*
* If you wish to create, or update, a new mix, call the `addMix` method.
* If you wish to remove a mix, call the `removeMix` method.
*
* @method Phaser.Animations.AnimationManager#getMix
* @since 3.50.0
*
* @param {(string|Phaser.Animations.Animation)} animA - The string-based key, or instance of, Animation A.
* @param {(string|Phaser.Animations.Animation)} animB - The string-based key, or instance of, Animation B.
*
* @return {number} The mix duration, or zero if no mix exists.
*/
getMix: function (animA, animB)
{
var mixes = this.mixes;
var keyA = (typeof(animA) === 'string') ? animA : animA.key;
var keyB = (typeof(animB) === 'string') ? animB : animB.key;
var mixObj = mixes.get(keyA);
if (mixObj && mixObj.hasOwnProperty(keyB))
{
return mixObj[keyB];
}
else
{
return 0;
}
},
/**
* Adds an existing Animation to the Animation Manager.
*
@ -776,6 +925,8 @@ var AnimationManager = new Class({
this.emit(Events.REMOVE_ANIMATION, key, anim);
this.anims.delete(key);
this.removeMix(key);
}
return anim;
@ -845,6 +996,7 @@ var AnimationManager = new Class({
destroy: function ()
{
this.anims.clear();
this.mixes.clear();
this.textureManager = null;

18
src/gameobjects/components/AnimationState.js
View file

@ -816,12 +816,26 @@ var AnimationState = new Class({
{
if (ignoreIfPlaying === undefined) { ignoreIfPlaying = false; }
var currentAnim = this.currentAnim;
var parent = this.parent;
// Must be either an Animation instance, or a PlayAnimationConfig object
var animKey = (typeof key === 'string') ? key : key.key;
if (ignoreIfPlaying && this.isPlaying && this.currentAnim.key === animKey)
if (ignoreIfPlaying && this.isPlaying && currentAnim.key === animKey)
{
return this.parent;
return parent;
}
// Are we mixing?
if (currentAnim && this.isPlaying)
{
var mix = this.animationManager.getMix(currentAnim.key, key);
if (mix > 0)
{
return this.playAfterDelay(key, mix);
}
}
this.forward = true;