Unity MissingUnityEvents 项目教程

Unity MissingUnityEvents 项目教程

Unity.MissingUnityEventsEditor extension to generate events that are executed before property set, eg. Transform-position, Transform-rotation, Transform-parent which allows to write more event driven code or debug property changes that are not simple to track down. Easily customisable to allow adding events to different property setters / types.项目地址:https://gitcode.com/gh_mirrors/un/Unity.MissingUnityEvents

1. 项目介绍

Unity MissingUnityEvents 是一个 Unity 编辑器扩展，旨在为 Unity 中的某些属性（如 Transform 的位置、旋转、父级等）生成事件。这些事件可以在属性设置之前执行，从而允许开发者编写更多基于事件驱动的代码，或者调试那些难以跟踪的属性变化。

该项目的主要目的是简化 Unity 中事件驱动的编程，特别是对于那些希望在 Unity 核心类中添加自定义事件的开发者。通过这个工具，开发者可以轻松地为 Unity 中的各种属性添加事件，而无需手动编写大量的抽象代码。

2. 项目快速启动

2.1 安装

1. 克隆项目到本地：

   git clone https://github.com/handzlikchris/Unity.MissingUnityEvents.git
   

2. 将项目导入到你的 Unity 项目中：

   • 打开 Unity 编辑器。
   • 在项目窗口中，右键点击 Assets 文件夹，选择 Import Package > Custom Package。
   • 选择刚刚克隆的项目中的 MissingUnityEvents 文件夹。

2.2 使用

1. 在 Unity 编辑器中，点击 Missing Unity Events 菜单栏。
2. 选择 Run，然后点击 Pick weaver executable。
3. 选择 EventILWeaver Console.exe 文件，该文件通常位于 Assets/Plugins/MissingUnityEvents/Editor/Plugins~/ 目录下。
4. 在 PropertyName 下拉菜单中选择你想要添加事件的属性。
5. 点击 Weave Events to DLL，生成辅助类。

2.3 示例代码

以下是一个简单的示例，展示如何在 Transform 的位置属性上添加事件：

using UnityEngine;

public class TransformEventExample : MonoBehaviour
{
    void Start()
    {
        Transform transform = GetComponent<Transform>();
        transform.SetPositionExecuting += OnPositionExecuting;
    }

    void OnPositionExecuting(object sender, TransformEventArgs e)
    {
        Debug.Log("Transform position is about to change to: " + e.NewValue);
    }
}

3. 应用案例和最佳实践

3.1 应用案例

• 调试属性变化：在开发过程中，有时需要调试某些属性的变化，但这些属性并没有提供事件。使用 MissingUnityEvents，你可以轻松地为这些属性添加事件，从而在属性变化时触发调试信息。

• 事件驱动编程：在某些情况下，你可能希望在属性变化之前执行某些操作。例如，在 Transform 的位置变化之前，你可能希望检查某些条件或执行特定的逻辑。

3.2 最佳实践

• 抽象使用：建议将生成的辅助类抽象使用，这样即使你使用的是干净的 DLL，也不需要更改现有的代码。相反，它只会记录警告（如果指定了）。

• 自定义事件：根据项目需求，自定义事件的目标属性，避免不必要的性能开销。

4. 典型生态项目

• Unity HDRP：MissingUnityEvents 可以与 Unity 的高清渲染管线（HDRP）结合使用，特别是在需要调试或自定义某些渲染属性时。

• Unity Burst Compiler：虽然 MissingUnityEvents 可能会与 Burst 编译器产生冲突（如引用内容中提到的错误），但通过更新 Unity 版本或调整项目设置，可以解决这些问题。

通过以上步骤和示例，你可以快速上手并充分利用 Unity MissingUnityEvents 项目，提升 Unity 项目的开发效率和代码质量。

Unity.MissingUnityEventsEditor extension to generate events that are executed before property set, eg. Transform-position, Transform-rotation, Transform-parent which allows to write more event driven code or debug property changes that are not simple to track down. Easily customisable to allow adding events to different property setters / types.项目地址:https://gitcode.com/gh_mirrors/un/Unity.MissingUnityEvents