如何在UE4的自定义插件中引入第三方库?
假设你懂得如何编写并且已经编写好了一个新的UE4引擎插件
假设你已经拥有可以正常使用的第三方库(自己写的或者网上下的)
要引入第三方库,大致需要四步:
- 放置库到合适目录,通常在你的UE模块目录下
- 编辑模块的Build.cs文件
- 在代码中加载dll文件
- 编译和调试
一、放置库到合适目录
我的三方库(CutlistSDK)目录结构现在是:
我把CutlistSDK文件夹放在了模块Build.cs文件所在的目录。
CutlistSDK文件夹包含了三个子文件夹bin、include 和 lib。
其中,bin包含了运行时需要用到的dll文件,include包含了库的头文件,lib包含了lib库文件。
二、编辑模块的Build.cs文件
你当然知道它们在这儿,但是UBT编译的时候并不知道,所以你需要修改Build.cs文件,告诉模块这些文件在什么地方。
在模块类构造函数中添加如下行:
// ThirdParty - Cutlist
string IncDir = Path.Combine(ModuleDirectory, "ThirdParty/CutlistSDK/include");
string LibDir = Path.Combine(ModuleDirectory, "ThirdParty/CutlistSDK/lib");
string DllDir = Path.Combine(ModuleDirectory, "ThirdParty/CutlistSDK/bin");
// Include
PublicIncludePaths.Add(IncDir);
// Libraries
foreach (string file in Directory.GetFiles(LibDir))
{
PublicAdditionalLibraries.Add(file);
}
// Dlls
foreach (string file in Directory.GetFiles(DllDir))
{
RuntimeDependencies.Add(file);
// delay load
string filename = Path.GetFileName(file);
PublicDelayLoadDLLs.Add(filename);
}
*当然,你也可以不使用延迟加载,那么就要去掉 PublicDelayLoadDLLs.Add() 那行,然后把三方库dll都放到你的模块dll的目录(Binaries目录下)
三、在代码中加载dll文件
一般来说,会采用延迟加载,那么需要在模块启动时(通常)LoadLibrary,好在UE4封装了Win32API的接口,用起来比较方便。
写一个 LoadRequiredLibraries() 函数,在模块的 StartupModule() 里面调用,实现如下:
#include "Interfaces/IPluginManager.h"
bool LoadRequiredLibraries()
{
IFileManager& FileManager = IFileManager::Get();
FString DllPath = FPaths::Combine(IPluginManager::Get().FindPlugin(TEXT("SobeyMedia"))->GetBaseDir(), TEXT("/Source/SobeyMedia/ThirdParty/CutlistSDK/bin"));
FPlatformProcess::PushDllDirectory(*DllPath);
TArray<FString> DllNames;
if (FileManager.DirectoryExists(*DllPath))
{
FileManager.FindFiles(DllNames, *DllPath);
}
for (auto& dllname : DllNames)
{
if (FPaths::GetExtension(dllname) != "dll")
continue;
// GetDllHandle()必须传入绝对路径,不然会加载失败!
FPlatformProcess::GetDllHandle(*FPaths::Combine(DllPath, dllname));
}
return true;
}
四、编译调试
在你的代码里包含头文件,然后调用相应函数。编译,运行,调试即可。
如果仍遇到问题,欢迎留言讨论。