UE4 如何创建游戏模块（Modules）补充

06/20/2021

游戏模块

1. 游戏模块至少要包含一个头文件 (.h)、一个 C++ 文件 (.cpp) 和一个编译文件 (*.Build.cs)。
2. 头文件必须位于模块目录的 Public 文件夹中，也就是 [GameName] \Source\ [ModuleName]\Public 目录。该文件包含了编译该模块中的类所需的所有头文件 - 包括模块自动生成的头文件。
3. C++ 文件必须位于模块目录的 Private 文件夹中，也就是 [GameName]\Source[ModuleName]\Private 目录，用于注册及实现模块。

在您的游戏中，至少要使用 IMPLEMENT_PRIMARY_GAME_MODULE 注册一个模块。其他模块可以使用另一个可选的 IMPLEMENT_GAME_MODULE 方法进行注册。请参照 多个游戏性模块 部分获得在一个游戏项目中使用多个游戏性模块的更多细节。

第一步

这里注册了模块的名字

// 包括游戏的头文件
#include "<ModuleName>.h"

// 将模块指定为主模块
IMPLEMENT_PRIMARY_GAME_MODULE( <ModuleName>, "<GameName>" ); 
IMPLEMENT_GAME_MODULE( <ModuleName>, "<GameName>" ); 


//ModuleName.build.cs 确定了模块的名字
using UnrealBuildTool;

public class <ModuleName> : ModuleRules
{
    public <ModuleName>( TargetInfo Target )
    {
        PublicDependencyModuleNames.AddRange( new string[] { "Core", "Engine" } );
        PrivateDependencyModuleNames.AddRange( new string[] { "RenderCore" } );
    }
}

保证游戏模块名字的一致性

您可以创建一个主要的游戏模块，然后在创建多个额外的游戏相关的模块。您可以针对这些新模块创建 *.Build.cs 文件，然后把到这些模块的引用添加到您的游戏的 Target.cs 文件（OutExtraModuleNames 数组）中。至少有一个模块必须使用 IMPLEMENT_PRIMARY_GAME_MODULE 宏，而所有其他模块应该使用 IMPLEMENT_GAME_MODULE 宏。虚幻编译工具将会自动发现这些模块，并编译额外的游戏DLL文件。

1. 可以在Build.cs建立模块的引用
2. 也可以在Target.cs建立模块的引用

第二步

INI 文件设置
由于新的游戏性模块包含 UObject 代码，所以需进行一些必要的配置。

这一步在官网中还存在，但是个人觉得已经没有意义了，不需要配置也可。

ThirdPerson例子

Target.cs

虚幻编译工具支持数个目标类型的编译：

游戏——需要烘焙数据才能运行的standalone游戏。

客户端——与游戏相同，但不包含任何服务器代码。适用于联网游戏。

服务器——与游戏相同，但不包含任何客户端代码。适用于联网游戏中的专用服务器。

编辑器——扩展虚幻编辑器的目标。

程序——基于虚幻引擎打造的standalone工具程序。

//MyProject.target.cs
using UnrealBuildTool;
using System.Collections.Generic;
public class MyProjectTarget :TargetRules
{
    public MyProjectTarget(TargetInfo Target) : base(Target)		//保持名字一致
    {
        Type = TargetType.Game;			//<------- 确定目标类型
        // 此处为其他属性
    }
}

类的名称必须与在其中声明这个类的文件的名称相匹配，后跟"Target"（例如，MyProject.target.cs定义类"MyProjectTarget"）。

其他属性

Configuration = development,test,shipping
Platform = PS4,Win64,Xbox,...

参考资料

CSDN 游戏模块
UE4 Build.cs
UE4 Target.cs