Unreal Engine C++ Pro
This skill provides expert-level guidelines for developing with Unreal Engine 5 using C++. It focuses on writing robust, performant, and standard-compliant code.
When to Use
Use this skill when:
- Developing C++ code for Unreal Engine 5.x projects
- Writing Actors, Components, or UObject-derived classes
- Optimizing performance-critical code in Unreal Engine
- Debugging memory leaks or garbage collection issues
- Implementing Blueprint-exposed functionality
- Following Epic Games' coding standards and conventions
- Working with Unreal's reflection system (UCLASS, USTRUCT, UFUNCTION)
- Managing asset loading and soft references
Do not use this skill when:
- Working with Blueprint-only projects (no C++ code)
- Developing for Unreal Engine versions prior to 5.x
- Working on non-Unreal game engines
- The task is unrelated to Unreal Engine development
Core Principles
UObject & Garbage Collection:
- Always use
UPROPERTY() for UObject* member variables to ensure they are tracked by the Garbage Collector (GC).
- Use
TStrongObjectPtr<> if you need to keep a root reference outside of a UObject graph, but prefer addToRoot() generally.
- Understand the
IsValid() check vs nullptr. IsValid() handles pending kill state safely.
Unreal Reflection System:
- Use
UCLASS(), USTRUCT(), UENUM(), UFUNCTION() to expose types to the reflection system and Blueprints.
- Minimize
BlueprintReadWrite when possible; prefer BlueprintReadOnly for state that shouldn't be trampled by logic in UI/Level BPs.
Performance First:
- Tick: Disable Ticking (
bCanEverTick = false) by default. Only enable it if absolutely necessary. Prefer timers (GetWorldTimerManager()) or event-driven logic.
- Casting: Avoid
Cast<T>() in hot loops. Cache references in BeginPlay.
- Structs vs Classes: Use
F structs for data-heavy, non-UObject types to reduce overhead.
Naming Conventions (Strict)
Follow Epic Games' coding standard:
- Templates: Prefix with
T (e.g., TArray, TMap).
- UObject: Prefix with
U (e.g., UCharacterMovementComponent).
- AActor: Prefix with
A (e.g., AMyGameMode).
- SWidget: Prefix with
S (Slate widgets).
- Structs: Prefix with
F (e.g., FVector).
- Enums: Prefix with
E (e.g., EWeaponState).
- Interfaces: Prefix with
I (e.g., IInteractable).
- Booleans: Prefix with
b (e.g., bIsDead).
Common Patterns
1. Robust Component Lookup
Avoid GetComponentByClass in Tick. Do it in PostInitializeComponents or BeginPlay.
void AMyCharacter::PostInitializeComponents() {
Super::PostInitializeComponents();
HealthComp = FindComponentByClass<UHealthComponent>();
check(HealthComp); // Fail hard in dev if missing
}
2. Interface Implementation
Use interfaces to decouple systems (e.g., Interaction system).
// Interface call check
if (TargetActor->Implements<UInteractable>()) {
IInteractable::Execute_OnInteract(TargetActor, this);
}
3. Async Loading (Soft References)
Avoid hard references (UPROPERTY(EditDefaultsOnly) TSubclassOf<AActor>) for massive assets which force load orders. Use TSoftClassPtr or TSoftObjectPtr.
UPROPERTY(EditAnywhere, BlueprintReadWrite)
TSoftClassPtr<AWeapon> WeaponClassToLoad;
void AMyCharacter::Equip() {
if (WeaponClassToLoad.IsPending()) {
WeaponClassToLoad.LoadSynchronous(); // Or use StreamableManager for async
}
}
Debugging
- Logging: Use
UE_LOG with custom categories.DEFINE_LOG_CATEGORY_STATIC(LogMyGame, Log, All);
UE_LOG(LogMyGame, Warning, TEXT("Health is low: %f"), CurrentHealth);
- Screen Messages:
if (GEngine) GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Red, TEXT("Died!"));
- Visual Logger: extremely useful for AI debugging. Implement
IVisualLoggerDebugSnapshotInterface.
Checklist before PR
1---2name: unreal-engine-cpp-pro3description: "Expert guide for Unreal Engine 5.x C++ development, covering UObject hygiene, performance patterns, and best practices."4risk: safe5source: self6metadata:7 source: https://skillmd.com/skills/mayurrathi/unreal-engine-cpp-pro8---910# Unreal Engine C++ Pro1112This skill provides expert-level guidelines for developing with Unreal Engine 5 using C++. It focuses on writing robust, performant, and standard-compliant code.1314## When to Use1516Use this skill when:17- Developing C++ code for Unreal Engine 5.x projects18- Writing Actors, Components, or UObject-derived classes19- Optimizing performance-critical code in Unreal Engine20- Debugging memory leaks or garbage collection issues21- Implementing Blueprint-exposed functionality22- Following Epic Games' coding standards and conventions23- Working with Unreal's reflection system (UCLASS, USTRUCT, UFUNCTION)24- Managing asset loading and soft references2526Do not use this skill when:27- Working with Blueprint-only projects (no C++ code)28- Developing for Unreal Engine versions prior to 5.x29- Working on non-Unreal game engines30- The task is unrelated to Unreal Engine development3132## Core Principles33341. **UObject & Garbage Collection**:35 * Always use `UPROPERTY()` for `UObject*` member variables to ensure they are tracked by the Garbage Collector (GC).36 * Use `TStrongObjectPtr<>` if you need to keep a root reference outside of a UObject graph, but prefer `addToRoot()` generally.37 * Understand the `IsValid()` check vs `nullptr`. `IsValid()` handles pending kill state safely.38392. **Unreal Reflection System**:40 * Use `UCLASS()`, `USTRUCT()`, `UENUM()`, `UFUNCTION()` to expose types to the reflection system and Blueprints.41 * Minimize `BlueprintReadWrite` when possible; prefer `BlueprintReadOnly` for state that shouldn't be trampled by logic in UI/Level BPs.42433. **Performance First**:44 * **Tick**: Disable Ticking (`bCanEverTick = false`) by default. Only enable it if absolutely necessary. Prefer timers (`GetWorldTimerManager()`) or event-driven logic.45 * **Casting**: Avoid `Cast<T>()` in hot loops. Cache references in `BeginPlay`.46 * **Structs vs Classes**: Use `F` structs for data-heavy, non-UObject types to reduce overhead.4748## Naming Conventions (Strict)4950Follow Epic Games' coding standard:5152* **Templates**: Prefix with `T` (e.g., `TArray`, `TMap`).53* **UObject**: Prefix with `U` (e.g., `UCharacterMovementComponent`).54* **AActor**: Prefix with `A` (e.g., `AMyGameMode`).55* **SWidget**: Prefix with `S` (Slate widgets).56* **Structs**: Prefix with `F` (e.g., `FVector`).57* **Enums**: Prefix with `E` (e.g., `EWeaponState`).58* **Interfaces**: Prefix with `I` (e.g., `IInteractable`).59* **Booleans**: Prefix with `b` (e.g., `bIsDead`).6061## Common Patterns6263### 1. Robust Component Lookup64Avoid `GetComponentByClass` in `Tick`. Do it in `PostInitializeComponents` or `BeginPlay`.6566```cpp67void AMyCharacter::PostInitializeComponents() {68 Super::PostInitializeComponents();69 HealthComp = FindComponentByClass<UHealthComponent>();70 check(HealthComp); // Fail hard in dev if missing71}72```7374### 2. Interface Implementation75Use interfaces to decouple systems (e.g., Interaction system).7677```cpp78// Interface call check79if (TargetActor->Implements<UInteractable>()) {80 IInteractable::Execute_OnInteract(TargetActor, this);81}82```8384### 3. Async Loading (Soft References)85Avoid hard references (`UPROPERTY(EditDefaultsOnly) TSubclassOf<AActor>`) for massive assets which force load orders. Use `TSoftClassPtr` or `TSoftObjectPtr`.8687```cpp88UPROPERTY(EditAnywhere, BlueprintReadWrite)89TSoftClassPtr<AWeapon> WeaponClassToLoad;9091void AMyCharacter::Equip() {92 if (WeaponClassToLoad.IsPending()) {93 WeaponClassToLoad.LoadSynchronous(); // Or use StreamableManager for async94 }95}96```9798## Debugging99100* **Logging**: Use `UE_LOG` with custom categories.101 ```cpp102 DEFINE_LOG_CATEGORY_STATIC(LogMyGame, Log, All);103 UE_LOG(LogMyGame, Warning, TEXT("Health is low: %f"), CurrentHealth);104 ```105* **Screen Messages**:106 ```cpp107 if (GEngine) GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Red, TEXT("Died!"));108 ```109* **Visual Logger**: extremely useful for AI debugging. Implement `IVisualLoggerDebugSnapshotInterface`.110111## Checklist before PR112113- [ ] Does this Actor need to Tick? Can it be a Timer?114- [ ] Are all `UObject*` members wrapped in `UPROPERTY`?115- [ ] Are hard references (TSubclassOf) causing load chains? Can they be Soft Ptrs?116- [ ] Did you clean up verified delegates in `EndPlay`?