FBasicMessageLog Class Reference

Inheritance diagram for FBasicMessageLog:

Public Member Functions
	FBasicMessageLog (const FName &InLogName)
virtual void	AddMessage (const TSharedRef< FTokenizedMessage > &NewMessage, bool bMirrorToOutputLog) override
virtual void	AddMessages (const TArray< TSharedRef< FTokenizedMessage > > &NewMessages, bool bMirrorToOutputLog) override
virtual void	NewPage (const FText &Title) override
virtual void	SetCurrentPage (const FText &Title) override
virtual void	SetCurrentPage (const uint32 PageIndex) override
virtual void	NotifyIfAnyMessages (const FText &Message, EMessageSeverity::Type SeverityFilter, bool bForce) override
virtual void	Open () override
virtual int32	NumMessages (EMessageSeverity::Type SeverityFilter) override
Public Member Functions inherited from IMessageLog
virtual	~IMessageLog ()
Public Member Functions inherited from TSharedFromThis< FBasicMessageLog >
TSharedRef< FBasicMessageLog, Mode >	AsShared ()
TSharedRef< FBasicMessageLog const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FBasicMessageLog, Mode >	AsWeak ()
TWeakPtr< FBasicMessageLog const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< FBasicMessageLog >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
Static Protected Member Functions inherited from TSharedFromThis< FBasicMessageLog >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Constructor & Destructor Documentation

FBasicMessageLog()

FBasicMessageLog::FBasicMessageLog ( const FName &  InLogName )

inline

Member Function Documentation

AddMessage()

virtual void FBasicMessageLog::AddMessage ( const TSharedRef< FTokenizedMessage > &  NewMessage, bool  bMirrorToOutputLog  )

inlineoverridevirtual

Begin IMessageLog interface

Implements IMessageLog.

AddMessages()

virtual void FBasicMessageLog::AddMessages ( const TArray< TSharedRef< FTokenizedMessage > > &  NewMessages, bool  bMirrorToOutputLog  )

inlineoverridevirtual

Appends multiple messages

Parameters

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

Implements IMessageLog.

NewPage()

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

inlineoverridevirtual

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

Implements IMessageLog.

NotifyIfAnyMessages()

virtual void FBasicMessageLog::NotifyIfAnyMessages ( const FText &  Message, EMessageSeverity::Type  SeverityFilter, bool  bForce  )

inlineoverridevirtual

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.

Implements IMessageLog.

NumMessages()

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

inlineoverridevirtual

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

Implements IMessageLog.

Open()

virtual void FBasicMessageLog::Open ( )

inlineoverridevirtual

Opens up the message log to this listing.

Implements IMessageLog.

SetCurrentPage() [1/2]

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

inlineoverridevirtual

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

Parameters

Title

the title of the page to switch to

Implements IMessageLog.

SetCurrentPage() [2/2]

virtual void FBasicMessageLog::SetCurrentPage ( const uint32  InOldPageIndex )

inlineoverridevirtual

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.

Implements IMessageLog.

---

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

• Engine/Source/Runtime/Core/Private/Logging/MessageLog.cpp