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 > API/Editor/UnrealEd/Kismet2

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

  Type Name Description
Public variable TSet< TWeakObjectPtr< UEdGraphNode > > AnnotatedNodes Tracks nodes that produced errors/warnings
Public variable bool bAnnotateMentionedNodes Should nodes mentioned in messages be annotated for display with that message?
Public variable bool bLogDetailedResults Should detailed BeginEvent/EndEvent timing information be written to log.
Public variable bool bLogInfoOnly Should we log only Info messages, or all messages?
Public variable bool bSilentMode Should we be silent?
Public variable int EventDisplayThresholdMs Minimum event time (ms) for events include in detailed results.
Protected variable TMap< TWeakObjectPtr< const UEdGraphNode >, TWeakObjectPtr< UEdGraphNode > > FullMacroBacktrackMap Map to track intermediate nodes back to the source macro instance nodes.
Protected variable TMap< TWeakObjectPtr< const UEdGraphNode >, TWeakObjectPtr< const UEdGraphNode > > IntermediateTunnelNodeToTunnelInstanceMap Map to track intermediate tunnel nodes back to the intermediate expansion tunnel instance.
Public variable TArray< TSharedRef< FTokenizedMessage > > Messages List of all tokenized messages.
Public variable int32 NumErrors Number of error messages.
Public variable int32 NumWarnings Number of warnings.
Protected variable FBacktrackMap SourceBacktrackMap Maps from transient object created during compiling to original 'source code' object.
Protected variable FString SourcePath Name of the source object being compiled.

Constructors

  Type Name Description
Public function  

FCompilerResultsLog ( bool bIsCompatibleWithEvents
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function void

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

 Helper method to add a child event to the given parent event scope
Public function void Store an already tokenized message.
Protected function void

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

 Links the UEdGraphNode with the LogLine:
Public function 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
Public function void

BeginEvent ( const TCHAR* InName
)

 Begin a new compiler event
Public function int32 Returns a int32 used to uniquely identify an action for the latent action manager
Public function bool

CommitPotentialMessages ( UEdGraphNode* Source
)

 Commit all stored potential messages for a given node. Returns true if any messages were written.
Public function void End the current compiler event
Public function TSharedRef< FTokenizedMessage >

Error ( const TCHAR* Format,
ArgTypes... Args
)

 Write an error in to the compiler log.
Protected function void

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

  
Protected function void

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

  
Protected function void

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

  
Protected function void

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

  
Public function Const UObject *

FindSourceMacroInstance ( const UEdGraphNode* IntermediateNode
)

  
Public function UObject *

FindSourceObject ( UObject* PossiblyDuplicatedObject
)

 Returns the true source object for the passed in object
Public function Const UObject const *

FindSourceObject ( UObject const* PossiblyDuplicatedObject
)

  
Public function T *

FindSourceObjectTypeChecked ( UObject* PossiblyDuplicatedObject
)

 Returns the true source object for the passed in object; does type checking on the result
Public function Const T const *

FindSourceObjectTypeChecked ( UObject const* PossiblyDuplicatedObject
)

  
Public function UEdGraphPin *

FindSourcePin ( UEdGraphPin* PossiblyDuplicatedPin
)

  
Public function Const const UEdGraphPin *

FindSourcePin ( const UEdGraphPin* PossiblyDuplicatedPin
)

  
Public function Static TSharedRef< IMessageLogListing >

GetBlueprintMessageLog ( UBlueprint* InBlueprint
)

 Get the message log listing for this blueprint
Public function Static FCompilerResultsLog *  
Public function Const const UEdGraphNode *

GetIntermediateTunnelInstance ( const UEdGraphNode* IntermediateNode
)

 Returns the intermediate tunnel instance that generated the node
Public function Static FName Accessor for the LogName, so it can be opened elsewhere
Protected function void  
Protected function void  
Protected function void

InternalLogEvent ( const FCompilerEvent& InEvent,
int32 InDepth
)

 Internal helper method to recursively append event details into the MessageLog
Protected function void

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

  
Protected function void

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

  
Protected function void Internal method to append the final compiler results summary to the MessageLog
Protected function bool  
Public function TSharedRef< FTokenizedMessage >

Note ( const TCHAR* Format,
ArgTypes... Args
)

 Write a note in to the compiler log.
Public function void

NotifyIntermediateMacroNode ( UEdGraphNode* SourceNode,
const UEdGraphNode* IntermediateNode
)

 Update the map that tracks nodes created by macro instance nodes
Public function void

NotifyIntermediateObjectCreation ( UObject* NewObject,
UObject* SourceObject
)

 Update the source backtrack map to note that NewObject was most closely generated/caused by the SourceObject
Public function void

NotifyIntermediatePinCreation ( UEdGraphPin* NewObject,
UEdGraphPin* SourceObject
)

  
Public function 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
Public function Static void Register this log with the MessageLog module
Public function void

SetSilentMode ( bool bValue
)

 ICompilerResultsLog implementation
Public function void

SetSourcePath ( const FString& InSourcePath
)

 Set the source name for the final log summary
Public function TSharedRef< FTokenizedMessage >

StorePotentialError ( const UEdGraphNode* Source,
const TCHAR* Format,
ArgTypes... Args
)

 Store a potential error for a given node in the compiler log.
Public function TSharedRef< FTokenizedMessage >

StorePotentialNote ( const UEdGraphNode* Source,
const TCHAR* Format,
ArgTypes... Args
)

 Store a potential note for a given node in the compiler log.
Public function TSharedRef< FTokenizedMessage >

StorePotentialWarning ( const UEdGraphNode* Source,
const TCHAR* Format,
ArgTypes... Args
)

 Store a potential warning for a given node in the compiler log.
Protected function void

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

  
Protected function void

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

  
Public function Static void Unregister this log from the MessageLog module
Public function TSharedRef< FTokenizedMessage >

Warning ( const TCHAR* Format,
ArgTypes... Args
)

 Write a warning in to the compiler log.
Public function void

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

 Write a warning in to the compiler log.

Constants

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page