Navigation
API > API/Developer > API/Developer/OutputLog
| Name | FOutputLogModule |
| Type | class |
| Header File | /Engine/Source/Developer/OutputLog/Public/OutputLogModule.h |
| Include Path | #include "OutputLogModule.h" |
Syntax
class FOutputLogModule : public IModuleInterface
Implements Interfaces
Structs
| Name | Remarks |
|---|---|
| FOutputFilterParams |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ModuleName | const FName | OutputLogModule.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnOutputLogDrawerCleared | TMulticastDelegate< void()> | OutputLogModule.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DebugConsole | TWeakPtr< SWidget > | Weak pointer to a debug console that's currently open, if any | OutputLogModule.h | |
| OutputLog | TWeakPtr< SOutputLog > | Our global active output log that belongs to a tab | OutputLogModule.h | |
| OutputLogDrawer | TWeakPtr< SOutputLog > | The output log that lives in a status bar drawer | OutputLogModule.h | |
| OutputLogFilterCache | TUniquePtr< FOutputLogFilter > | Caches the user selected Filters as the OutputLog tab can be closed and remade multiple times | OutputLogModule.h | |
| OutputLogHistory | TSharedPtr< FOutputLogHistory > | Our global output log app spawner | OutputLogModule.h | |
| OutputLogTab | TWeakPtr< SDockTab > | Global tab that the output log resides in | OutputLogModule.h | |
| PreviousKeyboardFocusedWidget | TWeakPtr< SWidget > | Weak pointer to the widget to focus once they console window closes | OutputLogModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ClearOnPIE
(
const bool bIsSimulating |
OutputLogModule.h | ||
virtual void CloseDebugConsole() |
Closes the debug console for the specified window | OutputLogModule.h | |
void FocusOutputLog() |
Opens and focuses on the Output Log Drawer if the status bar exists, otherwise opens and focuses on the Output Log Tab. | OutputLogModule.h | |
virtual void FocusOutputLogAndScrollToEnd() |
Same as FocusOutputLog(), but also scrolls the output log window to the end. | OutputLogModule.h | |
virtual void FocusOutputLogConsoleBox
(
const TSharedRef< SWidget > OutputLogToFocus |
OutputLogModule.h | ||
virtual const TSharedPtr< SWidget > GetOutputLog() |
OutputLogModule.h | ||
const TSharedPtr< SDockTab > GetOutputLogTab() |
OutputLogModule.h | ||
virtual TSharedRef< SWidget > MakeConsoleInputBox
(
TSharedPtr< SMultiLineEditableTextBox >& OutExposedEditableTextBox, |
Generates a console input box widget. | OutputLogModule.h | |
virtual TSharedRef< SWidget > MakeOutputLogDrawerWidget
(
const FSimpleDelegate& OnCloseConsole |
OutputLogModule.h | ||
virtual TSharedRef< SWidget > MakeOutputLogWidget
(
const FOutputLogCreationParams& Params |
OutputLogModule.h | ||
void OpenOutputLog() |
Opens the output log tab, or brings it to front if it's already open | OutputLogModule.h | |
virtual void ResumeGlobalLog () |
Resume global log collection. | OutputLogModule.h | |
virtual bool ShouldCycleToOutputLogDrawer () |
Returns the value of bCycleToOutputLogDrawer from the module OutputLogSettings. | OutputLogModule.h | |
virtual bool ShouldHideConsole() |
Returns whether debug console widgets should be hidden | OutputLogModule.h | |
virtual void ShutdownModule() |
OutputLogModule.h | ||
virtual void StartupModule() |
OutputLogModule.h | ||
virtual void SuspendGlobalLog () |
Suspend the collection of global log data that is used for constructing output log widgets. | OutputLogModule.h | |
virtual void ToggleDebugConsoleForWindow
(
const TSharedRef< SWindow >& Window, |
Opens a debug console in the specified window, if not already open | OutputLogModule.h | |
void UpdateOutputLogFilter
(
const TArray< FName >& CategoriesToShow, |
OutputLogModule.h | ||
void UpdateOutputLogFilter
(
const TArray< FName >& CategoriesToShow, |
Change the output log's filter. If CategoriesToShow is empty, all categories will be shown. | OutputLogModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FOutputLogModule & Get() |
OutputLogModule.h | ||
static FOutputLogModule * TryGet() |
OutputLogModule.h |