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 > API/Developer/MessageLog/Model

Inheritance Hierarchy

References

   
Module MessageLog
Header /Engine/Source/Developer/MessageLog/Public/Model/MessageLogListingModel.h
Include #include "Model/MessageLogListingModel.h"

Syntax

class FMessageLogListingModel : public TSharedFromThis< FMessageLogListingModel >

Remarks

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

Constructors

No constructors are accessible with public or protected access.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

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

 Appends a message
Public function void

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

 Appends multiple messages
Public function Static bool

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

 Helper function for RemoveDuplicates(), exposed so the ViewModel can use it too
Public function void Clears all messages
Public function Static TSharedRef< FMessageLogListingModel >

Create ( const FName& InLogName
)

 Factory method which creates a new FMessageLogListingModel object
Protected function void Create a new page if we have one pending
Protected function Const FPage & Access the current page (we only add messages to this page
Public function Const FString

GetAllMessagesAsString ( const uint32 PageIndex
)

 Gets all messages as a string
Public function Const const TSharedPtr< FTokenizedMessage >

GetMessageAtIndex ( const uint32 PageIndex,
const int32 MessageIndex
)

 Returns the message at the specified index
Public function Const MessageContainer::TConstIterator

GetMessageIterator ( uint32 PageIndex
)

 Obtains a const iterator to the message data structure
Public function Const const FName &

GetName ()

 Retrieves the name identifier for this log listing
Public function Const const FText &

GetPageTitle ( const uint32 PageIndex
)

 Get the title of the page at the specified index
Public function void

NewPage ( const FText& InTitle,
uint32 InMaxPages
)

 Add a new page.
Protected function Virtual void

Notify ()

 Will broadcast to all registered observers informing them of a change
Public function Const uint32

NumMessages ( uint32 PageIndex
)

 Get the number of messages on the passed-in page
Public function Const uint32 Get the number of pages contained in this log
Public function FMessageLogListingModel::FChangedEvent TBaseMulticastDelegate_NoParams  
Protected function Const FPage *

PageAtIndex ( const uint32 PageIndex
)

 Get a page by index - uses cache to speed up linked list access
Public function void

RemoveDuplicates ( uint32 PageIndex
)

 Remove any messages that are duplicates of one another - O(n)
Public function int32

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

 Replaces the message at the given index
Public function bool

SetCurrentPage ( const uint32 InOldPageIndex
)

 Sets the current page to the one specified by the index.
Public function bool

SetCurrentPage ( const FText& InTitle,
uint32 InMaxPages
)

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

Classes

  Type Name Description
Public class FChangedEvent Broadcasts whenever the message log listing changes  
Protected struct FPage    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page