Unity3D 使用代码在动画片段中添加事件

Unity3D 使用代码在动画片段中添加事件

在 Unity 中，动画片段（AnimationClip）可以通过添加事件（AnimationEvent）来在特定时间点触发自定义函数。这种方式非常适合在动画播放过程中执行一些逻辑操作，例如播放音效、触发粒子效果、或者控制游戏逻辑。

本文将详细介绍如何使用代码在动画片段中添加事件，并提供完整的示例代码和优化建议。
常规的在动画中添加事件的方式：

1. 动画事件

动画事件（AnimationEvent）是 Unity 中用于在动画播放过程中触发特定函数的一种机制。你可以在动画片段中的任意时间点添加事件，并指定事件触发时要调用的函数名称。事件可以携带参数，并且可以在动画编辑器中可视化地编辑。

2. 使用代码添加动画事件

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

2.1 获取动画片段

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

public static AnimationClip GetClipFromAnimator(Animator animator, string stateName)
{
    if (animator == null)
    {
        Debug.LogError("Animator is null!");
        return null;
    }

    var animatorController = animator.runtimeAnimatorController;

    if (animatorController == null)
    {
        Debug.LogError("Animator Controller is null!");
        return null;
    }

    foreach (var clip in animatorController.animationClips)
    {
        if (clip.name == stateName)
        {
            return clip;
        }
    }

    Debug.Log($"没有找到名为 {stateName} 的动画片段！");
    return null;
}

2.2 创建并添加动画事件

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

public static void AddEventToClip(AnimationClip clip, float time, string functionName, bool useFrames = false)
{
    if (clip == null)
    {
        Debug.LogError("AnimationClip is null!");
        return;
    }

    float fps = clip.frameRate > 0 ? clip.frameRate : 60f; // 默认 60fps

    if (useFrames)
    {
        time = time / fps; // 将帧数转换为秒数
    }

    if (time < 0f)
    {
        time = 0f;
    }

    if (time > clip.length)
    {
        time = clip.length;
    }

    AnimationEvent animationEvent = new AnimationEvent
    {
        time = time,
        functionName = functionName
    };

    clip.AddEvent(animationEvent);
}

2.3 清空或删除动画事件

有时候我们需要清空或删除动画片段中的特定事件。可以通过以下方法实现：

public static void ClearAllEventsFromClip(AnimationClip clip)
{
    if (clip == null)
    {
        Debug.LogError("ClearAllEventsFromClip: AnimationClip is null!");
        return;
    }

    clip.events = new AnimationEvent[0];
    Debug.Log($"ClearAllEventsFromClip: All events cleared from clip '{clip.name}'.");
}

public static void RemoveEventFromClip(AnimationClip clip, string functionName)
{
    if (clip == null)
    {
        Debug.LogError("RemoveEventFromClip: AnimationClip is null!");
        return;
    }

    if (string.IsNullOrEmpty(functionName))
    {
        Debug.LogError("RemoveEventFromClip: Function name is null or empty!");
        return;
    }

    AnimationEvent[] events = clip.events;
    var filteredEvents = new System.Collections.Generic.List<AnimationEvent>();
    foreach (var evt in events)
    {
        if (evt.functionName != functionName)
        {
            filteredEvents.Add(evt);
        }
    }

    clip.events = filteredEvents.ToArray();
}

3. 示例代码

代码

使用的示例，展示了如何在动画片段中添加事件，并在事件触发时执行自定义逻辑。
将这个脚本挂在在带有Animator 组件的物体上然后就可以在动态添加事件了。

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class ObjAni : MonoBehaviour
{
    private Animator animator;

    private void Start()
    {
        animator = gameObject.GetComponent<Animator>();

        var clip = AnimationHelper.GetClipFromAnimator(animator, "DoRotate");

        // 在第30帧添加事件
        AnimationHelper.AddEventToClip(clip, 30, nameof(AnimatorEventAdd), true);

        animator.SetBool("work", true);
        Invoke(nameof(RemoveEventClip), 3.0f);
    }

    private void AnimatorEventAdd()
    {
        animator.SetBool("work", false);
        Debug.Log("AnimatorEventAdd");
    }

    void RemoveEventClip()
    {
        var clip = AnimationHelper.GetClipFromAnimator(animator, "DoRotate");
        AnimationHelper.RemoveEventFromClip(clip, nameof(AnimatorEventAdd));
        animator.SetBool("work", true);
    }
}

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

Unity3D动画设置

1. 创建一个空的状态
2. 添加一个切换条件，类型为bool类型，默认是false
3. 添加自己要执行的动画，并修改名称为DoRotate
4. 添加切换条件：new State -true-> DoRotate , DoRotate -false->new State
5. 将这个动画状态机给到上面的Animator 组件

4. 其他建议

• 性能优化：频繁地添加和删除事件可能会影响性能，建议在游戏初始化时一次性添加所有事件，并在必要时进行更新。
• 事件参数：AnimationEvent 可以携带参数（如 int、float、string 等），可以根据需要传递更多信息给事件处理函数。
• 没有动画：确认导入的模型上有动画，勾选inport Animation
  

5.完整的添加事件代码

using UnityEngine;

public static class AnimationHelper
{
    /// <summary>
    /// 获取Animator状态对应的动画片段
    /// </summary>
    /// <param name="animator">Animator组件</param>
    /// <param name="stateName">状态名（动画片段名）</param>
    /// <returns>对应状态的AnimationClip</returns>
    public static AnimationClip GetClipFromAnimator(Animator animator, string stateName)
    {
        if (animator == null)
        {
            Debug.LogError("Animator is null!");
            return null;
        }

        // 获取 Animator 的 Controller
        var animatorController = animator.runtimeAnimatorController;

        if (animatorController == null)
        {
            Debug.LogError("Animator Controller is null!");
            return null;
        }

        // 获取所有动画片段
        foreach (var clip in animatorController.animationClips)
        {
            if (clip.name == stateName)
            {
                return clip;
            }
        }

        Debug.Log($"没有找到名为 {stateName} 的动画片段！");
        return null;
    }

    /// <summary>
    /// 向指定的动画剪辑添加事件
    /// </summary>
    /// <param name="clip">要添加事件的动画剪辑</param>
    /// <param name="time">事件触发的时间点（单位：秒）</param>
    /// <param name="functionName">事件触发时调用的函数名称</param>
    /// <param name="useFrames">是否使用帧数来设置事件时间（如果为 true，则 `time` 参数会被解释为帧数）</param>
    public static void AddEventToClip(AnimationClip clip, float time, string functionName, bool useFrames = false)
    {
        if (clip == null)
        {
            Debug.LogError("AnimationClip is null!");
            return;
        }

        // 获取动画的帧率
        float fps = clip.frameRate > 0 ? clip.frameRate : 60f; // 默认 60fps

        if (useFrames)
        {
            // 如果使用帧数，将帧数转换为时间（秒）
            time = time / fps; // 将帧数转换为秒数
        }

        // 如果时间小于0，则将其修正为0（动画开始时间）
        if (time < 0f)
        {
            time = 0f;
        }

        // 如果时间超过动画长度，则将其修正为动画的结束时间
        if (time > clip.length)
        {
            time = clip.length;
        }

        // 创建一个新的动画事件实例
        AnimationEvent animationEvent = new AnimationEvent
        {
            // 设置事件的触发时间
            time = time,

            // 设置事件触发时调用的函数名称
            functionName = functionName
        };

        // 将事件添加到动画剪辑中
        clip.AddEvent(animationEvent);
    }

    /// <summary>
    /// 清空动画剪辑中的所有事件
    /// </summary>
    /// <param name="clip">目标动画剪辑</param>
    public static void ClearAllEventsFromClip(AnimationClip clip)
    {
        if (clip == null)
        {
            Debug.LogError("ClearAllEventsFromClip: AnimationClip is null!");
            return;
        }

        clip.events = new AnimationEvent[0];
        Debug.Log($"ClearAllEventsFromClip: All events cleared from clip '{clip.name}'.");
    }

    /// <summary>
    /// 删除动画剪辑中指定函数名称的事件
    /// </summary>
    /// <param name="clip">目标动画剪辑</param>
    /// <param name="functionName">要删除的事件函数名称</param>
    public static void RemoveEventFromClip(AnimationClip clip, string functionName)
    {
        if (clip == null)
        {
            Debug.LogError("RemoveEventFromClip: AnimationClip is null!");
            return;
        }

        if (string.IsNullOrEmpty(functionName))
        {
            Debug.LogError("RemoveEventFromClip: Function name is null or empty!");
            return;
        }

        // 获取当前所有事件
        AnimationEvent[] events = clip.events;

        // 过滤掉指定的事件
        var filteredEvents = new System.Collections.Generic.List<AnimationEvent>();
        foreach (var evt in events)
        {
            if (evt.functionName != functionName)
            {
                filteredEvents.Add(evt);
            }
        }

        // 将过滤后的事件重新赋值给动画片段
        clip.events = filteredEvents.ToArray();
    }

}