UEngine::AddOnScreenDebugMessage

Add a [FString](API\Runtime\Core\Containers\FString) to the On-screen debug message system.

Choose your operating system:

Windows

macOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Engine/Engine.h
Include	#include "Engine/Engine.h"
Source	/Engine/Source/Runtime/Engine/Private/UnrealEngine.cpp

Syntax

void AddOnScreenDebugMessage
(
    uint64 Key,
    float TimeToDisplay,
    FColor DisplayColor,
    const FString & DebugMessage,
    bool bNewerOnTop,
    const FVector2D & TextScale
)

Remarks

Add a FString to the On-screen debug message system. bNewerOnTop only works with Key == INDEX_NONE

This function will add a debug message to the onscreen message list. It will be displayed for FrameCount frames.

Parameters

Parameter	Description
Key	A unique key to prevent the same message from being added multiple times.
TimeToDisplay	How long to display the message, in seconds.
DisplayColor	The color to display the text in.
DebugMessage	The message to display.