IDefinitionProvider | Unreal Engine 5.7 Documentation

API > API/Developer > API/Developer/TraceServices

Allows users to publish "definitions", structs representing a definition event. This data can then be queried when resolving a reference field in another event.

If your definition type reference other definitions it is encouraged to resolve those during analysis to avoid having to resolve complex chains on every lookup. Example usage: This code creates a definition, initializes the instance, resolves a reference and finally registers it. FMyDefinitionClass*Instance=DefinitionProvider->Create();Instance->SomeValue=EventData.GetValue("SomeValue");constFEventRef Reference=EventData.GetReferenceValue("SomeString");Instance->SomeString=DefinitionProvider->Get(Reference)->Display;...constUE::Trace::FEventRefId(EventData.GetDefinitionId(),EventData.GetTypeInfo().GetId());DefinitionProvider->Register(Instance,Id);


Name	IDefinitionProvider
Type	class
Header File	/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/Definitions.h
Include Path	#include "TraceServices/Model/Definitions.h"

Syntax

class IDefinitionProvider :  
    public TraceServices::IProvider ,  
    public TraceServices::IEditableProvider

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~IDefinitionProvider()		TraceServices/Model/Definitions.h

Typedefs

Name	Type	Remarks	Include Path
StringifierFn	TFunction< FString(const void *)>		TraceServices/Model/Definitions.h

Functions

Public

Name	Remarks	Include Path
T * Create ()	Allocates memory for the definition.	TraceServices/Model/Definitions.h
const T * Get ( const UE::Trace::TEventRef< DefinitionType >& Reference ) const	Attempts to retrieve a previously registered instance of a definition using a reference.	TraceServices/Model/Definitions.h
FString GetAsString ( const UE::Trace::TEventRef< DefinitionType >& Reference ) const	Gets the definition as a owned string.	TraceServices/Model/Definitions.h
void Register ( const T* Instance, const UE::Trace::TEventRef< DefinitionType >& Id )	Makes the instance of a definition visible to queries.	TraceServices/Model/Definitions.h

Protected

Name	Remarks	Include Path	Unreal Specifiers
void AddEntry ( uint64 Hash, const void* Ptr )		TraceServices/Model/Definitions.h
void * Allocate ( uint32 Size, uint32 Alignment )		TraceServices/Model/Definitions.h
const void * FindEntry ( uint64 Hash ) const		TraceServices/Model/Definitions.h