RealDocs

UAnimInstance::DisplayDebugInstance

function Engine Since 4.0
#include "Animation/AnimInstance.h"
Access: public Specifiers: virtualENGINE_API

Description

Draws per-instance debug information as part of the animation debug hierarchy. Called by the debug display system to show this specific anim instance's state within the overall animation debug tree.

Caveats & Gotchas

  • Only called in non-shipping builds. This is an internal debug callback — override DisplayDebug for top-level custom debug output instead.
  • The Indent parameter controls hierarchical nesting. Increase it before drawing child information and restore it afterward to maintain proper formatting.

Signature

virtual void DisplayDebugInstance(FDisplayDebugManager& DisplayManager, float& Indent)

Parameters

Name Type Description Default
DisplayManager FDisplayDebugManager& The debug display manager used to draw text strings.
Indent float& Current indentation level for nested debug output.

Return Type

void

Example

Add instance-level debug info C++
void UMyAnimInstance::DisplayDebugInstance(FDisplayDebugManager& DisplayManager, float& Indent)
{
	Super::DisplayDebugInstance(DisplayManager, Indent);
	Indent += 4.f;
	DisplayManager.DrawString(FString::Printf(TEXT("Custom State: %s"), *StateName));
	Indent -= 4.f;
}

Version History

Introduced in: 4.0

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.