Navigation
API > API/Runtime > API/Runtime/Core
| Name | FMessageLog |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Logging/MessageLog.h |
| Include Path | #include "Logging/MessageLog.h" |
Syntax
class FMessageLog
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMessageLog
(
const FName& InLogName |
Constructor | Logging/MessageLog.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FMessageLog() |
Destructor When this object goes out of scope, its buffered messages will be flushed. | Logging/MessageLog.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FGetLog | TBaseDelegate_OneParam< TSharedRef< class IMessageLog >, const FName & > | Delegate to retrieve a log interface. | Logging/MessageLog.h |
| FMessageSelectionChanged | TBaseDelegate_OneParam< void, TArray< TSharedRef< FTokenizedMessage > > & > | Delegate used when message selection changes. | Logging/MessageLog.h |
| FMultiSelectActorBegin | TBaseDelegate_NoParams< void > | Delegates for multi-select of message token actors | Logging/MessageLog.h |
| FMultiSelectActorEnd | TBaseDelegate_NoParams< void > | Logging/MessageLog.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| GetLog | FGetLog | Delegate for retrieving the message log | Logging/MessageLog.h |
| MessageSelectionChanged | FMessageSelectionChanged | Delegate for message selection | Logging/MessageLog.h |
| MultiSelectActorBegin | FMultiSelectActorBegin | Delegates for multi-select of message token actors | Logging/MessageLog.h |
| MultiSelectActorEnd | FMultiSelectActorEnd | Logging/MessageLog.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bSuppressLoggingToOutputLog | bool | Do we want to suppress logging to the output log in addition to the message log? | Logging/MessageLog.h | |
| LogName | FName | Name of this message log | Logging/MessageLog.h | |
| MessageLog | TSharedPtr< class IMessageLog > | The message log we use for output | Logging/MessageLog.h | |
| Messages | TArray< TSharedRef< FTokenizedMessage > > | Buffer for messages | Logging/MessageLog.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const TSharedRef< FTokenizedMessage > & AddMessage
(
const TSharedRef< FTokenizedMessage >& InMessage |
Add a message to the log. | Logging/MessageLog.h | |
void AddMessages
(
const TArray< TSharedRef< FTokenizedMessage > >& InMessages |
Add an array of messages to the message log | Logging/MessageLog.h | |
TSharedRef< FTokenizedMessage > CriticalError
(
const FText& InMessage |
Logging/MessageLog.h | ||
TSharedRef< FTokenizedMessage > Error
(
const FText& InMessage |
Logging/MessageLog.h | ||
void Flush() |
Send the currently buffered messages to the log & clear the buffer | Logging/MessageLog.h | |
TSharedRef< FTokenizedMessage > Info
(
const FText& InMessage |
Logging/MessageLog.h | ||
TSharedRef< FTokenizedMessage > Message
(
EMessageSeverity::Type InSeverity, |
Helper functions to allow easy adding of messages to the log. | Logging/MessageLog.h | |
| Add a new page to the log. | Logging/MessageLog.h | ||
void Notify
(
const FText& InMessage, |
Notify the user with a message if there are messages present. | Logging/MessageLog.h | |
int32 NumMessages
(
EMessageSeverity::Type InSeverityFilter |
Check whether there are any messages present for this log. | Logging/MessageLog.h | |
void Open
(
EMessageSeverity::Type InSeverityFilter, |
Opens the log for display to the user given certain conditions. | Logging/MessageLog.h | |
TSharedRef< FTokenizedMessage > PerformanceWarning
(
const FText& InMessage |
Logging/MessageLog.h | ||
void SetCurrentPage
(
const FText& InLabel |
Sets the current page to the one specified by the label. | Logging/MessageLog.h | |
FMessageLog & SuppressLoggingToOutputLog
(
bool bShouldSuppress |
Should we mirror message log messages from this instance to the output log during flush? | Logging/MessageLog.h | |
TSharedRef< FTokenizedMessage > Warning
(
const FText& InMessage |
Logging/MessageLog.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const TCHAR *const GetLogColor
(
EMessageSeverity::Type InSeverity |
Helper function to retrieve a log color for a specified message severity | Logging/MessageLog.h | |
static ELogVerbosity::Type GetLogVerbosity
(
EMessageSeverity::Type InSeverity |
Helper function to convert message log severity to log verbosity | Logging/MessageLog.h | |
static FGetLog & OnGetLog() |
Logging/MessageLog.h | ||
static FMessageSelectionChanged & OnMessageSelectionChanged() |
Logging/MessageLog.h | ||
static FMultiSelectActorBegin & OnMultiSelectActorBegin() |
Logging/MessageLog.h | ||
static FMultiSelectActorEnd & OnMultiSelectActorEnd() |
Logging/MessageLog.h |