يتمّ عرض هذا الموقع بشكل أفضل في متصفّح حديث مع تمكين JavaScript.

Spine Unity - Help with events after 3.7 update.

stack_overflower

EDIT 1: Problem solved, scroll to the bottom to find my solution to this problem.

Hello everyone!

With our project Exit Limbo we are using the spine runtime with Unity.

Recently, we updated the software and the runtime to the latest 3.7 verison. However, it broke all our system we built upon the

AnimationState

class.

In our game we handle various states in an FSM to handle every player move, and we created a custom PlayAnimation method which listens to the

AnimationState

events of the player's skeleton to make decisions.

Basically, we use:

AnimationState.Start
AnimationState.End
AnimationState.Interrupt

The last version where everything was working fine was the 3.6.

My question for the developers is: could you please tell me if and how you changed when the events get fired? So I can adapt my code, which follows:

using System.Collections;
using UnityEngine;
using System.Collections.Generic;
using Spine;
using Spine.Unity;
using AnimationState = Spine.AnimationState;

public class AnimationController : MonoBehaviour
{
    public delegate void AnimationDelegate();

public event AnimationDelegate AnimationStart;
public event AnimationDelegate AnimationChange;
public event AnimationDelegate AnimationInterrupted;
public event AnimationDelegate AnimationComplete;
public event AnimationDelegate AnimationAfterComplete;

public bool debug = false;

// State variables
private List<TrackEntry> interruptedEntries;
private bool triggeringEvent;
private SkeletonAnimation _skeletonAnimation;
private Coroutine _animationPauser;

private SkeletonAnimation skeletonAnimation
{
    get
    {
        if (_skeletonAnimation == null)
        {
            _skeletonAnimation = GetComponentInChildren<SkeletonAnimation>();
            if (_skeletonAnimation == null) 
            {
                throw new MissingComponentException(name + " does not have a SkeletonAnimation component.");
            }
        }

        return _skeletonAnimation;
    }
}

private AnimationState animationState
{
    get { return skeletonAnimation.state; }
}

private TrackEntry trackEntry
{
    get { return animationState != null ? animationState.GetCurrent(0) : null; }
}

private Skeleton skeleton
{
    get { return skeletonAnimation.skeleton; }
}

#region API

public string currAnimation
{
    get { return trackEntry.Animation.Name; }
}

public float timeScale
{
    get { return animationState.TimeScale; }
    set { animationState.TimeScale = value; }
}

public bool loop { get; private set; }
public float normalizedStartTime { get; private set; }
public float normalizedEndTime { get; private set; }

public float time
{
    get
    {
        // TODO: is positive infinity always the case?
        if (trackEntry == null) {
            return float.PositiveInfinity;
        }

        return trackEntry.TrackTime;
    }
    set
    {
        if (trackEntry != null) {
            trackEntry.TrackTime = value;
        }
    }
}

public float endTime
{
    get { return trackEntry != null ? trackEntry.AnimationEnd : 0f; }
}

public float normalizedTime
{
    get { return trackEntry != null ? (time / endTime) : 1f; }
}

public void setAnimation(string animationName, bool loop = false, float startTime = 0f, float endTime = 1f,
    bool absStartTime = false, bool absEndTime = false)
{
    this.loop = loop;

    skeleton.SetToSetupPose();
    var entry = animationState.SetAnimation(0, animationName, this.loop);
    //var entry = animationState.AddAnimation(0, animationName, this.loop, 0f);

    normalizedStartTime = absStartTime ? startTime / this.endTime : startTime;
    normalizedEndTime = absEndTime ? endTime / this.endTime : endTime;
    time = absStartTime ? startTime : normalizedStartTime * this.endTime;

    /*if (this.triggeringEvent) {
        // Manually trigger start because it gets ignored and not cascaded by spine runtime
        this.onSpineAnimationStart(entry);
    }*/
}

public void AddAnimation(string animationName, bool loop = false, float startTime = 0f, float endTime = 1f,
    bool absStartTime = false, bool absEndTime = false)
{
    this.loop = loop;

    var entry = animationState.AddAnimation(0, animationName, this.loop, 0f);

    normalizedStartTime = absStartTime ? startTime / this.endTime : startTime;
    normalizedEndTime = absEndTime ? endTime / this.endTime : endTime;
    time = absStartTime ? startTime : normalizedStartTime * this.endTime;

    /*if (this.triggeringEvent) {
        // Manually trigger start because it gets ignored and not cascaded by spine runtime
        this.onSpineAnimationStart(entry);
    }*/
}

public void ResetAnimationTimeScale()
{
    timeScale = 1f;
}

public void PauseCurrentAnimation(float delay, float duration)
{
    if (_animationPauser != null)
    {
        StopCoroutine(_animationPauser);
    }
    _animationPauser = StartCoroutine(DoPauseAnimation(delay, duration));
}

private IEnumerator DoPauseAnimation(float delay, float duration)
{
    yield return new WaitForSeconds(delay);
    var oldTimeScale = timeScale;
    timeScale = 0f;
    yield return new WaitForSeconds(duration);
    timeScale = oldTimeScale;

    _animationPauser = null;
}

#endregion

#region MonoBehavior

private void Start()
{
    loop = false;
    timeScale = 1f;
    normalizedStartTime = 0f;
    normalizedEndTime = 1f;

    interruptedEntries = new List<TrackEntry>();
    triggeringEvent = false;

    animationState.ClearTracks();

    animationState.Start += OnSpineAnimationStart;
    animationState.End += OnSpineAnimationEnd;
    animationState.Interrupt += OnSpineAnimationInterrupted;
}

private void Update()
{
    var relTime = time % endTime;
    var deltaStartTime = normalizedStartTime * endTime;
    var deltaEndtime = (1 - normalizedEndTime) * endTime;

    if (trackEntry != null && relTime + deltaEndtime >= endTime) 
    {
        time += deltaEndtime + deltaStartTime;
    }
}

private void OnDestroy()
{
    animationState.Start -= OnSpineAnimationStart;
    animationState.End -= OnSpineAnimationEnd;
    animationState.Interrupt -= OnSpineAnimationInterrupted;
}

#endregion

// Triggered when an animation starts playing
private void OnSpineAnimationStart(TrackEntry entry)
{
    if (debug)
    {
        Debug.Log("Animation " + entry.Animation.Name + " started. " + Time.time);
    }

    if (AnimationStart != null) 
    {
        AnimationStart();
    }
}

// Triggered when the animation is finished
private void OnSpineAnimationEnd(TrackEntry entry)
{
    // If the entry was interrupted, AnimationEnd should not be fired
    if (interruptedEntries.Remove(entry)) 
    {    
        return;
    }

    if (debug) 
    {
        Debug.Log("Animation " + entry.Animation.Name + " ended. " + Time.time);
    }

    triggeringEvent = true;
    if (AnimationComplete != null)
    {
        AnimationComplete();
    }

    if (AnimationAfterComplete != null)
    {
        AnimationAfterComplete();
    }
    triggeringEvent = false;
}

// Triggered when an animation is interrupted
private void OnSpineAnimationInterrupted(TrackEntry entry)
{
    if (debug)
    {
        Debug.Log("Animation " + entry.Animation.Name + " interrupted. " + Time.time);
    }

    interruptedEntries.Add(entry);

    if (AnimationChange != null) 
    {
        AnimationChange();
    }
}
}

Thank you in advance and have a good day!

Harald

Here you can find a list of changes from 3.6 to 3.7 by Pharan:
Spine-Unity 3.6 to 3.7 Upgrade Guide

In which way is your project broken now - Is it still compiling but not working? Or not even compiling any more?

Please note that your spine assets might need to be re-exported from the Spine 3.7 editor, as Nate described at the bottom post of the thread above:

Nate wrote
The compatibility between Spine versions is handled at the Spine project level, not at the JSON data level. This keeps the Spine Runtimes loading of the data as simple as possible.

Note you can use Spine's command line export to export all your projects in one go.
Export - Spine User Guide: Command line

valorware

deleted my comment, turns out some skeletons got corrupted on reimport, I think everythings working fine now

stack_overflower

Harald wrote
Here you can find a list of changes from 3.6 to 3.7 by Pharan:
Spine-Unity 3.6 to 3.7 Upgrade Guide

Thank you, I'll have a look!

Harald wrote
In which way is your project broken now - Is it still compiling but not working? Or not even compiling any more?

Compiling is fine, the problem is that everytime we expect to have our

AnimationComplete

event invoked nothing happens.

It's just like in the runtime update the

AnimationState

events are moved or changed (and so when we subscribe to them the old way we get nothing).

Harald wrote
Please note that your spine assets might need to be re-exported from the Spine 3.7 editor, as Nate described at the bottom post of the thread above:

Nate wrote
The compatibility between Spine versions is handled at the Spine project level, not at the JSON data level. This keeps the Spine Runtimes loading of the data as simple as possible.

Note you can use Spine's command line export to export all your projects in one go.
Export - Spine User Guide: Command line

Yes, we are actually facing this issue because our animator did not remember to have updated the editor to 3.7.x and exported stuff from that version. He reverted the spine editor version to 3.6 but the project files are not back-compatible once saved with 3.7 so now I am forced to use the latest runtime verison (which is always good of course, but I would have waited a little more sice we have a milestone coming up and I did not want to spend some time doing this).

Harald

I quickly tested your script on our dragon example scene (starting and stopping some animations) and it issued the event callbacks just fine. I enabled 'debug' at your component and the log messages appeared.

You can send me a zipped package of a minimal Unity project that shows this problem and send it to contact@esotericsoftware.com, then I can have a look at your data as well.

stack_overflower

Ok, I solved this problem. The events launched by the SkeletonAnimation actually changed and so we had to swap a few things to get it working again properly. I'm gonna do a detailed post next week.

Thanks for helping out, have a nice weekend!

Harald wrote
I quickly tested your script on our dragon example scene (starting and stopping some animations) and it issued the event callbacks just fine. I enabled 'debug' at your component and the log messages appeared.

You can send me a zipped package of a minimal Unity project that shows this problem and send it to contact@esotericsoftware.com, then I can have a look at your data as well.

Ok I'm gonna post something now that I have the source code open in the editor.
The actual problem was that after the update to 3.7 the AnimationEnd event was no longer triggered after non-looped animations.
So we had to check for AnimationComplete if the animation was non-looped, and AnimationEnd if it was looped.

private void onSpineAnimationEnd(TrackEntry entry)
    {
        // If the entry was interrupted, AnimationEnd should not be fired
        if (interruptedEntries.Remove(entry)) 
        {
            return;
        }

    if (debug) 
    {
        Debug.Log("Animation " + entry.Animation.Name + " ended (by end). " + Time.time);
    }

    triggeringEvent = true;
    if (AnimationComplete != null)
    {
        AnimationComplete();
    }

    if (AnimationAfterComplete != null)
    {
        AnimationAfterComplete();
    }
    triggeringEvent = false;
}

private void onSpineAnimationComplete(TrackEntry entry)
    {
        // Change applied after Spine removed the End after non looped animation completion.
        // Listening to Complete instead of End, and differentiating between looped Complete and non looped Complete
        if (entry.Loop)
        {
            return;
        }
        

    if (debug) 
    {
        Debug.Log("Animation " + entry.Animation.Name + " ended (by complete). " + Time.time);
    }

    triggeringEvent = true;
    if (AnimationComplete != null)
    {
        AnimationComplete();
    }

    if (AnimationAfterComplete != null)
    {
        AnimationAfterComplete();
    }
    triggeringEvent = false;
}

Harald

Great! Thanks very much for sharing the actual cause and solution to your problem, might save others a lot of time!