[Unreal Engine] 모듈(Module)

모듈은 Unreal Engine의 소프트웨어 아키텍처에서 기본적인 구성 요소로, 렌더링, 입력 처리, 게임플레이 로직 등 특정 기능을 독립적인 코드 단위로 캡슐화한 코드 묶음입니다. 각 모듈은 Unreal Build Tool(UBT)에 의해 개별적으로 컴파일되며, 필요한 경우 다른 모듈과의 의존성을 정의하여 연결될 수 있습니다.

---

모듈의 구조

모듈은 프로젝트의 📂Source 내에 위치하며, 다음과 같은 구조를 가집니다.

MyProject/
└── Source/
    └── MyModule/
        ├── MyModule.Build.cs
        ├── Private/
        │   └── MyModule.cpp
        └── Public/
            └── MyModule.h

• MyModule.Build.cs: 모듈의 빌드 설정과 의존성을 정의합니다.
• Private/: 모듈의 내부 구현 파일(.cpp 등)을 포함합니다.
• Public/: 다른 모듈에서 접근 가능한 헤더 파일(.h 등)을 포함합니다.

---

Build.cs 파일

📄{ModuleName}.Build.cs 파일은 모듈의 빌드 설정과 의존성을 정의합니다.

이 파일을 참고하여 Unreal Build Tool(UBT)이 모듈을 빌드합니다.

using UnrealBuildTool;

public class MyModule : ModuleRules
{
    public MyModule(ReadOnlyTargetRules Target) : base(Target)
    {
        PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs;

        PublicDependencyModuleNames.AddRange(new string[] {
            "Core", "CoreUObject", "Engine"
        });

        PrivateDependencyModuleNames.AddRange(new string[] {
            "Slate", "SlateCore"
        });
    }
}

• PublicDependencyModuleNames: 모듈 외부에서 접근 가능한 의존 모듈을 정의합니다. 예를 들어, A모듈이 B모듈을 Public으로 의존하고 있다면, A모듈을 사용하는 외부에서도 B모듈에 접근 가능합니다.
• PrivateDependencyModuleNames: 모듈 내부에서만 사용하는 의존 모듈을 정의합니다. 예를 들어, A모듈이 B모듈을 Private로 의존하고 있다면, A모듈을 사용하는 외부에서 B모듈에 접근 할 수 없습니다.

---

모듈 구현 

1. IModuleInterface을 상속하여 {ModuleName} 클래스를 만든다.
   이때 클래스의 헤더 파일(.h)은 📂{ModuleName}/Pubilc에  소스 파일(.cpp)은 📂{ModuleName}/Private에 추가한다. 
   
   
2. {ModuleName}.cpp 파일에 IMPLEMENT_MODULE 매크로를 사용하여 모듈로 등록합니다. 

#include "TestModule.h"
#include "Modules/ModuleManager.h"

	IMPLEMENT_MODULE(FDefaultModuleImpl, TestModule);

 

---

프라이머리 모듈 (Primary Module)

모든 프로젝트와 플러그인은 하나의 프라이머리 모듈이 있어야 합니다.

UBT은 프로젝트의 프라이머리 모듈을 Root로 의존성 그래프(Dependency Graph)구성하고 이를 바탕으로 빌드를 진행하기 때문입니다.

기본적으로 프로젝트엔 자체 프라이머리 모듈이 있지만, 모듈을 따로 정의하여 코드를 정리할 수 있습니다.

이때는 IMPLEMENT_PRIMARY_GAME_MODULE 매크로를 이용하여 프라이머리 모듈을 지정할 수 있습니다.

#include "FPSTemplate.h"
#include "Modules/ModuleManager.h"

IMPLEMENT_PRIMARY_GAME_MODULE( FDefaultGameModuleImpl, FPSTemplate, "FPSTemplate" );

 

---

모듈 로드 방식 제어

Unreal Engine에서는 모듈의 로드 방식은 📄.uproject 또는 📄.uplugin 파일에서 정의할 수 있습니다.

"Modules": [
    {
        "Name": "MyModule",
        "Type": "Runtime",
        "LoadingPhase": "Default"
    },
    {
        "Name": "MyModuleEditor",
        "Type": "Editor",
        "LoadingPhase": "Default"
    }
]

모듈 유형은 모듈이 사용되는 용도를 지정하며, UBT는 실행 환경에 따라 적절한 유형의 모듈을 로드합니다.
모듈 유형은 EHostType::Type 열거형을 통해 정의되며, 주요 유형은 다음과 같습니다:

• Runtime: 게임 실행 시 로드되는 모듈입니다.
• Editor: 에디터에서만 로드되는 모듈입니다.
• Developer: 개발 중에만 로드되는 모듈입니다.
• Program: 독립 실행형 프로그램에 사용되는 모듈입니다.

모듈의 로딩 시점은 LoadingPhase 속성을 통해 제어할 수 있으며, 주요 값은 다음과 같습니다:

• Default: 기본 로딩 시점입니다.
• PreDefault: 기본 로딩 시점보다 앞서 로드됩니다.
• PostDefault: 기본 로딩 시점 이후에 로드됩니다.

---

모듈 사용의 장점

1. 명확한 코드 분리	모듈은 기능 단위로 코드를 구분하고, 내부 구현을 감춤으로써 캡슐화를 실현합니다. (OOP 원칙 준수)
2. 빌드 시간 단축	모듈은 별도 컴파일 유닛으로 처리되며, 변경된 모듈만 다시 컴파일됩니다.
3. IWYU 기반 의존성 관리	IWYU 원칙에 따라 모듈들은 의존성 그래프로 연결되어 있고, 실제로 사용되는 헤더만 포함(Include)되도록 제한되어 있습니다. 이에 따라, 실제 프로젝트에 사용되지 않는 모듈은 컴파일에서 안전하게 제외될 수 있습니다.
4. 런타임 로딩 제어 가능	모듈은 런타임에 필요에 따라 동적으로 로딩/언로딩 가능하여, 성능 최적화에 유리합니다.
5. 플랫폼 조건부 포함 가능	Target.Platform == ... 등의 조건으로 특정 플랫폼에서만 모듈을 포함할 수 있습니다.
6. 재사용성과 유지보수성 향상	기능별로 나뉜 모듈 구조는 향후 리팩토링과 테스트, 재사용에 효과적입니다.