IMessageLog Class Reference

#include <IMessageLog.h>

Inheritance diagram for IMessageLog:

Public Member Functions
virtual	~IMessageLog ()
virtual void	AddMessage (const TSharedRef< class FTokenizedMessage > &NewMessage, bool bMirrorToOutputLog=true)=0
virtual void	AddMessages (const TArray< TSharedRef< class FTokenizedMessage > > &NewMessages, bool bMirrorToOutputLog=true)=0
virtual void	NewPage (const FText &Title)=0
virtual void	SetCurrentPage (const FText &Title)=0
virtual void	SetCurrentPage (const uint32 InOldPageIndex)=0
virtual void	NotifyIfAnyMessages (const FText &Message, EMessageSeverity::Type SeverityFilter=EMessageSeverity::Info, bool bForce=false)=0
virtual void	Open ()=0
virtual int32	NumMessages (EMessageSeverity::Type SeverityFilter)=0

Detailed Description

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.

Constructor & Destructor Documentation

~IMessageLog()

virtual IMessageLog::~IMessageLog ( )

inlinevirtual

Virtual destructor

Member Function Documentation

AddMessage()

virtual void IMessageLog::AddMessage ( const TSharedRef< class FTokenizedMessage > &  NewMessage, bool  bMirrorToOutputLog = true  )

pure virtual

Appends a single message

Parameters

NewMessage	The message to append
bMirrorToOutputLog	Whether or not the message should also be mirrored to the output log

Implemented in FBasicMessageLog.

AddMessages()

virtual void IMessageLog::AddMessages ( const TArray< TSharedRef< class FTokenizedMessage > > &  NewMessages, bool  bMirrorToOutputLog = true  )

pure virtual

Appends multiple messages

Parameters

NewMessages	The messages to append.
bMirrorToOutputLog	Whether or not the messages should also be mirrored to the output log

Implemented in FBasicMessageLog.

NewPage()

virtual void IMessageLog::NewPage ( const FText &  Title )

pure virtual

Adds a new page to the log. Old pages are only kept around if they contain messages, so if the current page is empty, this call does nothing.

Parameters

Title

the title of the new page

Implemented in FBasicMessageLog.

NotifyIfAnyMessages()

virtual void IMessageLog::NotifyIfAnyMessages ( const FText &  Message, EMessageSeverity::Type  SeverityFilter = EMessageSeverity::Info, bool  bForce = false  )

pure virtual

Notify the user if there are any messages on the current page for this log. If there are no messages present, this call does nothing.

Parameters

Message	The message to display in the notification.
SeverityFilter	Notifications will only be displayed if there are messages present that are of equal or greater severity than this.
bForce	Notify anyway, even if the filters gives us no messages.

Implemented in FBasicMessageLog.

NumMessages()

virtual int32 IMessageLog::NumMessages ( EMessageSeverity::Type  SeverityFilter )

pure virtual

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

Parameters

SeverityFilter

Function will only return true if all the messages are of equal or greater severity than this.

Returns

The number of messages that pass our filter

Implemented in FBasicMessageLog.

Open()

virtual void IMessageLog::Open ( )

pure virtual

Opens up the message log to this listing.

Implemented in FBasicMessageLog.

SetCurrentPage() [1/2]

virtual void IMessageLog::SetCurrentPage ( const FText &  Title )

pure virtual

Sets the current page to the one specified by the title.

Parameters

Title

the title of the page to switch to

Implemented in FBasicMessageLog.

SetCurrentPage() [2/2]

virtual void IMessageLog::SetCurrentPage ( const uint32  InOldPageIndex )

pure virtual

Sets the current page to the one specified by the title.

Parameters

InOldPageIndex

the index of the page to switch to. This page will move to index 0.

Implemented in FBasicMessageLog.

---

The documentation for this class was generated from the following file:

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