1. Epic GamesDeveloper
  3. FMessageLogListingModel

FMessageLogListingModel

This class represents a set of rich tokenized messages for a particular system

API > API/Developer > API/Developer/MessageLog

This class represents a set of rich tokenized messages for a particular system

   
Name FMessageLogListingModel
Type class
Header File /Engine/Source/Developer/MessageLog/Public/Model/MessageLogListingModel.h
Include Path #include "Model/MessageLogListingModel.h"

Syntax

class FMessageLogListingModel : public TSharedFromThis< FMessageLogListingModel >

Inheritance Hierarchy

  • TSharedFromThis< FMessageLogListingModel > → FMessageLogListingModel

Constructors

Name Remarks Include Path Unreal Specifiers

FMessageLogListingModel ( const FName& InLogName
)

 FMessageLogListingModel Constructor Model/MessageLogListingModel.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FMessageLogListingModel()

   Model/MessageLogListingModel.h  

Classes

Name Remarks
FChangedEvent Broadcasts whenever the message log listing changes

Structs

Name Remarks
FPage  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsPrintingToOutputLog bool Are we currently processing the output log mirror? If so, we drop any additional messages we receive, as they are duplicates. Model/MessageLogListingModel.h  
CachedPage FPage * Cached page Model/MessageLogListingModel.h  
CachedPageIndex uint32 Cached page index Model/MessageLogListingModel.h  
ChangedEvent FChangedEvent Delegate to call when data is changed Model/MessageLogListingModel.h  
LogName FName Name of the listing, for identification Model/MessageLogListingModel.h  
MaxPages uint32 The cap on the number of pages we have Model/MessageLogListingModel.h  
Pages TDoubleLinkedList< FPage > The list of pages in this log listing Model/MessageLogListingModel.h  
PendingPageName FText The name of a pending page Model/MessageLogListingModel.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddMessage ( const TSharedRef< FTokenizedMessage >& NewMessage,
bool bMirrorToOutputLog,
bool bDiscardDuplicates
)

 Appends a message Model/MessageLogListingModel.h  

void AddMessages ( const TArray< TSharedRef< FTokenizedMessage > >& NewMessages,
bool bMirrorToOutputLog,
bool bDiscardDuplicates
)

 Appends multiple messages Model/MessageLogListingModel.h  

void ClearMessages()

 Clears all messages Model/MessageLogListingModel.h  

FString GetAllMessagesAsString ( const uint32 PageIndex
) const

 Gets all messages as a string Model/MessageLogListingModel.h  

const TSharedPtr< FTokenizedMessage > GetMessageAtIndex ( const uint32 PageIndex,
const int32 MessageIndex
) const

 Returns the message at the specified index Model/MessageLogListingModel.h  

MessageContainer::TConstIterator GetMessageIterator ( uint32 PageIndex
) const

 Obtains a const iterator to the message data structure Model/MessageLogListingModel.h  

const FName & GetName()

 Retrieves the name identifier for this log listing Model/MessageLogListingModel.h  

const FText & GetPageTitle ( const uint32 PageIndex
) const

 Get the title of the page at the specified index Model/MessageLogListingModel.h  

void NewPage ( const FText& InTitle,
uint32 InMaxPages
)

 Add a new page. Model/MessageLogListingModel.h  

uint32 NumMessages ( uint32 PageIndex
) const

 Get the number of messages on the passed-in page Model/MessageLogListingModel.h  

uint32 NumPages()

 Get the number of pages contained in this log Model/MessageLogListingModel.h  

FMessageLogListingModel::FChangedEvent TBaseMulticastDelegate_NoParams OnChanged()

   Model/MessageLogListingModel.h  

void RemoveDuplicates ( uint32 PageIndex
)

 Remove any messages that are duplicates of one another - O(n) Model/MessageLogListingModel.h  

int32 ReplaceMessage ( const TSharedRef< FTokenizedMessage >& NewMessage,
const uint32 PageIndex,
const int32 MessageIndex
)

 Replaces the message at the given index Model/MessageLogListingModel.h  

bool SetCurrentPage ( const uint32 InOldPageIndex
)

 Sets the current page to the one specified by the index. Model/MessageLogListingModel.h  

bool SetCurrentPage ( const FText& InTitle,
uint32 InMaxPages
)

 Sets the current page to the one specified by the title. Model/MessageLogListingModel.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CreateNewPageIfRequired()

 Create a new page if we have one pending Model/MessageLogListingModel.h  

FPage & CurrentPage()

 Access the current page (we only add messages to this page Model/MessageLogListingModel.h  

virtual void Notify()

 Will broadcast to all registered observers informing them of a change Model/MessageLogListingModel.h  

FPage * PageAtIndex ( const uint32 PageIndex
) const

 Get a page by index - uses cache to speed up linked list access Model/MessageLogListingModel.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool AreMessagesEqual ( const TSharedRef< FTokenizedMessage >& Message0,
const TSharedRef< FTokenizedMessage >& Message1
)

 Helper function for RemoveDuplicates(), exposed so the ViewModel can use it too Model/MessageLogListingModel.h  

static TSharedRef< FMessageLogListingModel > Create ( const FName& InLogName
)

 Factory method which creates a new FMessageLogListingModel object Model/MessageLogListingModel.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page