UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FOutputDeviceConsole Class Referenceabstract

#include <OutputDeviceConsole.h>

+ Inheritance diagram for FOutputDeviceConsole:

Public Member Functions

virtual void Show (bool ShowWindow)=0
 
virtual bool IsShown ()=0
 
virtual bool IsAttached ()
 
void SetIniFilename (const TCHAR *InFilename)
 
- Public Member Functions inherited from FOutputDevice
CORE_API FOutputDevice ()
 
CORE_API FOutputDevice (FOutputDevice &&)
 
CORE_API FOutputDevice (const FOutputDevice &)
 
CORE_API FOutputDeviceoperator= (FOutputDevice &&)
 
CORE_API FOutputDeviceoperator= (const FOutputDevice &)
 
virtual CORE_API ~FOutputDevice ()
 
virtual void Serialize (const TCHAR *V, ELogVerbosity::Type Verbosity, const FName &Category)=0
 
virtual void Serialize (const TCHAR *V, ELogVerbosity::Type Verbosity, const FName &Category, const double Time)
 
virtual CORE_API void SerializeRecord (const UE::FLogRecord &Record)
 
virtual void Flush ()
 
virtual void TearDown ()
 
void SetSuppressEventTag (bool bInSuppressEventTag)
 
UE_FORCEINLINE_HINT bool GetSuppressEventTag () const
 
void SetAutoEmitLineTerminator (bool bInAutoEmitLineTerminator)
 
UE_FORCEINLINE_HINT bool GetAutoEmitLineTerminator () const
 
virtual void Dump (class FArchive &Ar)
 
virtual bool IsMemoryOnly () const
 
virtual bool CanBeUsedOnAnyThread () const
 
virtual bool CanBeUsedOnMultipleThreads () const
 
virtual bool CanBeUsedOnPanicThread () const
 
CORE_API void Log (const TCHAR *S)
 
CORE_API void Log (ELogVerbosity::Type Verbosity, const TCHAR *S)
 
CORE_API void Log (const FName &Category, ELogVerbosity::Type Verbosity, const TCHAR *Str)
 
CORE_API void Log (const FString &S)
 
CORE_API void Log (const FText &S)
 
CORE_API void Log (ELogVerbosity::Type Verbosity, const FString &S)
 
CORE_API void Log (const FName &Category, ELogVerbosity::Type Verbosity, const FString &S)
 
template<typename FmtType >
void Logf (const FmtType &Fmt)
 
template<typename FmtType , typename... Types>
void Logf (const FmtType &Fmt, Types... Args)
 
template<typename FmtType , typename... Types>
void Logf (ELogVerbosity::Type Verbosity, const FmtType &Fmt, Types... Args)
 
template<typename FmtType , typename... Types>
void CategorizedLogf (const FName &Category, ELogVerbosity::Type Verbosity, const FmtType &Fmt, Types... Args)
 

Protected Attributes

FString IniFilename
 
- Protected Attributes inherited from FOutputDevice
bool bSuppressEventTag
 
bool bAutoEmitLineTerminator
 

Detailed Description

This class servers as the base class for console window output.

Member Function Documentation

◆ IsAttached()

virtual bool FOutputDeviceConsole::IsAttached ( )
inlinevirtual

Returns whether the application is already attached to a console window.

Returns
true if console is attached, false otherwise.

Reimplemented in FLinuxConsoleOutputDevice, FMacConsoleOutputDevice, FWindowsConsoleOutputDevice, and FWindowsConsoleOutputDevice2.

◆ IsShown()

virtual bool FOutputDeviceConsole::IsShown ( )
pure virtual

Returns whether console is currently shown or not.

Returns
true if console is shown, false otherwise.

Implemented in FLinuxConsoleOutputDevice, FMacConsoleOutputDevice, FWindowsConsoleOutputDevice, and FWindowsConsoleOutputDevice2.

◆ SetIniFilename()

void FOutputDeviceConsole::SetIniFilename ( const TCHAR InFilename)
inline

Sets the INI file name to write console settings to.

Parameters
InFilenameThe INI file name to set.

◆ Show()

virtual void FOutputDeviceConsole::Show ( bool  ShowWindow)
pure virtual

Shows or hides the console window.

Parameters
ShowWindowWhether to show (true) or hide (false) the console window.

Implemented in FLinuxConsoleOutputDevice, FMacConsoleOutputDevice, FWindowsConsoleOutputDevice, and FWindowsConsoleOutputDevice2.

Member Data Documentation

◆ IniFilename

FString FOutputDeviceConsole::IniFilename
protected

Ini file name to write console settings to.


The documentation for this class was generated from the following file: