Unity3D 利用代码在动画片断中添加变乱

Unity3D 利用代码在动画片断中添加变乱

在 Unity 中，动画片断（AnimationClip）可以通过添加变乱（AnimationEvent）来在特定时间点触发自界说函数。这种方式非常恰当在动画播放过程中实行一些逻辑利用，比方播放音效、触发粒子结果、大概控制游戏逻辑。
本文将具体先容怎样利用代码在动画片断中添加变乱，并提供完备的示例代码和优化发起。
通例的在动画中添加变乱的方式：

1. 动画变乱

动画变乱（AnimationEvent）是 Unity 中用于在动画播放过程中触发特定函数的一种机制。你可以在动画片断中的恣意时间点添加变乱，并指定变乱触发时要调用的函数名称。变乱可以携带参数，而且可以在动画编辑器中可视化地编辑。
2. 利用代码添加动画变乱

• 获取动画片断：通过 Animator 组件获取对应的动画片断。
  
• 创建动画变乱：创建一个 AnimationEvent 实例，并设置其触发时间和函数名称。
  
• 将变乱添加到动画片断：将创建的变乱添加到动画片断的变乱列表中。
  

2.1 获取动画片断

我们须要从 Animator 组件中获取对应的动画片断。可以通过遍历 AnimatorController 中的 animationClips 来找到指定名称的动画片断。

1. public static AnimationClip GetClipFromAnimator(Animator animator, string stateName)
2. {
3.     if (animator == null)
4.     {
5.         Debug.LogError("Animator is null!");
6.         return null;
7.     }
9.     var animatorController = animator.runtimeAnimatorController;
11.     if (animatorController == null)
12.     {
13.         Debug.LogError("Animator Controller is null!");
14.         return null;
15.     }
17.     foreach (var clip in animatorController.animationClips)
18.     {
19.         if (clip.name == stateName)
20.         {
21.             return clip;
22.         }
23.     }
25.     Debug.Log($"没有找到名为 {stateName} 的动画片段！");
26.     return null;
27. }

复制代码

2.2 创建并添加动画变乱

接下来，我们可以创建一个 AnimationEvent 实例，并将其添加到动画片断中。我们可以选择利用时间（秒）或帧数来指定变乱的触发时间。

1. public static void AddEventToClip(AnimationClip clip, float time, string functionName, bool useFrames = false)
2. {
3.     if (clip == null)
4.     {
5.         Debug.LogError("AnimationClip is null!");
6.         return;
7.     }
9.     float fps = clip.frameRate > 0 ? clip.frameRate : 60f; // 默认 60fps
11.     if (useFrames)
12.     {
13.         time = time / fps; // 将帧数转换为秒数
14.     }
16.     if (time < 0f)
17.     {
18.         time = 0f;
19.     }
21.     if (time > clip.length)
22.     {
23.         time = clip.length;
24.     }
26.     AnimationEvent animationEvent = new AnimationEvent
27.     {
28.         time = time,
29.         functionName = functionName
30.     };
32.     clip.AddEvent(animationEvent);
33. }

复制代码

2.3 清空或删除动画变乱

偶然候我们须要清空或删除动画片断中的特定变乱。可以通过以下方法实现：

1. public static void ClearAllEventsFromClip(AnimationClip clip)
2. {
3.     if (clip == null)
4.     {
5.         Debug.LogError("ClearAllEventsFromClip: AnimationClip is null!");
6.         return;
7.     }
9.     clip.events = new AnimationEvent[0];
10.     Debug.Log($"ClearAllEventsFromClip: All events cleared from clip '{clip.name}'.");
11. }
13. public static void RemoveEventFromClip(AnimationClip clip, string functionName)
14. {
15.     if (clip == null)
16.     {
17.         Debug.LogError("RemoveEventFromClip: AnimationClip is null!");
18.         return;
19.     }
21.     if (string.IsNullOrEmpty(functionName))
22.     {
23.         Debug.LogError("RemoveEventFromClip: Function name is null or empty!");
24.         return;
25.     }
27.     AnimationEvent[] events = clip.events;
28.     var filteredEvents = new System.Collections.Generic.List<AnimationEvent>();
29.     foreach (var evt in events)
30.     {
31.         if (evt.functionName != functionName)
32.         {
33.             filteredEvents.Add(evt);
34.         }
35.     }
37.     clip.events = filteredEvents.ToArray();
38. }

复制代码

3. 示例代码

代码

利用的示例，展示了如安在动画片断中添加变乱，并在变乱触发时实行自界说逻辑。
将这个脚本挂在在带有Animator 组件的物体上然后就可以在动态添加变乱了。

1. using System.Collections;
2. using System.Collections.Generic;
3. using UnityEngine;
5. public class ObjAni : MonoBehaviour
6. {
7.     private Animator animator;
9.     private void Start()
10.     {
11.         animator = gameObject.GetComponent<Animator>();
13.         var clip = AnimationHelper.GetClipFromAnimator(animator, "DoRotate");
15.         // 在第30帧添加事件
16.         AnimationHelper.AddEventToClip(clip, 30, nameof(AnimatorEventAdd), true);
18.         animator.SetBool("work", true);
19.         Invoke(nameof(RemoveEventClip), 3.0f);
20.     }
22.     private void AnimatorEventAdd()
23.     {
24.         animator.SetBool("work", false);
25.         Debug.Log("AnimatorEventAdd");
26.     }
28.     void RemoveEventClip()
29.     {
30.         var clip = AnimationHelper.GetClipFromAnimator(animator, "DoRotate");
31.         AnimationHelper.RemoveEventFromClip(clip, nameof(AnimatorEventAdd));
32.         animator.SetBool("work", true);
33.     }
34. }

复制代码

• Start 方法：在游戏开始时，获取 Animator 组件和对应的动画片断 DoRotate，并在第30帧添加一个变乱，变乱触发时调用 AnimatorEventAdd 方法。
  
• AnimatorEventAdd 方法：当变乱触发时，克制动画播放，并输出日记信息。
  
• RemoveEventClip 方法：在3秒后移除动画片断中的变乱，并重新开始动画播放。
  

Unity3D动画设置

• 创建一个空的状态
  
• 添加一个切换条件，范例为bool范例，默认是false
  
• 添加自己要实行的动画，并修改名称为DoRotate
  
• 添加切换条件：new State -true->  DoRotate , DoRotate -false->new State
  
• 将这个动画状态机给到上面的Animator  组件
  

4. 其他发起

• 性能优化：频仍地添加和删除变乱大概会影响性能，发起在游戏初始化时一次性添加全部变乱，并在须要时举行更新。
  
• 变乱参数：AnimationEvent 可以携带参数（如 int、float、string 等），可以根据须要转达更多信息给变乱处置处罚函数。
  
• 没有动画：确认导入的模子上有动画，勾选inport Animation
  
  
  
  

5.完备的添加变乱代码

1. using UnityEngine;
3. public static class AnimationHelper
4. {
5.     /// <summary>
6.     /// 获取Animator状态对应的动画片段
7.     /// </summary>
8.     /// <param name="animator">Animator组件</param>
9.     /// <param name="stateName">状态名（动画片段名）</param>
10.     /// <returns>对应状态的AnimationClip</returns>
11.     public static AnimationClip GetClipFromAnimator(Animator animator, string stateName)
12.     {
13.         if (animator == null)
14.         {
15.             Debug.LogError("Animator is null!");
16.             return null;
17.         }
19.         // 获取 Animator 的 Controller
20.         var animatorController = animator.runtimeAnimatorController;
22.         if (animatorController == null)
23.         {
24.             Debug.LogError("Animator Controller is null!");
25.             return null;
26.         }
28.         // 获取所有动画片段
29.         foreach (var clip in animatorController.animationClips)
30.         {
31.             if (clip.name == stateName)
32.             {
33.                 return clip;
34.             }
35.         }
37.         Debug.Log($"没有找到名为 {stateName} 的动画片段！");
38.         return null;
39.     }
41.     /// <summary>
42.     /// 向指定的动画剪辑添加事件
43.     /// </summary>
44.     /// <param name="clip">要添加事件的动画剪辑</param>
45.     /// <param name="time">事件触发的时间点（单位：秒）</param>
46.     /// <param name="functionName">事件触发时调用的函数名称</param>
47.     /// <param name="useFrames">是否使用帧数来设置事件时间（如果为 true，则 `time` 参数会被解释为帧数）</param>
48.     public static void AddEventToClip(AnimationClip clip, float time, string functionName, bool useFrames = false)
49.     {
50.         if (clip == null)
51.         {
52.             Debug.LogError("AnimationClip is null!");
53.             return;
54.         }
56.         // 获取动画的帧率
57.         float fps = clip.frameRate > 0 ? clip.frameRate : 60f; // 默认 60fps
59.         if (useFrames)
60.         {
61.             // 如果使用帧数，将帧数转换为时间（秒）
62.             time = time / fps; // 将帧数转换为秒数
63.         }
65.         // 如果时间小于0，则将其修正为0（动画开始时间）
66.         if (time < 0f)
67.         {
68.             time = 0f;
69.         }
71.         // 如果时间超过动画长度，则将其修正为动画的结束时间
72.         if (time > clip.length)
73.         {
74.             time = clip.length;
75.         }
77.         // 创建一个新的动画事件实例
78.         AnimationEvent animationEvent = new AnimationEvent
79.         {
80.             // 设置事件的触发时间
81.             time = time,
83.             // 设置事件触发时调用的函数名称
84.             functionName = functionName
85.         };
87.         // 将事件添加到动画剪辑中
88.         clip.AddEvent(animationEvent);
89.     }
91.     /// <summary>
92.     /// 清空动画剪辑中的所有事件
93.     /// </summary>
94.     /// <param name="clip">目标动画剪辑</param>
95.     public static void ClearAllEventsFromClip(AnimationClip clip)
96.     {
97.         if (clip == null)
98.         {
99.             Debug.LogError("ClearAllEventsFromClip: AnimationClip is null!");
100.             return;
101.         }
103.         clip.events = new AnimationEvent[0];
104.         Debug.Log($"ClearAllEventsFromClip: All events cleared from clip '{clip.name}'.");
105.     }
107.     /// <summary>
108.     /// 删除动画剪辑中指定函数名称的事件
109.     /// </summary>
110.     /// <param name="clip">目标动画剪辑</param>
111.     /// <param name="functionName">要删除的事件函数名称</param>
112.     public static void RemoveEventFromClip(AnimationClip clip, string functionName)
113.     {
114.         if (clip == null)
115.         {
116.             Debug.LogError("RemoveEventFromClip: AnimationClip is null!");
117.             return;
118.         }
120.         if (string.IsNullOrEmpty(functionName))
121.         {
122.             Debug.LogError("RemoveEventFromClip: Function name is null or empty!");
123.             return;
124.         }
126.         // 获取当前所有事件
127.         AnimationEvent[] events = clip.events;
129.         // 过滤掉指定的事件
130.         var filteredEvents = new System.Collections.Generic.List<AnimationEvent>();
131.         foreach (var evt in events)
132.         {
133.             if (evt.functionName != functionName)
134.             {
135.                 filteredEvents.Add(evt);
136.             }
137.         }
139.         // 将过滤后的事件重新赋值给动画片段
140.         clip.events = filteredEvents.ToArray();
141.     }
143. }

复制代码