Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FOutputDeviceConsole Class Referenceabstract

#include <OutputDeviceConsole.h>

+ Inheritance diagram for FOutputDeviceConsole:
+ Collaboration 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
 FOutputDevice ()
 
 FOutputDevice (FOutputDevice &&)=default
 
 FOutputDevice (const FOutputDevice &)=default
 
FOutputDeviceoperator= (FOutputDevice &&)=default
 
FOutputDeviceoperator= (const FOutputDevice &)=default
 
virtual ~FOutputDevice ()=default
 
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 void SerializeRecord (const UE::FLogRecord &Record)
 
virtual void Flush ()
 
virtual void TearDown ()
 
void SetSuppressEventTag (bool bInSuppressEventTag)
 
FORCEINLINE bool GetSuppressEventTag () const
 
void SetAutoEmitLineTerminator (bool bInAutoEmitLineTerminator)
 
FORCEINLINE 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
 
void Log (const TCHAR *S)
 
void Log (ELogVerbosity::Type Verbosity, const TCHAR *S)
 
void Log (const FName &Category, ELogVerbosity::Type Verbosity, const TCHAR *Str)
 
void Log (const FString &S)
 
void Log (const FText &S)
 
void Log (ELogVerbosity::Type Verbosity, const FString &S)
 
void Log (const FName &Category, ELogVerbosity::Type Verbosity, const FString &S)
 
template<typename FmtType >
void Logf (const FmtType &Fmt)
 
template<typename FmtType , typename... Types>
FORCEINLINE void Logf (const FmtType &Fmt, Types... Args)
 
template<typename FmtType , typename... Types>
FORCEINLINE void Logf (ELogVerbosity::Type Verbosity, const FmtType &Fmt, Types... Args)
 
template<typename FmtType , typename... Types>
FORCEINLINE 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.

Definition at line 12 of file OutputDeviceConsole.h.

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.

Definition at line 36 of file OutputDeviceConsole.h.

◆ IsShown()

virtual bool FOutputDeviceConsole::IsShown ( )
pure virtual

Returns whether console is currently shown or not.

Returns
true if console is shown, false otherwise.

◆ 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.

Definition at line 46 of file OutputDeviceConsole.h.

◆ 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.

Member Data Documentation

◆ IniFilename

FString FOutputDeviceConsole::IniFilename
protected

Ini file name to write console settings to.

Definition at line 54 of file OutputDeviceConsole.h.


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