Debugging

Resources

• Advanced Debugging in Unreal Engine
• Crashing With Style in Unreal Engine (See also Handle crashing for shipping builds)

Asserts

• check
  • Failing a check will bring up the debugger when using an IDE and cause a UE crash if not.
  • Doesn’t return the boolean.
• verify
  • Failing a verify will bring up the debugger when using an IDE and not cause a UE crash if not.
  • Doesn’t return the boolean.
• ensure
  • Failing a ensure will bring up the debugger when using an IDE and not cause a UE crash if not. It can print a custom text in the logs.
  • Returns the boolean expression you are passing in for all build types.

Engine notifications

Use FNotificationInfo with FSlateNotificationManager::Get().AddNotification(Info); Then use SetCompletionState to set the status (success, fail, …).

Snippet example (thanks to Hojo, Unreal Source Discord)

void PostNotificationInfo_Warning(FText Title, FText Description, float Duration)
{
	FNotificationInfo NotificationInfo(Title);
	NotificationInfo.ExpireDuration = Duration;
	NotificationInfo.Image = FAppStyle::GetBrush("Icons.WarningWithColor");
	NotificationInfo.SubText = Description;
	FSlateNotificationManager::Get().AddNotification(NotificationInfo);
}

To use FAppStyle you need to include SlateCore module.

You can find another simple example at UMassEntityConfigAsset::ValidateEntityConfig

Handle crashing for shipping builds

Enable Include Crash Reporter in the project settings If you want to have a more detailed call stack, you need to include the debug symbols in your build, to do so enable Include Debug Files.

More info on how to use symbols to read mini dumps in shipping builds while not shipping the debug symbols directly to the user. Time code (good for testing in a small environment)

Custom crash reporter and receive crash logs
If you want to make the user send the crash report to you (and not epic games (by default)), you can use a external tool that supports UE crash reporter (some example are Sentry, Bugsplat and Backtrace) Time code.