如何编写UE4插件，简析插件系统

JoshWindsor · 发表于 2022-1-31 06:02

在UE4里添加自定义插件很简单，下面以一个Editor插件为例讲解，分为以下几个步骤：

1. .uproject用的是jason格式，它定义了工程的各部分信息。在.uproject 中声明插件模块，第一个模块是Game模块，第二个是plugin模块。在Modules字段下加入如下代码：
&#34;FileVersion&#34;: 3,
&#34;EngineAssociation&#34;: &#34;4.11&#34;,
&#34;Category&#34;: &#34;&#34;,
&#34;Description&#34;: &#34;&#34;,
&#34;Modules&#34;: [
{
&#34;Name&#34;: &#34;UE4Cookbook&#34;,
&#34;Type&#34;: &#34;Runtime&#34;,
&#34;LoadingPhase&#34;: &#34;Default&#34;,
&#34;AdditionalDependencies&#34;: [
&#34;Engine&#34;,
&#34;CoreUObject&#34;
]
},
{
&#34;Name&#34;: &#34;Ranging&#34;,
&#34;Type&#34;: &#34;Editor&#34;,
&#34;LoadingPhase&#34;: &#34;Default&#34;,
&#34;AdditionalDependencies&#34;: [
&#34;Engine&#34;,
&#34;CoreUObject&#34;
]
}
]
}Ranging为示例名字，以下所有步骤中都替换为自己的插件模块名。
模块的格式主要有以下几个属性：

Name：模块名字
Type：模块类型，只在运行时加载Runtime，或者是只在编辑器下加载Editor
Loadingphase：决定加载顺序
AdditionalDependencies：所依赖的模块名字

这个步骤是可选项，可以手动写入uproject，执行Generateproject后会生效，也可以在编辑器中Plugin设置里勾选加载。

2. 在Content目录下建立Content/Plugins/YourPluginName 的目录结构，在此目录下添加YourPluginName.build.cs文件。添加以下内容：
using UnrealBuildTool;
public class Ranging : ModuleRules
{
public Ranging (TargetInfo Target)
{
PublicDependencyModuleNames.AddRange(new string[] {
&#34;Core&#34;, &#34;CoreUObject&#34;, &#34;Engine&#34;, &#34;InputCore&#34;, &#34;RHI&#34;,
&#34;RenderCore&#34;, &#34;ShaderCore&#34; });
PublicDependencyModuleNames.Add(&#34; &#34;);
PrivateDependencyModuleNames.AddRange(new string[] {
&#34;UnrealEd&#34; });
}
}
此文件是UE4用来构建工程和依赖的C#文件，类似于makefile/cmake的作用，其中引用UnrealBuildTool（UBT），实现ModuleRules类，TargetInfo 是指编译的目标平台（win/mac/linux）。通过如PublicDependencyModuleNames等接口添加依赖模块，头文件源文件路径，lib和dll路径。
如果模块中需要引用此插件的其他模块，亦要将所依赖的模块名包含在内。

3. 在.uplugin文件下加入模块及其属性描述，如下所示，书写方法如1步骤中一致，注意，如果插件中添加多个模块，则所有模块都必须写入.uplugin文件中，依照引用关系确立载入顺序。
{
&#34;FileVersion&#34;: 3,
&#34;Version&#34;: 1,
&#34;VersionName&#34;: &#34;1.0&#34;,
&#34;FriendlyName&#34;: &#34;Ranging&#34;,
&#34;Description&#34;: &#34; &#34;,
&#34;Category&#34;: &#34;Other&#34;,
&#34;CreatedBy&#34;: &#34;Eric&#34;,
&#34;CreatedByURL&#34;: &#34;&#34;,
&#34;DocsURL&#34;: &#34;&#34;,
&#34;MarketplaceURL&#34;: &#34;&#34;,
&#34;SupportURL&#34;: &#34;&#34;,
&#34;CanContainContent&#34;: true,
&#34;IsBetaVersion&#34;: false,
&#34;Installed&#34;: false,
&#34;Modules&#34;: [
{
&#34;Name&#34;: &#34;Ranging&#34;,
&#34;Type&#34;: &#34;Editor&#34;,
&#34;LoadingPhase&#34;: &#34;Default&#34;
}
]
}4. 在Content/Plugins/YourPluginName路径下添加Public和Private文件夹，分别添加YourPluginName.h和YourPluginName.cpp，在YourPluginName.h中加入如下代码，实现IModuleInterface接口，用于加载模块和卸载模块。
#pragma once
#include &#34;Engine.h&#34;
#include &#34;ModuleManager.h&#34;
#include &#34;UnrealEd.h&#34;
class FRangingModule: public IModuleInterface
{
};
在YourPluginName.cpp中加入如下代码：
#include &#34;Ranging.h&#34;
IMPLEMENT_GAME_MODULE(FRangingModule, Ranging)IMPLEMENT_GAME_MODULE会申明一个Exported C函数，UE4只需要调用InitializeModule()就会会返回一个此模块的实例，而不需要知道此模块的类型。

5. 用Generateproject命令生成工程，UBT和UHT就会建立所有Plugin的依赖关系和引用，用VS打开后，可以看到插件文件在工程中，编译通过后，插件添加完成。

如果要在插件中添加多个模块，如需要区分Editor下运行的和Runtime下运行的模块，亦可以按照之前方式，在Content/Plugins/下添加多个模块文件夹，如Content/Plugins/YourPluginNameEditor，Content/Plugins/YourPluginNameRuntime，一般在名字后面加类型。之后别忘了在.uplugin下申明模块。

		自动登录	找回密码
密码			立即注册

如何编写UE4插件，简析插件系统

本帖子中包含更多资源