1. Epic GamesDeveloper
  3. FCompilerResultsLog

FCompilerResultsLog

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

API > API/Editor > API/Editor/UnrealEd

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

   
Name FCompilerResultsLog
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/Kismet2/CompilerResultsLog.h
Include Path #include "Kismet2/CompilerResultsLog.h"

Syntax

class FCompilerResultsLog

Constructors

Name Remarks Include Path Unreal Specifiers

FCompilerResultsLog ( bool bIsCompatibleWithEvents
)

   Kismet2/CompilerResultsLog.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FCompilerResultsLog()

   Kismet2/CompilerResultsLog.h  

Structs

Name Remarks
FCompilerEvent Compiler event.

Constants

Name Type Remarks Include Path
GetGlobalModuleCompilerDumpDelegateHandle FDelegateHandle Handle to the registered GetGlobalModuleCompilerDump delegate. Kismet2/CompilerResultsLog.h
Name const FName The log's name, for easy re-use Kismet2/CompilerResultsLog.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AnnotatedNodes TSet< TWeakObjectPtr< UEdGraphNode > > Tracks nodes that produced errors/warnings Kismet2/CompilerResultsLog.h  
bAnnotateMentionedNodes bool Should nodes mentioned in messages be annotated for display with that message? Kismet2/CompilerResultsLog.h  
bLogDetailedResults bool Should detailed BeginEvent/EndEvent timing information be written to log. Kismet2/CompilerResultsLog.h  
bLogInfoOnly bool Should we log only Info messages, or all messages? Kismet2/CompilerResultsLog.h  
bSilentMode bool Should we be silent? Kismet2/CompilerResultsLog.h  
EventDisplayThresholdMs int Minimum event time (ms) for events include in detailed results. Kismet2/CompilerResultsLog.h  
Messages TArray< TSharedRef< FTokenizedMessage > > List of all tokenized messages. Kismet2/CompilerResultsLog.h  
NumErrors int32 Number of error messages. Kismet2/CompilerResultsLog.h  
NumWarnings int32 Number of warnings. Kismet2/CompilerResultsLog.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
CurrentEventScope TSharedPtr< FCompilerEvent > Current compiler event scope. Kismet2/CompilerResultsLog.h  
PotentialMessages TMap< FObjectKey, TArray< TSharedRef< FTokenizedMessage > > > Map of stored potential messages indexed by a node. Kismet2/CompilerResultsLog.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddTokenizedMessage ( TSharedRef< FTokenizedMessage > InMessage
)

 Store an already tokenized message. Kismet2/CompilerResultsLog.h  

void Append ( FCompilerResultsLog const& Other,
bool bWriteToSystemLog
)

 Copy errors from an existing log into this one, and optionally write out to log if it was suppressed the first time Kismet2/CompilerResultsLog.h  

void BeginEvent ( const TCHAR* InName
)

 Begin a new compiler event Kismet2/CompilerResultsLog.h  

int32 CalculateStableIdentifierForLatentActionManager ( const UEdGraphNode* Node
)

 Returns a int32 used to uniquely identify an action for the latent action manager Kismet2/CompilerResultsLog.h  

bool CommitPotentialMessages ( UEdGraphNode* Source
)

 Commit all stored potential messages for a given node. Returns true if any messages were written. Kismet2/CompilerResultsLog.h  

void EndEvent()

 End the current compiler event Kismet2/CompilerResultsLog.h  

TSharedRef< FTokenizedMessage > Error ( const TCHAR* Format,
ArgTypes... Args
)

 Write an error in to the compiler log. Kismet2/CompilerResultsLog.h  

UObject * FindSourceMacroInstance ( const UEdGraphNode* IntermediateNode
) const

   Kismet2/CompilerResultsLog.h  

UObject * FindSourceObject ( UObject* PossiblyDuplicatedObject
)

 Returns the true source object for the passed in object Kismet2/CompilerResultsLog.h  

UObject const * FindSourceObject ( UObject const* PossiblyDuplicatedObject
) const

   Kismet2/CompilerResultsLog.h  

T * FindSourceObjectTypeChecked ( UObject* PossiblyDuplicatedObject
)

 Returns the true source object for the passed in object; does type checking on the result Kismet2/CompilerResultsLog.h  

T const * FindSourceObjectTypeChecked ( UObject const* PossiblyDuplicatedObject
) const

   Kismet2/CompilerResultsLog.h  

UEdGraphPin * FindSourcePin ( UEdGraphPin* PossiblyDuplicatedPin
)

   Kismet2/CompilerResultsLog.h  

const UEdGraphPin * FindSourcePin ( const UEdGraphPin* PossiblyDuplicatedPin
) const

   Kismet2/CompilerResultsLog.h  

const UEdGraphNode * GetIntermediateTunnelInstance ( const UEdGraphNode* IntermediateNode
) const

 Returns the intermediate tunnel instance that generated the node Kismet2/CompilerResultsLog.h  

TSharedRef< FTokenizedMessage > Note ( const TCHAR* Format,
ArgTypes... Args
)

 Write a note in to the compiler log. Kismet2/CompilerResultsLog.h  

void NotifyIntermediateMacroNode ( UEdGraphNode* SourceNode,
const UEdGraphNode* IntermediateNode
)

 Update the map that tracks nodes created by macro instance nodes Kismet2/CompilerResultsLog.h  

void NotifyIntermediateObjectCreation ( UObject* NewObject,
UObject* SourceObject
)

 Update the source backtrack map to note that NewObject was most closely generated/caused by the SourceObject Kismet2/CompilerResultsLog.h  

void NotifyIntermediatePinCreation ( UEdGraphPin* NewObject,
UEdGraphPin* SourceObject
)

   Kismet2/CompilerResultsLog.h  

void NotifyIntermediateTunnelNode ( const UEdGraphNode* Node,
const UEdGraphNode* OuterTunnelInstance
)

 Update the expansion map to note that Node was expanded from OuterTunnelInstance, both the node and tunnel instance should be intermediate nodes Kismet2/CompilerResultsLog.h  

void SetSilentMode ( bool bValue
)

 ICompilerResultsLog implementation Kismet2/CompilerResultsLog.h  

void SetSourcePath ( const FString& InSourcePath
)

 Set the source name for the final log summary Kismet2/CompilerResultsLog.h  

TSharedRef< FTokenizedMessage > StorePotentialError ( const UEdGraphNode* Source,
const TCHAR* Format,
ArgTypes... Args
)

 Store a potential error for a given node in the compiler log. Kismet2/CompilerResultsLog.h  

TSharedRef< FTokenizedMessage > StorePotentialNote ( const UEdGraphNode* Source,
const TCHAR* Format,
ArgTypes... Args
)

 Store a potential note for a given node in the compiler log. Kismet2/CompilerResultsLog.h  

TSharedRef< FTokenizedMessage > StorePotentialWarning ( const UEdGraphNode* Source,
const TCHAR* Format,
ArgTypes... Args
)

 Store a potential warning for a given node in the compiler log. Kismet2/CompilerResultsLog.h  

TSharedRef< FTokenizedMessage > Warning ( const TCHAR* Format,
ArgTypes... Args
)

 Write a warning in to the compiler log. Kismet2/CompilerResultsLog.h  

void Warning ( FName ID,
const TCHAR* Format,
ArgTypes... Args
)

 Write a warning in to the compiler log. Kismet2/CompilerResultsLog.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AddChildEvent ( TSharedPtr< FCompilerEvent >& ParentEventScope,
TSharedRef< FCompilerEvent >& ChildEventScope
)

 Helper method to add a child event to the given parent event scope Kismet2/CompilerResultsLog.h  

void AnnotateNode ( const TArray< UEdGraphNode* >& Nodes,
TSharedRef< FTokenizedMessage > LogLine
)

 Links the UEdGraphNode with the LogLine: Kismet2/CompilerResultsLog.h  

void FEdGraphToken_Create ( const TCHAR* String,
FTokenizedMessage& OutMessage,
TArray< UEdGraphNode* >& OutSourceNodes
)

   Kismet2/CompilerResultsLog.h  

void FEdGraphToken_Create ( const FField* InField,
FTokenizedMessage& OutMessage,
TArray< UEdGraphNode* >& OutSourceNodes
)

   Kismet2/CompilerResultsLog.h  

void FEdGraphToken_Create ( const UEdGraphPin* InPin,
FTokenizedMessage& OutMessage,
TArray< UEdGraphNode* >& OutSourceNodes
)

   Kismet2/CompilerResultsLog.h  

void FEdGraphToken_Create ( const UObject* InObject,
FTokenizedMessage& OutMessage,
TArray< UEdGraphNode* >& OutSourceNodes
)

   Kismet2/CompilerResultsLog.h  

void IncrementErrorCount()

   Kismet2/CompilerResultsLog.h  

void IncrementWarningCount()

   Kismet2/CompilerResultsLog.h  

void InternalLogEvent ( const FCompilerEvent& InEvent,
int32 InDepth
)

 Internal helper method to recursively append event details into the MessageLog Kismet2/CompilerResultsLog.h  

void InternalLogMessage ( FName MessageID,
const TSharedRef< FTokenizedMessage >& Message,
const TArray< UEdGraphNode* >& SourceNodes
)

   Kismet2/CompilerResultsLog.h  

void InternalLogMessage ( FName MessageID,
const TCHAR* Format,
const TSharedRef< FTokenizedMessage >& Message,
ArgTypes... Args
)

   Kismet2/CompilerResultsLog.h  

void InternalLogSummary()

 Internal method to append the final compiler results summary to the MessageLog Kismet2/CompilerResultsLog.h  

bool IsMessageEnabled ( FName ID
)

   Kismet2/CompilerResultsLog.h  

void Tokenize ( const TCHAR* Text,
FTokenizedMessage& OutMessage,
TArray< UEdGraphNode* >& OutSourceNode
)

   Kismet2/CompilerResultsLog.h  

void Tokenize ( const TCHAR* Format,
FTokenizedMessage& OutMessage,
TArray< UEdGraphNode* >& OutSourceNode,
T First,
ArgTypes... Rest
)

   Kismet2/CompilerResultsLog.h  

Static

Name Remarks Include Path Unreal Specifiers

static TSharedRef< IMessageLogListing > GetBlueprintMessageLog ( UBlueprint* InBlueprint
)

 Get the message log listing for this blueprint Kismet2/CompilerResultsLog.h  

static FCompilerResultsLog * GetEventTarget()

   Kismet2/CompilerResultsLog.h  

static void GetGlobalModuleCompilerDump ( const FString& LogDump,
ECompilationResult::Type CompilationResult,
bool bShowLog
)

 Callback function for binding the global compiler dump to open the static compiler log Kismet2/CompilerResultsLog.h  

static FName GetLogName()

 Accessor for the LogName, so it can be opened elsewhere Kismet2/CompilerResultsLog.h  

static void GetNodesFromTokens ( const TArray< TSharedRef< IMessageToken > >& MessageTokens,
TArray< UEdGraphNode* >& OutOwnerNodes
)

 Searches a token list for referenced UEdGraphNodes, used to update the nodes when a log is committed Kismet2/CompilerResultsLog.h  

static void OnGotoError ( const TSharedRef< IMessageToken >& Token
)

 Goes to an error given a Message Token Kismet2/CompilerResultsLog.h  

static TArray< TSharedRef< FTokenizedMessage > > ParseCompilerLogDump ( const FString& LogDump
)

 Parses a compiler log dump to generate tokenized output Kismet2/CompilerResultsLog.h  

static void Register()

 Register this log with the MessageLog module Kismet2/CompilerResultsLog.h  

static void Unregister()

 Unregister this log from the MessageLog module Kismet2/CompilerResultsLog.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page