BaseHelperMacros.h File Reference

#include "CoreMinimal.h"
#include "BPLib/BaseHelpersBPLib.h"

Go to the source code of this file.

Macros
#define	LOG_MISSING_POINTER(WorldContext, PointerName, ObjectName, bDebuggingMode, Category)
#define	LOG_DEBUG_MESSAGE(WorldContext, Message, ObjectName, bDebuggingMode, Category)

Macro Definition Documentation

LOG_DEBUG_MESSAGE

#define LOG_DEBUG_MESSAGE	(		WorldContext,
			Message,
			ObjectName,
			bDebuggingMode,
			Category )

Value:

if (!bDebuggingMode) { return; } \
const FString FullMessage = FString::Printf(TEXT("%s - in %s"), *Message, *ObjectName); \
UBaseHelpersBPLib::PrintToLogWithCategory(WorldContext, Category, FullMessage, true, true);

Macro to log a debug message if debugging mode is enabled.

Parameters

WorldContext	- The world context object.
Message	- The debug message to log.
ObjectName	- The name of the object where the message is logged.
bDebuggingMode	- Whether debugging mode is enabled.
Category	- The log category to use.

#define LOG_DEBUG_MESSAGE(WorldContext, Message, ObjectName, bDebuggingMode, Category) \
if (!bDebuggingMode) { return; } \
const FString FullMessage = FString::Printf(TEXT("%s - in %s"), *Message, *ObjectName); \
UBaseHelpersBPLib::PrintToLogWithCategory(WorldContext, Category, FullMessage, true, true);

LOG_MISSING_POINTER

#define LOG_MISSING_POINTER	(		WorldContext,
			PointerName,
			ObjectName,
			bDebuggingMode,
			Category )

Value:

if (!bDebuggingMode) { return; } \
const FString FullMessage = FString::Printf(TEXT("%s not set in %s"), ToCStr(PointerName), ToCStr(ObjectName)); \
UBaseHelpersBPLib::PrintToLogWithCategory(WorldContext, Category, FullMessage, false, true);

Macro to log a missing pointer error if debugging mode is enabled.

Parameters

WorldContext	- The world context object.
PointerName	- The name of the missing pointer.
ObjectName	- The name of the object where the pointer is missing.
bDebuggingMode	- Whether debugging mode is enabled.
Category	- The log category to use.

#define LOG_MISSING_POINTER(WorldContext, PointerName, ObjectName, bDebuggingMode, Category) \
if (!bDebuggingMode) { return; } \
const FString FullMessage = FString::Printf(TEXT("%s not set in %s"), ToCStr(PointerName), ToCStr(ObjectName)); \
UBaseHelpersBPLib::PrintToLogWithCategory(WorldContext, Category, FullMessage, false, true);