Debug.h

Go to the documentation of this file.

// Copyright Blue Isle Studios 2017. All Rights Reserved.
 
#pragma once
#include "Color.h"
 
enum class ELogLevel : uint8
{
    Log = 0,
    Warning = 1,
    Error = 2
};
 
class PROJECTX_API Debug
{
public:
    static void Log(FString output, float TimeToDisplay = 5.0f, FColor Color = FColor::Silver, int32 Key = -1, bool IncludeInLogs = false);
    static void Log(FString output, FColor Color);
    static void Log(FString output, bool IncludeInLogs);
    static void LogServerDedicated(FString output, const UObject* WorldContextObject, float TimeToDisplay = 5.0f, FColor Color = FColor::Silver, int32 Key = -1);
    static void LogServerListen(FString output, const UObject* WorldContextObject, float TimeToDisplay = 5.0f, FColor Color = FColor::Silver, int32 Key = -1);
    static void LogServerAny(FString output, const UObject* WorldContextObject, float TimeToDisplay = 5.0f, FColor Color = FColor::Silver, int32 Key = -1);
    static void LogClientNonServer(FString output, const UObject* WorldContextObject, float TimeToDisplay = 5.0f, FColor Color = FColor::Silver, int32 Key = -1);
    static void LogClientAny(FString output, const UObject* WorldContextObject, float TimeToDisplay = 5.0f, FColor Color = FColor::Silver, int32 Key = -1);
    static void LogOffscreenOnly(FString output, ELogLevel OffscreenLogLevel = ELogLevel::Log);
 
    /* Mimmicks Blueprint Print which outputs whether the log occured on the server or client. */
    static void Print(FString output, const UObject* WorldContextObject, float TimeToDisplay = 5.0f, FColor Color = FColor::Cyan, int32 Key = -1, bool IncludeInLogs = false);
    static void Print(FString output, const UObject* WorldContextObject, bool IncludeInLogs);
    static void Print(const UObject* WorldContextObject, FString output, bool IncludeInLogs);
};
 
#if UE_BUILD_SHIPPING
 
#define ProjectXEnsure(InExpression) (!!(InExpression))
#define ProjectXEnsureMsgf(InExpression, InFormat, ... ) (!!(InExpression))
 
#else
 
#define ProjectXEnsure(InExpression) { if(UNLIKELY(!(InExpression))) { FDebug::LogAssertFailedMessage( #InExpression, __FILE__, __LINE__ ); if (UE4Asserts_Private::TrueOnFirstCallOnly([]{})) { _DebugBreakAndPromptForRemote(); } } }
#define ProjectXEnsureMsgf(InExpression, InFormat, ... ) { if(UNLIKELY(!(InExpression))) { FDebug::LogAssertFailedMessage( #InExpression, __FILE__, __LINE__, InFormat, ##__VA_ARGS__ ); if (UE4Asserts_Private::TrueOnFirstCallOnly([]{})) { _DebugBreakAndPromptForRemote(); } } }
 
#endif