1. Epic GamesDeveloper
  3. FMessageLog

FMessageLog

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Logging

Inheritance Hierarchy

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Logging/MessageLog.h
Include #include "Logging/MessageLog.h"

Syntax

class FMessageLog

Constructors

  Type Name Description
Public function  

FMessageLog ( const FName& InLogName
)

 Constructor

Destructors

  Type Name Description
Public function   Destructor When this object goes out of scope, its buffered messages will be flushed.

Functions

  Type Name Description
Public function const TSharedRef< FTokenizedMessage > &

AddMessage ( const TSharedRef< FTokenizedMessage >& InMessage
)

 Add a message to the log.
Public function void

AddMessages ( const TArray< TSharedRef< FTokenizedMessage > >& InMessages
)

 Add an array of messages to the message log
Public function TSharedRef< FTokenizedMessage >

Error ( const FText& InMessage
)

  
Public function Static const TCHAR *const Helper function to retrieve a log color for a specified message severity
Public function Static ELogVerbosity::Type Helper function to convert message log severity to log verbosity
Public function TSharedRef< FTokenizedMessage >

Info ( const FText& InMessage
)

  
Public function TSharedRef< FTokenizedMessage >

Message ( EMessageSeverity::Type InSeverity,
const FText& InMessage
)

 Helper functions to allow easy adding of messages to the log.
Public function void

NewPage ( const FText& InLabel
)

 Add a new page to the log.
Public function void

Notify ( const FText& InMessage,
EMessageSeverity::Type InSeverityFilter,
bool bForce
)

 Notify the user with a message if there are messages present.
Public function int32

NumMessages ( EMessageSeverity::Type InSeverityFilter
)

 Check whether there are any messages present for this log.
Public function Static FGetLog &  
Public function Static FMessageSelectionChanged &  
Public function void

Open ( EMessageSeverity::Type InSeverityFilter,
bool bOpenEvenIfEmpty
)

 Opens the log for display to the user given certain conditions.
Public function TSharedRef< FTokenizedMessage >

PerformanceWarning ( const FText& InMessage
)

  
Public function void

SetCurrentPage ( const FText& InLabel
)

 Sets the current page to the one specified by the label.
Public function FMessageLog &

SuppressLoggingToOutputLog ( bool bShouldSuppress
)

 Should we mirror message log messages from this instance to the output log during flush?
Public function TSharedRef< FTokenizedMessage >

Warning ( const FText& InMessage
)

  

Typedefs

Name Description
FGetLog Delegate to retrieve a log interface.
FMessageSelectionChanged Delegate used when message selection changes.

Constants

Name Description
GetLog Delegate for retrieving the message log
MessageSelectionChanged Delegate for message selection

Deprecated Functions

  Type Name Description
Public function TSharedRef< FTokenizedMessage >

CriticalError ( const FText& InMessage
)

 CriticalError was removed because it can't trigger an assert at the callsite. Use 'checkf' instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page