游戏开发技术--Timeline封装（Unity）

jackboy

一、设计意图

使用Unity中的Timeline功能进行技能效果或者过场剧情开发的都知道，对于Timeline功能的扩展，凡是要扩展以下几个类：

• TrackAsset：轨道资源，用来创建片段和Playable混合器，提供序列化数据与Binding。
  
• PlayableAsset：片段资源，用来创建Playable以及提供序列化数据。
  
• PlayableBehaviour：逻辑行为，用来实现Playable具体的业务逻辑。
  

然而，在扩展过程中，会发现一些不便当的情况，最明显的就是PlayableBehaviour的回调函数，对于不熟悉Playable的开发者来说，需要必然的理解成本。为此，我对Timeline的布局进行了进一步的封装。
二、设计思路

对于TrackAsset和PlayableAsset来说，设计上但愿它们只是提供具体序列化数据，而屏蔽掉对于Playable的创建过程。而对于PlayableBehaviour来说，但愿它仅用于实现业务逻辑，同时提炼回调函数使其友好于普通的Unity游戏开发者，而不需要过多了解Playable的机制。
三、实现方式

1、PlayableBehaviour封装

先来对PlayableBehaviour进行封装，定义BaseBehaviour类，对原有的回调函数使用修饰符sealed，定义通用的回调函数（OnCreate，OnDestroy，OnStart，OnUpdate，OnStop），同时提供一些获取数据的接口（GetData，Time，Duration，Percent）。
全部代码如下：

1. namespace TimelineKit
2. {
3.     using UnityEngine.Playables;
4.    
5.     public abstract class BaseBehaviour : PlayableBehaviour
6.     {
7.         private bool _started;
8.         private bool _played;
9.         private object _playerData;
10.         private Playable _playable = Playable.Null;
11.         private PlayableAsset _asset;
12.         
13.         public static Playable CreatePlayable<T>(PlayableGraph graph, PlayableAsset data) where T : BaseBehaviour, new()
14.         {
15.             var playable = ScriptPlayable<T>.Create(graph);
16.             T behaviour = playable.GetBehaviour();
17.             behaviour._asset = data;
18.             behaviour._playable = playable;
19.             return playable;
20.         }
22.         #region protected  
24.         protected T GetData<T>() where T : PlayableAsset => _asset as T;
25.         protected float Time => (float)_playable.GetTime();
26.         protected float Duration => (float) _playable.GetDuration();
27.         protected float Percent => (float) (_playable.GetDuration().Equals(0) ? 0 : _playable.GetTime() / _playable.GetDuration());
29.         #endregion protected
31.         #region base
32.         protected virtual void OnCreate() { }
33.         protected virtual void OnDestroy() { }
34.         protected virtual void OnStart(object binding) { }
35.         protected virtual void OnUpdate(object binding, float deltaTime) { }
36.         protected virtual void OnStop(object binding) { }
37.         #endregion base
39.         #region sealed
40.         public sealed override void OnBehaviourPlay(Playable playable, FrameData info)
41.         {
42.             if (_played)
43.                 return;
44.             _started = false;
45.             _played = true;
46.         }
48.         public sealed override void OnBehaviourPause(Playable playable, FrameData info)
49.         {
50.             if (!_played)
51.                 return;
52.             OnStop(_playerData);
53.             _played = false;
54.         }
56.         public sealed override void OnPlayableCreate(Playable playable)
57.         {
58.             OnCreate();
59.         }
61.         public sealed override void OnPlayableDestroy(Playable playable)
62.         {
63.             OnDestroy();
64.         }
66.         public sealed override void OnGraphStart(Playable playable) { }
68.         public sealed override void OnGraphStop(Playable playable) { }
70.         public sealed override void PrepareData(Playable playable, FrameData info) { }
72.         public sealed override void PrepareFrame(Playable playable, FrameData info) { }
74.         public sealed override void ProcessFrame(Playable playable, FrameData info, object playerData)
75.         {
76.             if (!_played)
77.                 return;
78.             if (!_started)
79.             {
80.                 _started = true;
81.                 _playerData = playerData;
82.                 OnStart(_playerData);
83.             }
84.             OnUpdate(_playerData, info.deltaTime);
85.         }
86.         #endregion sealed
87.     }
88. }

复制代码

2、PlayableAsset封装

为了和对应的PlayableBehaviour进行绑定，这里使用泛型对PlayableAsset进行封装，定义类型BaseClipAsset<T>，并实现了CreatePlayable的方式。因此担任此类型的子类只需要提供序列化数据即可。
全部代码如下：

1. namespace TimelineKit
2. {
3.     using UnityEngine;
4.     using UnityEngine.Playables;
5.    
6.     public class BaseClipAsset<T> : PlayableAsset where T : BaseBehaviour, new()
7.     {
8.         public sealed override Playable CreatePlayable(PlayableGraph graph, GameObject owner)
9.         {
10.             return BaseBehaviour.CreatePlayable<T>(graph, this);
11.         }
12.     }
13. }

复制代码

3、TrackAsset封装

TrackAsset的封装和PlayableAsset的封装思路类似，也是对Create方式进行重载权限设置，定义了BaceTrackAsset和BaceTrackAsset<T>两种类型，此中使用泛型的类型可以用来创建Mixer混合器。
全部代码如下：

1. namespace TimelineKit
2. {
3.     using UnityEngine;
4.     using UnityEngine.Playables;
5.     using UnityEngine.Timeline;
7.     public class BaseTrackAsset : TrackAsset
8.     {
9.         protected sealed override Playable CreatePlayable(PlayableGraph graph, GameObject gameObject, TimelineClip clip)
10.         {
11.             return base.CreatePlayable(graph, gameObject, clip);
12.         }
14.         public sealed override Playable CreateTrackMixer(PlayableGraph graph, GameObject go, int inputCount)
15.         {
16.             return base.CreateTrackMixer(graph, go, inputCount);
17.         }
18.     }
20.     public class BaseTrackAsset<T> : TrackAsset where T : BaseBehaviour, new()
21.     {
22.         protected sealed override Playable CreatePlayable(PlayableGraph graph, GameObject gameObject, TimelineClip clip)
23.         {
24.             return base.CreatePlayable(graph, gameObject, clip);
25.         }
27.         public sealed override Playable CreateTrackMixer(PlayableGraph graph, GameObject go, int inputCount)
28.         {
29.             var mixer = BaseBehaviour.CreatePlayable<T>(graph, this);
30.             mixer.SetInputCount(inputCount);
31.             return mixer;
32.         }
33.     }
34. }

复制代码

四、使用案例

使用上面包装好的Timeline组件，可以很容易的对Timeline功能进行扩展，例如我们要实现一个Timeline控制光强的功能。
TrackAsset：

1. namespace TimelineKit
2. {
3.     using UnityEngine;
4.     using UnityEngine.Timeline;
5.    
6.     [TrackColor(1f,1f,0f)]
7.     [TrackClipType(typeof(LightClipAsset))]
8.     [TrackBindingType(typeof(Light))]
9.     public class LightTrackAsset : BaseTrackAsset { }
10. }

复制代码

BaseClipAsset实现：

1. namespace TimelineKit
2. {
3.     public class LightClipAsset : BaseClipAsset<LightBehaviour>
4.     {
5.         public float StartIntensity;
6.         public float EndIntensity;
7.     }
8. }

复制代码

BaseBehaviour实现:

1. namespace TimelineKit
2. {
3.     using UnityEngine;
5.     public class LightBehaviour : BaseBehaviour
6.     {
7.         protected override void OnUpdate(object binding, float deltaTime)
8.         {
9.             if (binding is Light light)
10.             {
11.                 var data = GetData<LightClipAsset>();
12.                 light.intensity = Mathf.Lerp(data.StartIntensity,data.EndIntensity, Percent);
13.             }
14.         }
15.     }
16. }

复制代码

做了个简易的场景，最终效果如下：


https://www.zhihu.com/video/1630530910461411328