FMessageLogModule

Windows
MacOS
Linux

Inheritance Hierarchy

IModuleInterface

FMessageLogModule

References

Module

MessageLog

Header

/Engine/Source/Developer/MessageLog/Public/MessageLogModule.h

Include

#include "MessageLogModule.h"

Syntax

class FMessageLogModule : public IModuleInterface

Constructors

Name Description

Public function

FMessageLogModule()

Functions

Name Description

Public function Virtual

TSharedRef< ...

 

CreateLogListing

(
    const FName& InLogName,
    const FMessageLogInitializationOpti...
)

Creates a new log listing for use outside of the global MessageLog window.

Public function Virtual

TSharedRef< ...

 

CreateLogListingWidget

(
    const TSharedRef< class IMessageLog...
)

Creates a log listing widget to view data from the passed-in listing.

Public function Virtual

void

 

EnableMessageLogDisplay

(
    bool bInCanDisplayMessageLog
)

Setting this to true will allow the message log to be displayed when OpenMessageLog is called.

Public function Virtual

TSharedRef< ...

 

GetLogListing

(
    const FName& LogName
)

Get a message log listing registered with the message log. If it does not exist it will created.

Public function Virtual Const

bool

 

IsRegisteredLogListing

(
    const FName& LogName
)

Checks to see if a log listing is already registered with the system

Public function Virtual

void

 

OpenMessageLog

(
    const FName& LogName
)

Opens up the message log to a certain log listing

Public function Virtual

void

 

RegisterLogListing

(
    const FName& LogName,
    const FText& LogLabel,
    const FMessageLogInitializationOpti...
)

End IModuleInterface interface Registers a log listing with the message log widget.

Public function Virtual

bool

 

UnregisterLogListing

(
    const FName& LogName
)

Unregisters a log listing with the message log widget.

Overridden from IModuleInterface

Name Description

Public function Virtual

void

 

ShutdownModule()

Called before the module is unloaded, right before the module object is destroyed.

Public function Virtual

void

 

StartupModule()

Begin IModuleInterface interface

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss