AHUD::AddDebugText

Add debug text for a specific actor to be displayed via [DrawDebugTextList()](API\Runtime\Engine\GameFramework\AHUD\DrawDebugTextList).

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/GameFramework/HUD.h

Include

#include "GameFramework/HUD.h"

Syntax

void AddDebugText
(
    const FString & DebugText,
    AActor * SrcActor,
    float Duration,
    FVector Offset,
    FVector DesiredOffset,
    FColor TextColor,
    bool bSkipOverwriteCheck,
    bool bAbsoluteLocation,
    bool bKeepAttachedToActor,
    UFont * InFont,
    float FontScale,
    bool bDrawShadow
)

Remarks

Add debug text for a specific actor to be displayed via DrawDebugTextList(). If the debug text is invalid then it will attempt to remove any previous entries via RemoveDebugText().

Parameters

Parameter

Description

DebugText

Text to draw

SrcActor

Actor to which this relates

Duration

Duration to display the string

Offset

Initial offset to render text

DesiredOffset

Desired offset to render text - the text will move to this location over the given duration

TextColor

Color of text to render

bSkipOverwriteCheck

skips the check to see if there is already debug text for the given actor

bAbsoluteLocation

use an absolute world location

bKeepAttachedToActor

if this is true the text will follow the actor, otherwise it will be drawn at the location when the call was made

InFont

font to use

FontScale

scale

bDrawShadow

Draw shadow on this string
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss