Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > UnrealEd > Kismet2 > FCompilerResultsLog

Light Theme

Dark Theme

FCompilerResultsLog

This class represents a log of compiler output lines (errors, warnings, and information notes), each of which can be a rich tokenized message

Windows

MacOS

Linux

References

Module	UnrealEd
Header	/Engine/Source/Editor/UnrealEd/Public/Kismet2/CompilerResultsLog.h
Include	#include "Kismet2/CompilerResultsLog.h"

Syntax

class FCompilerResultsLog

Remarks

This class represents a log of compiler output lines (errors, warnings, and information notes), each of which can be a rich tokenized message

Variables

	Name	Description
TSet< TWeakObje...	AnnotatedNodes	Tracks nodes that produced errors/warnings
bool	bAnnotateMentionedNodes	Should nodes mentioned in messages be annotated for display with that message?
bool	bLogDetailedResults	Should detailed results be appended to the final summary log?
bool	bLogInfoOnly	Should we log only Info messages, or all messages?
bool	bSilentMode	Should we be silent?
int	EventDisplayThresholdMs	Minimum event time (ms) for inclusion into the final summary log.
TMap< TWeakObje...	FullMacroBacktrackMap	Map to track intermediate nodes back to the source macro instance nodes.
TMap< TWeakObje...	IntermediateTunnelNodeToTunnelInstanceMap	Map to track intermediate tunnel nodes back to the intermediate expansion tunnel instance.
TArray< TShared...	Messages	List of all tokenized messages.
int32	NumErrors	Number of error messages.
int32	NumWarnings	Number of warnings.
FBacktrackMap	SourceBacktrackMap	Maps from transient object created during compiling to original 'source code' object.
FString	SourcePath	Name of the source object being compiled.

Constructors

	Name	Description
	FCompilerResultsLog ( bool bIsCompatibleWithEvents )

Destructors

	Name	Description
	~FCompilerResultsLog()

Functions

	Name	Description
void	AddChildEvent ( TSharedPtr< FCompilerEvent >& Pare..., TSharedRef< FCompilerEvent >& Chil... )	Helper method to add a child event to the given parent event scope
void	AddTokenizedMessage ( TSharedRef< FTokenizedMessage > InM... )	Store an already tokenized message.
void	AnnotateNode ( const TArray< UEdGraphNode* > ..., TSharedRef< FTokenizedMessage > Log... )	Links the UEdGraphNode with the LogLine:
void	Append ( FCompilerResultsLog const& Other )
void	BeginEvent ( const TCHAR* InName )	Begin a new compiler event
int32	CalculateStableIdentifierForLatentActionManager ( const UEdGraphNode* Node )	Returns a int32 used to uniquely identify an action for the latent action manager
bool	CommitPotentialMessages ( UEdGraphNode* Source )	Commit all stored potential messages for a given node. Returns true if any messages were written.
void	EndEvent()	End the current compiler event
TSharedRef< ...	Error ( const TCHAR* Format, Args... args )	Write an error in to the compiler log.
UObject *...	FindSourceMacroInstance ( const UEdGraphNode* Intermedia... )
UObject cons...	FindSourceObject ( UObject const* PossiblyDuplica... )	Returns the true source object for the passed in object
UObject *...	FindSourceObject ( UObject* PossiblyDuplicatedObj... )	Returns the true source object for the passed in object
T const *...	FindSourceObjectTypeChecked ( UObject const* PossiblyDuplica... )
T *	FindSourceObjectTypeChecked ( UObject* PossiblyDuplicatedObj... )	Returns the true source object for the passed in object; does type checking on the result
const UEdGra...	FindSourcePin ( const UEdGraphPin* PossiblyDup... )
UEdGraphPin ...	FindSourcePin ( UEdGraphPin* PossiblyDuplicate... )
TSharedRef< ...	GetBlueprintMessageLog ( UBlueprint* InBlueprint )	Get the message log listing for this blueprint
FCompilerRes...	GetEventTarget()	Access the current event target log
const UEdGra...	GetIntermediateTunnelInstance ( const UEdGraphNode* Intermedia... )	Returns the intermediate tunnel instance that generated the node
FName	GetLogName()	Accessor for the LogName, so it can be opened elsewhere
void	InternalLogEvent ( const FCompilerEvent& InEvent, int32 InDepth )	Internal helper method to recursively append event details into the MessageLog
void	InternalLogMessage ( FName MessageID, const TCHAR* Format, const TSharedRef< FTokenizedMessage..., Args... args )
void	InternalLogMessage ( FName MessageID, const TSharedRef< FTokenizedMessage..., const TArray< UEdGraphNode* > ... )
void	InternalLogSummary()	Internal method to append the final compiler results summary to the MessageLog
bool	IsMessageEnabled ( FName ID )	Returns true if the user has requested this compiler message be suppressed
TSharedRef< ...	Note ( const TCHAR* Format, Args... args )	Write a
void	NotifyIntermediateMacroNode ( UEdGraphNode* SourceNode, const UEdGraphNode* Intermedia... )	Update the map that tracks nodes created by macro instance nodes
void	NotifyIntermediateObjectCreation ( UObject* NewObject, UObject* SourceObject )	Update the source backtrack map to
void	NotifyIntermediatePinCreation ( UEdGraphPin* NewObject, UEdGraphPin* SourceObject )
void	NotifyIntermediateTunnelNode ( const UEdGraphNode* Node, const UEdGraphNode* OuterTunne... )	Update the expansion map to
void	Register()	Register this log with the MessageLog module
void	SetSourcePath ( const FString& InSourcePath )	Set the source name for the final log summary
TSharedRef< ...	StorePotentialError ( const UEdGraphNode* Source, const TCHAR* Format, Args... args )	Store a potential error for a given node in the compiler log.
TSharedRef< ...	StorePotentialNote ( const UEdGraphNode* Source, const TCHAR* Format, Args... args )	Store a potential
TSharedRef< ...	StorePotentialWarning ( const UEdGraphNode* Source, const TCHAR* Format, Args... args )	Store a potential warning for a given node in the compiler log.
void	Tokenize ( const TCHAR* Text, FTokenizedMessage& OutMessage, TArray< UEdGraphNode* >& OutS... )
void	Tokenize ( const TCHAR* Format, FTokenizedMessage& OutMessage, TArray< UEdGraphNode* >& OutS..., T First, Args... Rest )
void	Unregister()	Unregister this log from the MessageLog module
TSharedRef< ...	Warning ( const TCHAR* Format, Args... args )	Write a warning in to the compiler log.
void	Warning ( FName ID, const TCHAR* Format, Args... args )	Write a warning in to the compiler log.

Constants

Name	Description
CurrentEventTarget	The log target for compile events
GetGlobalModuleCompilerDumpDelegateHandle	Handle to the registered GetGlobalModuleCompilerDump delegate.
Name	The log's name, for easy re-use

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss