IMessageLog

A message log.

Windows
MacOS
Linux

Inheritance Hierarchy

IMessageLog

IMessageLogListing

References

Module

Core

Header

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

Include

#include "Logging/IMessageLog.h"

Syntax

class IMessageLog

Remarks

A message log. Message logs can be written to from any module, incorporating rich tokenized information as well as text. Messages will be displayed to the standard log and the rich MessageLogListing if it is available.

Destructors

Name Description

Public function Virtual

~IMessageLog()

Virtual destructor

Functions

Name Description

Public function

void

 

AddMessage

(
    const TSharedRef< class FTokenizedM...,
    bool bMirrorToOutputLog
)

Appends a single message

Public function

void

 

AddMessages

(
    const TArray< TSharedRef< class FTo...,
    bool bMirrorToOutputLog
)

Appends multiple messages

Public function

void

 

NewPage

(
    const FText& Title
)

Adds a new page to the log.

Public function

void

 

NotifyIfAnyMessages

(
    const FText& Message,
    EMessageSeverity::Type SeverityFilt...,
    bool bForce
)

Notify the user if there are any messages on the current page for this log.

Public function

int32

 

NumMessages

(
    EMessageSeverity::Type SeverityFilt...
)

Checks to see if there are any messages according to the passed-in severity

Public function

void

 

Open()

Opens up the message log to this listing.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss