UndoPro

UndoPro

Unity集成式命令撤销系统

UndoPro是Unity生态系统中的开源撤销框架。它通过命令模式集成到Unity默认系统,提供扩展回调和API,支持匿名操作处理。该框架具备智能序列化功能,可处理多种操作和对象。UndoPro设计简洁,易于集成,并配备API和调试工具,有助于开发者实现高级撤销功能。框架保持了用户熟悉的工作流程,适用于各类Unity项目开发。

UndoProUnity命令模式撤销系统插件Github开源项目

UndoPro

UndoPro是一个基于命令的撤销系统,集成到Unity的默认系统中。这允许开发者使用操作来进行撤销/重做操作,而无需强迫用户适应新的撤销工作流程!

论坛帖子

安装

根据您想要使用UndoPro或分发您的工具的方式,您有几个选择。

  1. Unity包管理器(推荐) 进入Unity包管理器,通过git URL添加,输入:https://github.com/Seneral/UndoPro.git#release-pkg 或从release-pkg分支下载并在早期Unity版本中从磁盘安装 如果您基于UndoPro分发您的工具,您的用户需要先手动安装UndoPro,然后再安装您的工具 但这个选项与使用UndoPro的其他工具最兼容,并且可以自动更新

  2. 单独安装和分发UndoPro 第二好的选择,不要修改UndoPro,只要所有相关工具保持GUID完整,您就可以正常分发它。但当Unity破坏UndoPro并需要热修复时,如果您或其他工具仍然随您的工具分发旧版本的UndoPro,您可能会遇到问题

  3. 将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中进一步说明)

编辑推荐精选

蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多