Coding for Spine Events and AnimationState callbacks
Spine.AnimationState为动画提供了C#事件的回调功能。你可以使用这些来处理一些基本的动画播放。
对于新手程序员:回调的意思是,你可以告诉系统,当特定情况发生时可以调用哪些方法。事件在回调中是非常有意义的,你可以在事件系统中订阅/处理你指定的函数/方法。
当事件发生时,调用函数/方法的过程被称为触发 。很多C#文档中叫做"raising"。但是Spine的文档会称它为"firing"。它们其实是一个意思。
回调的结构和语法会根据语言而有不同改变。可以在底部查看C#语法的例子。
Fig 1. 事件图表触发不包括混合/淡入淡出。
Spine.AnimationState可以触发的事件如下:
- Start?当动画开始播放时触发。
- 当调用
SetAnimation 应用成功时触发。 - 我也可以在一个队列动画开始播放时触发。
- End?当动画被清除(或中断)时触发:
- 这适用于,当前动画快要完成时,你可以调用
SetAnimation 去打断它。 - 当你使用
ClearTrack 或ClearTracks 清理Track时也会被触发。 - (3.0) 在混合/淡入淡出期间,在混合完成时End将触发。
- 永远不要在End事件中调用
SetAnimation 。请看下面的警告。
- Interrupt?(3.0) 当新的动画被设置并且当前有一个动画还在播放时触发。
- Complete?当动画完成时触发。
- 当一个非循环的动画播放完毕时触发,无论是否有下一个动画在排队。
- 在循环动画结束循环后,也会触发。
- Event?触发?任何?被监听到的用户自定义事件.
- 这些事件点在Spine的动画中设置。它们是一些紫色的关键帧。一个紫色的icon也可以在层级书中找到。
- 为了区分不同的事件,你需要检查
Spine.Event e 的Name 参数。(或者Data 引用) - 当你想要按照动画节点去播放声音时,这是非常有用的,就像footsteps。他也可以按照Spine动画去使用同步或者信号这种非Spine系统,比如Unity例子系统或者生成单独效果,甚至是游戏逻辑。比如子弹发射的时间里。(如果你真的想这么做的话)
在连接动画播放完成后,另一个排队的动画开始时,这些事件触发的顺序是:Complete ,?End ,?Start 。
警告:?永远不要在订阅End 的方法中调用SetAnimation 。因为当一个动画被中断就会触发End ,然而SetAnimation 会打断所有现有的动画,这会引发无限递归(End->Handle->SetAnimation->End->Handle->SetAnimation),导致Unity没有响应,直到堆栈溢出。
当混合时,标准AnimationState对事件得实现是不同的。
当你有一个mix time设置(或者在你的Skeleton Data Asset中的默认mix ),在一个时间跨度下,下一个动画开始和一个递增的阿尔法值混合,并且之前的动画依然应用在骨架上。
淡入淡出(crossfade)的过程:
- 用户事件在之前的动画不会触发。(这会在以后的版本中改变)
- 对于之前/已经结束的动画
Complete 和End 事件不会触发。
这是简单的MonoBehaviour 去订阅AnimationState 的事件。请看注释来了解它是如何运行的。
C#
using UnityEngine; using System.Collections;
// 将这个脚本挂在你的Spine游戏对象上。 public class MySpineControllerThing : MonoBehaviour {
???//[SpineEvent]属性可以从你的SkeletonData中获取所支持的事件。 ???//并且以下拉框的方式显示在Inspecor中,供你选择。 ???[SpineEvent] public string footstepEventName = "footstep";
???void Start () { ??????var skeletonAnimation = GetComponent<SkeletonAnimation>(); ??????if (skeletonAnimation == null) return; //你需要将脚本挂在拥有SkeletonAnimation组件的对象上
??????// 这就是告诉你如何订阅一个代理方法。这个方法必须有正确的特征。 ??????skeletonAnimation.state.Event += HandleEvent;
??????skeletonAnimation.state.Start += delegate (Spine.AnimationState state, int trackIndex) {
?????????// 你也可以使用一个匿名代理 ?????????Debug.Log(string.Format("track {0} started a new animation.", trackIndex)); ??????};
??????skeletonAnimation.state.End += delegate { ?????????// ... 或者选择忽略它的参数 ?????????Debug.Log("An animation ended!"); ??????}; ???}
???void HandleEvent (Spine.AnimationState state, int trackIndex, Spine.Event e) {
??????// 如果事件名为footstep就播放声音 ??????if (e.Data.Name == footstepEventName) {?????? ?????????Debug.Log("Play a footstep sound!"); ??????} ???} }
由于Spine运行库是源代码可见的,你可以根据你的项目修改它。无论在哪个版本中,你都可以在AnimationState中定义和触发你自己的事件。
spine-unity Runtime Documentation
|