FMessageLog

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Logging/MessageLog.h

Include

#include "Logging/MessageLog.h"

Syntax

class FMessageLog

Constructors

Name Description

Public function

FMessageLog

(
    const FName& InLogName
)

Constructor

Destructors

Name Description

Public function

~FMessageLog()

Destructor When this object goes out of scope, its buffered messages will be flushed.

Functions

Name Description

Public function

const TShare...

 

AddMessage

(
    const TSharedRef< FTokenizedMessage...
)

Add a message to the log.

Public function

void

 

AddMessages

(
    const TArray< TSharedRef< FTokenize...
)

Add an array of messages to the message log

Public function

TSharedRef< ...

 

CriticalError

(
    const FText& InMessage
)

Public function

TSharedRef< ...

 

Error

(
    const FText& InMessage
)

Public function Static

const TCHAR ...

 

GetLogColor

(
    EMessageSeverity::Type InSeverity
)

Helper function to retrieve a log color for a specified message severity

Public function Static

ELogVerbosit...

 

GetLogVerbosity

(
    EMessageSeverity::Type InSeverity
)

Helper function to convert message log severity to log verbosity

Public function

TSharedRef< ...

 

Info

(
    const FText& InMessage
)

Public function

TSharedRef< ...

 

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 InSeverityFi...,
    bool bForce
)

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

Public function

int32

 

NumMessages

(
    EMessageSeverity::Type InSeverityFi...
)

Check whether there are any messages present for this log.

Public function Static

FGetLog &

 

OnGetLog()

Public function Static

FMessageSele...

 

OnMessageSelectionChanged()

Public function

void

 

Open

(
    EMessageSeverity::Type InSeverityFi...,
    bool bOpenEvenIfEmpty
)

Opens the log for display to the user given certain conditions.

Public function

TSharedRef< ...

 

PerformanceWarning

(
    const FText& InMessage
)

Public function

FMessageLog ...

 

SuppressLoggingToOutputLog

(
    bool bShouldSuppress
)

Should we mirror message log messages from this instance to the output log during flush?

Public function

TSharedRef< ...

 

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

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