ouczbs/zworld-em
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
master
zworld-em/Plugins/UnLua/Source/UnLuaDefaultParamCollectorUbtPlugin/README.md
ouczbs 6ea5c8d975 upload niagara ndc
2025-05-11 22:07:21 +08:00

3.1 KiB
Raw Permalink Blame History

UnLuaDefaultParamCollectorUbtPlugin

概述

这是 UnLua 插件中 UnLuaDefaultParamCollector 模块的 C# 版本，用于让引擎启用 C# 版本的 UHT (UnrealHeaderTool) ，从而解决在 UE5.1 中编译 UnLua 插件时出现以下编译警告的问题。

DEPRECATED: C++ UHT being used because 'UnLua' does not have a C# version. C++ UHT has been deprecated and will be removed in 5.2

原理

在 5.1 或更高版本的引擎中，UnLuaDefaultParamCollectorUbtPlugin 会取代 UnLuaDefaultParamCollector，在编译 UHT 时导出 DefaultParamCollection.inl，具体实现请见 UnLuaDefaultParamCollectorUbtPlugin.cs。UnLuaDefaultParamCollectorUbtPlugin 和 UnLuaDefaultParamCollector 导出的 DefaultParamCollection.inl 是大致相同的，区别有以下几点：

  • 前者在文件头处增加了一行注释 // Generated By C# UbtPlugin；在测试的时候，可以检查导出文件的开头是否包含该行注释，以此判断引擎是否启用了 C# 版本的 UHT

  • 前者导出的注释，增加了 ModuleType 枚举值名称的输出；当前的注释形如 // ModuleName CoreUObject Type EngineRuntime(1) ModuleGeneratedIncludeDirectory C:/UE5.1/Engine/Intermediate/Build/Win64/UnrealEditor/Inc/CoreUObject/UHT，而此前的注释形如 // ModuleName CoreUObject Type 1 ModuleGeneratedIncludeDirectory C:/UE5.1/Engine/Intermediate/Build/Win64/UnrealEditor/Inc/CoreUObject/UHT

  • 部分类型的导出顺序有所变化；原因是 C# 和 C++ 遍历引擎类型的顺序有所不同，不过除了顺序之外，导出的类型和函数都是相同的

原来的 UnLuaDefaultParamCollector 并不需要删除，它会在 5.0 或更低版本的引擎中生效。低版本的引擎仍然会使用 C++ 版本的 UHT，UnLuaDefaultParamCollectorUbtPlugin 的存在对此没有任何影响。

测试记录

注意事项

UnLuaTestSuite 也是一个可以被引擎 UHT 调用的插件（在 UnLuaTestSuite.uplugin 中，CanBeUsedWithUnrealHeaderTool 是 true），而且也没有提供 C# 版本的模块。因此如果一个项目，例如 TPSProject，还包含 UnLuaTestSuite 插件的话，在编译时就会出现另一个警告。

DEPRECATED: C++ UHT being used because 'UnLuaTestSuite' does not have a C# version. C++ UHT has been deprecated and will be removed in 5.2

请注意，UnLuaDefaultParamCollectorUbtPlugin 只能去除 UnLua 插件的警告，并不能去除以上由 UnLuaTestSuite 插件引起的警告。换言之，如果一个项目包含了 UnLuaTestSuite 插件，在编译时引擎就仍然会调用 C++ 版本的 UHT。按照官方的说法，在正式项目中并不需要用到 UnLuaTestSuite 插件，因此如果发现 UnLuaDefaultParamCollectorUbtPlugin 没有生效，或者 UHT 警告仍然存在，请检查项目是否多包含了 UnLuaTestSuite 插件。