[Unreal] 언리얼 오브젝트 리플렉션 시스템 (ensure, check)

프로그램이 실행시간에 자기 자신을 조사하는 기능, 언리얼 테크놀로지의 기본

 

리플렉션을 가질 수 있는 오브젝트는 열거형 UENUM(), 클래스 UCLASS(), 구조체 USTRUCT(), 함수 UFUNCTION(), 멤버 변수 UPROPERTY()

오브젝트가 리플렉션을 가지면 디테일 패널, 직렬화, 가비지 콜렉션, 네트워크 리플리케이션, 블루프린트 등 언리얼 엔진의 유용한 시스템에서 사용 가능하다.

 

리플렉션을 가지게 하려면  오브젝트가 포함된 C++ 클래스 헤더 파일에 "모듈명".generated.h 헤더를 포함해야 한다. 해당 헤더를 가져야 리플렉션이 있는 시스템에서 해당 클래스를 고려해야 하고 시스템 구현이 필요함을 언리얼 헤더 툴 UHT에 알린다.

 

모든 언리얼 오브젝트는 클래스 정보와 함께한다.

클래스를 사용해 자신이 가진 프로퍼티와 함수 정보를 컴파일 타임과 런타임에 조회 가능하다.

다양한 기능을 제공하는 언리얼 오브젝트는 NewObjectAPI를 사용해 생성해야 한다.

 

클래스 기본 오브젝트  (CDO)

언리얼 객체가 가진 기본 값을 보관하는 템플릿 객체

한 클래스로부터 다수의 물체를 생성해 게임 콘텐츠에 배치할 때 일관성있게 기본 값을 조정하는데 유용하게 사용된다.

CDO는 클래스 정보로부터 GetDefaultObject 함수를 통해 얻을 수 있음

UClass 및 CDO는 엔진 초기화 과정에서 생성되므로 콘텐츠 제작에서 안심하고 사용 가능

 

예제

어떤 학교에서 학생과 교수가 함게 수업하는 상황 구현

학교 정보 = GameInstance에서 지정

인물 클래스(Person) = 학생 클래스(Student), 선생 클래스(Teacher)

 

언리얼 에러로그 예시1 - check 사용시

 

언리얼 에러로그 예시2 - ensure 사용시

 

헤더의 리플렉션 구조를 변경하거나 생성자 코드의 CDO 기본값을 변경하는 경우

에디터를 종료한 뒤에 컴파일 한 후 다시 에디터를 켜야 안전하다.

 

MyGameInstance 헤더

class OBJECTREFLECTION_API UMyGameInstance : public UGameInstance
{
	GENERATED_BODY()
	
public:
	UMyGameInstance();

	virtual void Init() override;

private:
	UPROPERTY();
	FString SchoolName;
};

 

MyGameInstance  소스코드

UMyGameInstance::UMyGameInstance() // 생성자 코드
{
	SchoolName = TEXT("기본학교"); // CDO의 기본값 설정
}

void UMyGameInstance::Init()
{
	Super::Init();

	UE_LOG(LogTemp, Log, TEXT("==========================="));
	UClass* ClassRuntime = GetClass();
	UClass* ClassCompile = UMyGameInstance::StaticClass();
	//check(ClassRuntime != ClassCompile); // 검증 적극적으로 활용, 문제 발생시 에디터 종료됨
	//ensure(ClassRuntime != ClassCompile); // 에디터 종료되지 않고 검증 가능
	//ensureMsgf(ClassRuntime != ClassCompile, TEXT("일부러 에러를 발생시키는 코드")); // 에디터 종료X + 메세지 남길 수 있음

	UE_LOG(LogTemp, Log, TEXT("학교를 담당하는 클래스 이름 : %s"), *ClassRuntime->GetName());

	SchoolName = TEXT("청강문화산업대학교"); // 기본 객체와 무관하게 생성된 MyGameInstance에 설정
	UE_LOG(LogTemp, Log, TEXT("학교 이름 : %s"), *SchoolName); // 청강문화
	UE_LOG(LogTemp, Log, TEXT("학교 이름 기본값 : %s"), *GetClass()->GetDefaultObject<UMyGameInstance>()->SchoolName); // 기본학교

	UE_LOG(LogTemp, Log, TEXT("==========================="));
}

 

 

CDO 생성시점

엔진이 초기화되는 과정에서 CDO 및 UClass 정보들이 만들어진다. 가동이 된 후에 게임 실행된다.

 

 

정리

언리얼 오브젝트에는 항상 클래스 정보를 담은 UClass 객체가 매칭되어 있다.

UClass로부터 언리얼 오브젝트의 정보를 파악 가능하다.

UClass에는 CDO가 연결되어 있어 이를 활용해 개발의 생산성 향상 가능

클래스 정보와 CDO는 엔진 초기화 과정에서 생성되므로 게임 개발에서 안전하게 사용 가능

헤더 정보를 변경하거나 생성자 정보를 변경하면 에디터를 끄고 컴파일하는 것이 안정적이다.

 

리플렉션 시스템을 사용해 언리얼 오브젝트의 특정 속성과 함수를 이름으로 검색 가능

리플렉션 시스템을 사용해 접근 지시자와 무관하게 값 설정 가능

리플렉션 시스템을 사용해 언리얼 오브젝트의 함수 호출 가능

 

언리얼 엔진의 기본 프레임웍은 리플렉션을 활용해 구축되어 있으므로 언리얼 엔진을 이해하기 위해서 리플렉션 시스템을 이해해야