UndoPro
UndoPro是一个基于命令的撤销系统,集成到Unity的默认系统中。这允许开发者使用操作来进行撤销/重做操作,而无需强迫用户适应新的撤销工作流程!
安装
根据您想要使用UndoPro或分发您的工具的方式,您有几个选择。
-
Unity包管理器(推荐) 进入Unity包管理器,通过git URL添加,输入:https://github.com/Seneral/UndoPro.git#release-pkg 或从release-pkg分支下载并在早期Unity版本中从磁盘安装 如果您基于UndoPro分发您的工具,您的用户需要先手动安装UndoPro,然后再安装您的工具 但这个选项与使用UndoPro的其他工具最兼容,并且可以自动更新
-
单独安装和分发UndoPro 第二好的选择,不要修改UndoPro,只要所有相关工具保持GUID完整,您就可以正常分发它。但当Unity破坏UndoPro并需要热修复时,如果您或其他工具仍然随您的工具分发旧版本的UndoPro,您可能会遇到问题
-
将UndoPro嵌入到您的项目中 务必确保更改所有GUID,并将所有UndoPro代码包装到单独的命名空间中,同时修改程序集定义,否则会与其他工具冲突。 不推荐,因为您将完全负责确保您分发的UndoPro版本是最新的。 只有在您绝对需要特定版本的UndoPro或想在使用它之前对其进行修改时才这样做。
功能
- 扩展的撤销回调:分离撤销/重做并带有记录名称,OnAddUndoRecord等
- 用于创建基于命令的撤销记录的API
- 无问题地处理大多数匿名操作,甚至包括上下文!
工作原理
Unity只提供了有关撤销系统的非常有限的信息:
- 当前记录的ID,但它不是唯一的,而是稳定增加的 :/
- 当前记录/组的名称(不唯一)
- 通过反射,仅按名称获取完整的撤销/重做堆栈(不唯一)
- UndoRedoPerformed回调
在内部,当调用API添加基于命令的记录时,UndoPro会在默认系统中创建一个虚拟记录。然后使用可用的回调跟踪这些记录,并在它们从重做堆栈切换到撤销堆栈或反之时执行命令。 一个大障碍是默认撤销系统的行为:几乎无法预测!在某些条件下,记录可能在撤销/重做时重复或消失。创建一个可靠的跟踪算法非常困难,但却是必需的。显然,还必须检测新记录的添加。
完成跟踪后,会分别计算撤销和重做堆栈的偏移值(请记住,记录可能在撤销/重做过程中消失或重复!)。然后相应地更新内部记录,并概述要撤销/重做的记录。
在此过程中,会调用额外的回调OnUndoPerformed/OnRedoPerformed/OnAddUndoRecord。
基于命令的记录的序列化
序列化也是一个大问题,因为操作,特别是匿名操作,很难序列化。UndoPro在当前场景中维护一个隐藏的临时GameObject,用于保存需要序列化的所有自定义记录。序列化是通过一些智能处理Action、Object、Method等各种组合的包装类实现的。
这个系统甚至可以通用使用! -> 支持所有可序列化对象(包括UnityEngine.Object和System.Object)和部分不可序列化对象(一层可序列化成员序列化),所有其他对象都使用默认值 -> 甚至支持大多数匿名操作(尚未发现不可序列化的)!您可以完全使用上下文并引用几乎所有本地变量(上述条件适用)!
问题
这个系统看起来很可靠,但我不能声称它完全无懈可击! 当跟踪出错时,最坏的情况是您的记录偏移了一小部分(动作在一两个记录之后/之前执行)。目前幸运的是还没有发现这种情况,但我对任何失败不承担责任! 如果您设法破坏了它,请通过问题通知我并提供您所做的信息,我会尝试修复:)
安装
只需将UndoPro文件夹放在项目中的某个位置即可!即使它不必放在Editor文件夹中,也不意味着您可以在运行时使用它!需要Editor API的功能在运行时通过预处理器检查被排除。 另一方面,在Editor文件夹中,您会找到两个有用的窗口,用于测试1.撤销系统本身和2.操作序列化系统的功能。通过这些窗口,您可以轻松地自己调试系统,看看它是如何工作的,只需在UndoProManager中取消注释#define UNDO_DEBUG即可! 如果您只想为自己的项目使用操作序列化系统,只需复制UndoPro/SerializableAction文件夹以及许可证即可!
API
对开发者来说,API非常简单。 添加UndoPro依赖,然后使用UndoProManager与系统交互。重要元素:
- RecordOpterationAndPerform - 接受撤销/重做的操作以及标签,并将它们添加为记录。此外,它还将执行重做操作。
- RecordOperation(2个重载) - 接受撤销/重做的操作以及标签,并将它们添加为记录。如果您已经手动执行了操作,请使用此方法
- OnUndoPerformed回调 - 在执行撤销时调用。传递所有已撤销的记录,如果它们被分组,可能有多个。
- OnRedoPerformed回调 - 在执行重做时调用。传递所有已重做的记录,如果它们被分组,可能有多个。
- OnAddUndoRecord回调 - 在添加记录时调用,无论是来自UndoPro还是默认系统。传递其名称以及是否被视为"重要"(某些记录在添加时会清除重做堆栈,而某些记录,如选择更改,则不会)。这也可能与添加的记录是包含在最后一组记录中还是开启了新的组有关(不确定)。
- EnableUndoPro/DisableUndoPro - 切换系统状态。不建议禁用,因为它只会在记录中创建一个空洞并搞乱以前的记录!
建议:如果您计算了某些内容或执行了任何带有中间结果的操作,只要结果是可序列化的,设置起来就非常容易。不要在撤销/重做操作中重新计算,只需在撤销操作中设置先前的可序列化结果,在重做操作中设置新结果即可。完成!
作者和许可证
此扩展由Seneral创建,并根据MIT许可证发布(在LICENSE.md中进一步说明)