A Demo Project for the UnrealEngineSDK
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Types | List of all members
INYLogger Class Reference

#include <INYLogger.h>

Inheritance diagram for INYLogger:
[legend]

Public Member Functions

virtual ~INYLogger ()
 
FORCEINLINE void Debug (const FString &Message)
 
template<typename FmtType , typename... Types>
void Debugf (const FmtType &Fmt, Types... Args)
 
Self & DisableClientConsole ()
 
Self & DisableMessageLog ()
 
Self & DisableOnScreen ()
 
Self & DisableOutputLog ()
 
Self & DisableRedirectMessageLogLevels ()
 
Self & EnableClientConsole (APlayerController *PC)
 
Self & EnableMessageLog (bool bSuppressLoggingToOutputLog=false)
 
Self & EnableOnScreen (bool bInForceEnableScreenMessages=false)
 
Self & EnableOutputLog ()
 
FORCEINLINE void Error (const FString &Message)
 
template<typename FmtType , typename... Types>
void Errorf (const FmtType &Fmt, Types... Args)
 
FORCEINLINE FName GetOutputLogCategory () const
 
FORCEINLINE void Info (const FString &Message)
 
template<typename FmtType , typename... Types>
void Infof (const FmtType &Fmt, Types... Args)
 
FORCEINLINE bool IsClientConsoleEnabled () const
 
FORCEINLINE bool IsMessageLogEnabled () const
 
FORCEINLINE bool IsOnScreenEnabled () const
 
FORCEINLINE bool IsOutputLogEnabled () const
 
void Log (ENYLoggerLogLevel Level, const FString &Message)
 
template<typename FmtType , typename... Types>
void Logf (ENYLoggerLogLevel Level, const FmtType &Fmt, Types... Args)
 
Self & OnlyEnableClientConsole (APlayerController *PC)
 
Self & OnlyEnableMessageLog (bool bSuppressLoggingToOutputLog=false)
 
Self & OnlyEnableOnScreen (bool bInForceEnableScreenMessages=false)
 
Self & OnlyEnableOutputLog ()
 
Self & SetClientConsolePlayerController (APlayerController *PC)
 
Self & SetMessageLogMirrorToOutputLog (bool bValue)
 
Self & SetMessageLogName (FName LogName, bool bVerify=true)
 
Self & SetMessageLogOpenOnNewMessage (bool bValue)
 
Self & SetNoOutputLogCategory ()
 
Self & SetOnScreenNewerOnTop (bool bValue)
 
Self & SetOnScreenTimeToDisplay (float Seconds)
 
Self & SetOpenMessageLogLevelsHigherThan (ENYLoggerLogLevel AfterOrEqualLevel)
 
Self & SetOutputLogCategory (const FLogCategoryBase &NewCategory)
 
Self & SetOutputLogCategory (FName NewCategory)
 
Self & SetRedirectMessageLogLevelsHigherThan (ENYLoggerLogLevel AfterOrEqualLevel)
 
FORCEINLINE void Trace (const FString &Message)
 
template<typename FmtType , typename... Types>
void Tracef (const FmtType &Fmt, Types... Args)
 
Self & UseClientConsole (bool bValue)
 
Self & UseMessageLog (bool bValue, bool bInMessageLogMirrorToOutputLog=true)
 
Self & UseOnScreen (bool bValue, bool bInForceEnableScreenMessages=false)
 
Self & UseOutputLog (bool bValue)
 
FORCEINLINE void Warning (const FString &Message)
 
template<typename FmtType , typename... Types>
void Warningf (const FmtType &Fmt, Types... Args)
 

Static Public Member Functions

static FORCEINLINE bool AreAllOnScreenMessagesEnabled ()
 
static void ClearAllOnScreenLogs ()
 
static FORCEINLINE void DisableAllOnScreenMessages ()
 
static FORCEINLINE void EnableAllOnScreenMessages ()
 
static INYLogger & Get ()
 
static bool IsMessageLogNameRegistered (FName LogName)
 
static void MessageLogOpenLogName (FName LogName)
 
static void MessageLogRegisterLogName (FName LogName, const FText &LogLabel, const FNYMessageLogInitializationOptions &InitOptions={})
 
static bool MessageLogUnregisterLogName (FName LogName)
 
static INYLogger New ()
 
static FORCEINLINE void SetAreAllOnScreenMessagesEnabled (bool bValue)
 

Protected Member Functions

 INYLogger ()
 
FColor GetColorForLogLevel (ENYLoggerLogLevel Level) const
 
virtual void LogClientConsole (ENYLoggerLogLevel Level, const FString &Message)
 
void VARARGS LogfImplementation (ENYLoggerLogLevel Level, const TCHAR *Fmt,...)
 
virtual void LogMessageLog (ENYLoggerLogLevel Level, const FString &Message)
 
virtual void LogOutputLog (ENYLoggerLogLevel Level, const FString &Message)
 
virtual void LogScreen (ENYLoggerLogLevel Level, const FString &Message)
 

Static Protected Member Functions

static EMessageSeverity::Type GetMessageSeverityForLogLevel (ENYLoggerLogLevel Level)
 
static FOutputDevice * GetOutputDeviceFromLogLevel (ENYLoggerLogLevel Level)
 
static ELogVerbosity::Type GetUnrealLogTypeForLogLevel (ENYLoggerLogLevel Level)
 

Protected Attributes

bool bClientConsole = false
 
bool bForceEnableScreenMessages = false
 
bool bMessageLog = true
 
bool bMessageLogMirrorToOutputLog = true
 
bool bMessageLogOpen = true
 
bool bOnScreen = false
 
bool bOutputLog = false
 
bool bScreenNewerOnTop = true
 
FColor ColorDebug = FColor::Blue
 
FColor ColorError = FColor::Red
 
FColor ColorFatal = FColor::Red
 
FColor ColorInfo = FColor::White
 
FColor ColorTrace = FColor::Cyan
 
FColor ColorWarning = FColor::Yellow
 
FName MessageLogName = TEXT("PIE")
 
ENYLoggerLogLevel OpenMessageLogLevelsHigherThan = ENYLoggerLogLevel::NoLogging
 
FName OutputLogCategory = NAME_None
 
APlayerController * PlayerController = nullptr
 
FName PreviousOutputLogCategory = NAME_None
 
ENYLoggerLogLevel RedirectMessageLogLevelsHigherThan = ENYLoggerLogLevel::Warning
 
float ScreenLogDisplayTimeSeconds = 5.f
 
FVector2D ScreenTextScale = FVector2D::UnitVector
 

Private Types

typedef INYLogger Self
 

Detailed Description

The following output are available:

  • output log, also file on your filesystem which corresponds to the output log
  • message log, only available in editor
  • in the client console, press ~ (tilde) to see it
  • on screen

Definition at line 79 of file INYLogger.h.

Member Typedef Documentation

◆ Self

typedef INYLogger INYLogger::Self
private

Definition at line 81 of file INYLogger.h.

Constructor & Destructor Documentation

◆ INYLogger()

INYLogger::INYLogger ( )
inlineprotected

Definition at line 83 of file INYLogger.h.

◆ ~INYLogger()

virtual INYLogger::~INYLogger ( )
inlinevirtual

Definition at line 86 of file INYLogger.h.

Member Function Documentation

◆ AreAllOnScreenMessagesEnabled()

static FORCEINLINE bool INYLogger::AreAllOnScreenMessagesEnabled ( )
inlinestatic

Definition at line 180 of file INYLogger.h.

Here is the caller graph for this function:

◆ ClearAllOnScreenLogs()

void INYLogger::ClearAllOnScreenLogs ( )
static

Definition at line 292 of file INYLogger.cpp.

◆ Debug()

FORCEINLINE void INYLogger::Debug ( const FString & Message)
inline

Definition at line 328 of file INYLogger.h.

◆ Debugf()

template<typename FmtType , typename... Types>
void INYLogger::Debugf ( const FmtType & Fmt,
Types... Args )
inline

Definition at line 314 of file INYLogger.h.

Here is the caller graph for this function:

◆ DisableAllOnScreenMessages()

static FORCEINLINE void INYLogger::DisableAllOnScreenMessages ( )
inlinestatic

Definition at line 185 of file INYLogger.h.

◆ DisableClientConsole()

Self & INYLogger::DisableClientConsole ( )
inline

Definition at line 142 of file INYLogger.h.

Here is the caller graph for this function:

◆ DisableMessageLog()

Self & INYLogger::DisableMessageLog ( )
inline

Definition at line 226 of file INYLogger.h.

◆ DisableOnScreen()

Self & INYLogger::DisableOnScreen ( )
inline

Definition at line 156 of file INYLogger.h.

Here is the caller graph for this function:

◆ DisableOutputLog()

Self & INYLogger::DisableOutputLog ( )
inline

Definition at line 194 of file INYLogger.h.

Here is the caller graph for this function:

◆ DisableRedirectMessageLogLevels()

Self & INYLogger::DisableRedirectMessageLogLevels ( )
inline

Definition at line 248 of file INYLogger.h.

◆ EnableAllOnScreenMessages()

static FORCEINLINE void INYLogger::EnableAllOnScreenMessages ( )
inlinestatic

Definition at line 186 of file INYLogger.h.

Here is the caller graph for this function:

◆ EnableClientConsole()

Self & INYLogger::EnableClientConsole ( APlayerController * PC)
inline

Definition at line 136 of file INYLogger.h.

◆ EnableMessageLog()

Self & INYLogger::EnableMessageLog ( bool bSuppressLoggingToOutputLog = false)
inline

Definition at line 225 of file INYLogger.h.

Here is the caller graph for this function:

◆ EnableOnScreen()

Self & INYLogger::EnableOnScreen ( bool bInForceEnableScreenMessages = false)
inline

Definition at line 155 of file INYLogger.h.

◆ EnableOutputLog()

Self & INYLogger::EnableOutputLog ( )
inline

Definition at line 193 of file INYLogger.h.

◆ Error()

FORCEINLINE void INYLogger::Error ( const FString & Message)
inline

Definition at line 325 of file INYLogger.h.

Here is the caller graph for this function:

◆ Errorf()

template<typename FmtType , typename... Types>
void INYLogger::Errorf ( const FmtType & Fmt,
Types... Args )
inline

Definition at line 305 of file INYLogger.h.

Here is the caller graph for this function:

◆ Get()

static INYLogger & INYLogger::Get ( )
inlinestatic

Definition at line 90 of file INYLogger.h.

◆ GetColorForLogLevel()

FColor INYLogger::GetColorForLogLevel ( ENYLoggerLogLevel Level) const
inlineprotected

Definition at line 384 of file INYLogger.h.

Here is the caller graph for this function:

◆ GetMessageSeverityForLogLevel()

static EMessageSeverity::Type INYLogger::GetMessageSeverityForLogLevel ( ENYLoggerLogLevel Level)
inlinestaticprotected

Definition at line 366 of file INYLogger.h.

Here is the caller graph for this function:

◆ GetOutputDeviceFromLogLevel()

FOutputDevice * INYLogger::GetOutputDeviceFromLogLevel ( ENYLoggerLogLevel Level)
staticprotected

Definition at line 62 of file INYLogger.cpp.

Here is the caller graph for this function:

◆ GetOutputLogCategory()

FORCEINLINE FName INYLogger::GetOutputLogCategory ( ) const
inline

Definition at line 290 of file INYLogger.h.

◆ GetUnrealLogTypeForLogLevel()

static ELogVerbosity::Type INYLogger::GetUnrealLogTypeForLogLevel ( ENYLoggerLogLevel Level)
inlinestaticprotected

Definition at line 343 of file INYLogger.h.

Here is the caller graph for this function:

◆ Info()

FORCEINLINE void INYLogger::Info ( const FString & Message)
inline

Definition at line 327 of file INYLogger.h.

Here is the caller graph for this function:

◆ Infof()

template<typename FmtType , typename... Types>
void INYLogger::Infof ( const FmtType & Fmt,
Types... Args )
inline

Definition at line 311 of file INYLogger.h.

Here is the caller graph for this function:

◆ IsClientConsoleEnabled()

FORCEINLINE bool INYLogger::IsClientConsoleEnabled ( ) const
inline

Definition at line 291 of file INYLogger.h.

Here is the caller graph for this function:

◆ IsMessageLogEnabled()

FORCEINLINE bool INYLogger::IsMessageLogEnabled ( ) const
inline

Definition at line 294 of file INYLogger.h.

Here is the caller graph for this function:

◆ IsMessageLogNameRegistered()

bool INYLogger::IsMessageLogNameRegistered ( FName LogName)
static

Definition at line 89 of file INYLogger.cpp.

◆ IsOnScreenEnabled()

FORCEINLINE bool INYLogger::IsOnScreenEnabled ( ) const
inline

Definition at line 292 of file INYLogger.h.

Here is the caller graph for this function:

◆ IsOutputLogEnabled()

FORCEINLINE bool INYLogger::IsOutputLogEnabled ( ) const
inline

Definition at line 293 of file INYLogger.h.

Here is the caller graph for this function:

◆ Log()

void INYLogger::Log ( ENYLoggerLogLevel Level,
const FString & Message )

Definition at line 186 of file INYLogger.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LogClientConsole()

void INYLogger::LogClientConsole ( ENYLoggerLogLevel Level,
const FString & Message )
protectedvirtual

Definition at line 239 of file INYLogger.cpp.

Here is the caller graph for this function:

◆ Logf()

template<typename FmtType , typename... Types>
void INYLogger::Logf ( ENYLoggerLogLevel Level,
const FmtType & Fmt,
Types... Args )
inline

Definition at line 297 of file INYLogger.h.

◆ LogfImplementation()

void INYLogger::LogfImplementation ( ENYLoggerLogLevel Level,
const TCHAR * Fmt,
... )
protected

Definition at line 166 of file INYLogger.cpp.

Here is the call graph for this function:

◆ LogMessageLog()

void INYLogger::LogMessageLog ( ENYLoggerLogLevel Level,
const FString & Message )
protectedvirtual

Definition at line 252 of file INYLogger.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LogOutputLog()

void INYLogger::LogOutputLog ( ENYLoggerLogLevel Level,
const FString & Message )
protectedvirtual

Definition at line 279 of file INYLogger.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LogScreen()

void INYLogger::LogScreen ( ENYLoggerLogLevel Level,
const FString & Message )
protectedvirtual

Definition at line 216 of file INYLogger.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ MessageLogOpenLogName()

void INYLogger::MessageLogOpenLogName ( FName LogName)
static

Definition at line 153 of file INYLogger.cpp.

◆ MessageLogRegisterLogName()

void INYLogger::MessageLogRegisterLogName ( FName LogName,
const FText & LogLabel,
const FNYMessageLogInitializationOptions & InitOptions = {} )
static

Definition at line 104 of file INYLogger.cpp.

Here is the caller graph for this function:

◆ MessageLogUnregisterLogName()

bool INYLogger::MessageLogUnregisterLogName ( FName LogName)
static

Definition at line 125 of file INYLogger.cpp.

Here is the caller graph for this function:

◆ New()

static INYLogger INYLogger::New ( )
inlinestatic

Definition at line 89 of file INYLogger.h.

◆ OnlyEnableClientConsole()

Self & INYLogger::OnlyEnableClientConsole ( APlayerController * PC)
inline

Definition at line 97 of file INYLogger.h.

◆ OnlyEnableMessageLog()

Self & INYLogger::OnlyEnableMessageLog ( bool bSuppressLoggingToOutputLog = false)
inline

Definition at line 122 of file INYLogger.h.

◆ OnlyEnableOnScreen()

Self & INYLogger::OnlyEnableOnScreen ( bool bInForceEnableScreenMessages = false)
inline

Definition at line 105 of file INYLogger.h.

◆ OnlyEnableOutputLog()

Self & INYLogger::OnlyEnableOutputLog ( )
inline

Definition at line 113 of file INYLogger.h.

◆ SetAreAllOnScreenMessagesEnabled()

static FORCEINLINE void INYLogger::SetAreAllOnScreenMessagesEnabled ( bool bValue)
inlinestatic

Definition at line 181 of file INYLogger.h.

Here is the caller graph for this function:

◆ SetClientConsolePlayerController()

INYLogger & INYLogger::SetClientConsolePlayerController ( APlayerController * PC)

Definition at line 56 of file INYLogger.cpp.

◆ SetMessageLogMirrorToOutputLog()

Self & INYLogger::SetMessageLogMirrorToOutputLog ( bool bValue)
inline

Definition at line 242 of file INYLogger.h.

Here is the caller graph for this function:

◆ SetMessageLogName()

Self & INYLogger::SetMessageLogName ( FName LogName,
bool bVerify = true )
inline

Definition at line 273 of file INYLogger.h.

Here is the caller graph for this function:

◆ SetMessageLogOpenOnNewMessage()

Self & INYLogger::SetMessageLogOpenOnNewMessage ( bool bValue)
inline

Definition at line 235 of file INYLogger.h.

Here is the caller graph for this function:

◆ SetNoOutputLogCategory()

Self & INYLogger::SetNoOutputLogCategory ( )
inline

Definition at line 202 of file INYLogger.h.

◆ SetOnScreenNewerOnTop()

Self & INYLogger::SetOnScreenNewerOnTop ( bool bValue)
inline

Definition at line 172 of file INYLogger.h.

◆ SetOnScreenTimeToDisplay()

Self & INYLogger::SetOnScreenTimeToDisplay ( float Seconds)
inline

Definition at line 165 of file INYLogger.h.

◆ SetOpenMessageLogLevelsHigherThan()

Self & INYLogger::SetOpenMessageLogLevelsHigherThan ( ENYLoggerLogLevel AfterOrEqualLevel)
inline

Definition at line 256 of file INYLogger.h.

Here is the caller graph for this function:

◆ SetOutputLogCategory() [1/2]

Self & INYLogger::SetOutputLogCategory ( const FLogCategoryBase & NewCategory)
inline

Definition at line 203 of file INYLogger.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetOutputLogCategory() [2/2]

Self & INYLogger::SetOutputLogCategory ( FName NewCategory)
inline

Definition at line 204 of file INYLogger.h.

◆ SetRedirectMessageLogLevelsHigherThan()

Self & INYLogger::SetRedirectMessageLogLevelsHigherThan ( ENYLoggerLogLevel AfterOrEqualLevel)
inline

Definition at line 249 of file INYLogger.h.

Here is the caller graph for this function:

◆ Trace()

FORCEINLINE void INYLogger::Trace ( const FString & Message)
inline

Definition at line 329 of file INYLogger.h.

◆ Tracef()

template<typename FmtType , typename... Types>
void INYLogger::Tracef ( const FmtType & Fmt,
Types... Args )
inline

Definition at line 317 of file INYLogger.h.

◆ UseClientConsole()

Self & INYLogger::UseClientConsole ( bool bValue)
inline

Definition at line 143 of file INYLogger.h.

◆ UseMessageLog()

Self & INYLogger::UseMessageLog ( bool bValue,
bool bInMessageLogMirrorToOutputLog = true )
inline

Definition at line 227 of file INYLogger.h.

Here is the caller graph for this function:

◆ UseOnScreen()

Self & INYLogger::UseOnScreen ( bool bValue,
bool bInForceEnableScreenMessages = false )
inline

Definition at line 157 of file INYLogger.h.

◆ UseOutputLog()

Self & INYLogger::UseOutputLog ( bool bValue)
inline

Definition at line 195 of file INYLogger.h.

Here is the caller graph for this function:

◆ Warning()

FORCEINLINE void INYLogger::Warning ( const FString & Message)
inline

Definition at line 326 of file INYLogger.h.

Here is the caller graph for this function:

◆ Warningf()

template<typename FmtType , typename... Types>
void INYLogger::Warningf ( const FmtType & Fmt,
Types... Args )
inline

Definition at line 308 of file INYLogger.h.

Here is the caller graph for this function:

Member Data Documentation

◆ bClientConsole

bool INYLogger::bClientConsole = false
protected

Definition at line 475 of file INYLogger.h.

◆ bForceEnableScreenMessages

bool INYLogger::bForceEnableScreenMessages = false
protected

Definition at line 427 of file INYLogger.h.

◆ bMessageLog

bool INYLogger::bMessageLog = true
protected

Definition at line 447 of file INYLogger.h.

◆ bMessageLogMirrorToOutputLog

bool INYLogger::bMessageLogMirrorToOutputLog = true
protected

Definition at line 453 of file INYLogger.h.

◆ bMessageLogOpen

bool INYLogger::bMessageLogOpen = true
protected

Definition at line 464 of file INYLogger.h.

◆ bOnScreen

bool INYLogger::bOnScreen = false
protected

Definition at line 415 of file INYLogger.h.

◆ bOutputLog

bool INYLogger::bOutputLog = false
protected

Definition at line 434 of file INYLogger.h.

◆ bScreenNewerOnTop

bool INYLogger::bScreenNewerOnTop = true
protected

Definition at line 424 of file INYLogger.h.

◆ ColorDebug

FColor INYLogger::ColorDebug = FColor::Blue
protected

Definition at line 488 of file INYLogger.h.

◆ ColorError

FColor INYLogger::ColorError = FColor::Red
protected

Definition at line 485 of file INYLogger.h.

◆ ColorFatal

FColor INYLogger::ColorFatal = FColor::Red
protected

Definition at line 484 of file INYLogger.h.

◆ ColorInfo

FColor INYLogger::ColorInfo = FColor::White
protected

Definition at line 487 of file INYLogger.h.

◆ ColorTrace

FColor INYLogger::ColorTrace = FColor::Cyan
protected

Definition at line 489 of file INYLogger.h.

◆ ColorWarning

FColor INYLogger::ColorWarning = FColor::Yellow
protected

Definition at line 486 of file INYLogger.h.

◆ MessageLogName

FName INYLogger::MessageLogName = TEXT("PIE")
protected

Definition at line 450 of file INYLogger.h.

◆ OpenMessageLogLevelsHigherThan

ENYLoggerLogLevel INYLogger::OpenMessageLogLevelsHigherThan = ENYLoggerLogLevel::NoLogging
protected

Definition at line 468 of file INYLogger.h.

◆ OutputLogCategory

FName INYLogger::OutputLogCategory = NAME_None
protected

Definition at line 437 of file INYLogger.h.

◆ PlayerController

APlayerController* INYLogger::PlayerController = nullptr
protected

Definition at line 478 of file INYLogger.h.

◆ PreviousOutputLogCategory

FName INYLogger::PreviousOutputLogCategory = NAME_None
protected

Definition at line 440 of file INYLogger.h.

◆ RedirectMessageLogLevelsHigherThan

ENYLoggerLogLevel INYLogger::RedirectMessageLogLevelsHigherThan = ENYLoggerLogLevel::Warning
protected

Definition at line 460 of file INYLogger.h.

◆ ScreenLogDisplayTimeSeconds

float INYLogger::ScreenLogDisplayTimeSeconds = 5.f
protected

Definition at line 418 of file INYLogger.h.

◆ ScreenTextScale

FVector2D INYLogger::ScreenTextScale = FVector2D::UnitVector
protected

Definition at line 421 of file INYLogger.h.

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