Navigation
API > API/Developer > API/Developer/MessageLog
| Name | FMessageLogModule |
| Type | class |
| Header File | /Engine/Source/Developer/MessageLog/Public/MessageLogModule.h |
| Include Path | #include "MessageLogModule.h" |
Syntax
class FMessageLogModule : public IModuleInterface
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMessageLogModule() |
MessageLogModule.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCanDisplayMessageLog | bool | Delegate used to determine whether the message log can be displayed | MessageLogModule.h | |
| MessageLogViewModel | TSharedPtr< class FMessageLogViewModel > | The one and only message log view model | MessageLogModule.h | |
| ModulesChangedHandle | FDelegateHandle | Handle to delegate called when module state changes | MessageLogModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedRef< class IMessageLogListing > CreateLogListing
(
const FName& InLogName, |
Creates a new log listing for use outside of the global MessageLog window. | MessageLogModule.h | |
virtual TSharedRef< class SWidget > CreateLogListingWidget
(
const TSharedRef< class IMessageLogListing >& InMessageLogListing |
Creates a log listing widget to view data from the passed-in listing. | MessageLogModule.h | |
virtual void EnableMessageLogDisplay
(
bool bInCanDisplayMessageLog |
Setting this to true will allow the message log to be displayed when OpenMessageLog is called. | MessageLogModule.h | |
virtual TSharedRef< class IMessageLogListing > GetLogListing
(
const FName& LogName |
Get a message log listing registered with the message log. If it does not exist it will created. | MessageLogModule.h | |
virtual bool IsRegisteredLogListing
(
const FName& LogName |
Checks to see if a log listing is already registered with the system | MessageLogModule.h | |
virtual void OpenMessageLog
(
const FName& LogName |
Opens up the message log to a certain log listing | MessageLogModule.h | |
virtual void RegisterLogListing
(
const FName& LogName, |
End IModuleInterface interface Registers a log listing with the message log widget. | MessageLogModule.h | |
virtual void RegisterMessageLogSpawner
(
const TSharedRef< FWorkspaceItem >& InGroup |
Registers the Message Log spawner. | MessageLogModule.h | |
virtual void ShutdownModule() |
MessageLogModule.h | ||
virtual void StartupModule() |
Begin IModuleInterface interface | MessageLogModule.h | |
virtual bool UnregisterLogListing
(
const FName& LogName |
Unregisters a log listing with the message log widget. | MessageLogModule.h |