IBCR_Helper Class Reference

Custom logging system interface for BCR project. More...

#include <BCR_Helper.h>

Inheritance diagram for IBCR_Helper:

Public Member Functions
virtual void	CustomLogConsole (const FString &Message=TEXT(""))
	Custom logging without context.
virtual void	CustomLogScreen (const FString &Message=TEXT(""), float Duration=5.0f, FColor Color=FColor::White)
	Logs a custom message to the screen without object context.
virtual void	CustomLogAll (const FString &Message=TEXT(""), float Duration=5.0f, FColor Color=FColor::White)
	Logs a custom message to both console and screen without object context.
virtual FString	GetCustomLogInfo () const =0

Static Public Member Functions
static void	LogConsole (const UObject *Context, const FString &Message=TEXT(""))
	Logs a message to the console with object context.
static void	LogScreen (const UObject *Context, const FString &Message=TEXT(""), float Duration=5.0f, FColor Color=FColor::White)
	Logs a message to the screen with object context.
static void	LogAll (const UObject *Context, const FString &Message=TEXT(""), float Duration=5.0f, FColor Color=FColor::White)
	Logs a message to both console and screen with object context.
static FString	GetBasicObjectInfo (const UObject *Object)
	Extracts basic information from a UObject.

Detailed Description

Custom logging system interface for BCR project.

Provides static logging functions and customizable log information for objects

Member Function Documentation

CustomLogAll()

void IBCR_Helper::CustomLogAll ( const FString & Message = TEXT(""), float Duration = 5.0f, FColor Color = FColor::White )

virtual

Logs a custom message to both console and screen without object context.

Combines CustomLogConsole and CustomLogScreen functionality

Parameters

Message	The message to log
Duration	How long to display the message on screen
Color	Color of the on-screen message

Here is the call graph for this function:

CustomLogConsole()

void IBCR_Helper::CustomLogConsole ( const FString & Message = TEXT("") )

virtual

Custom logging without context.

Logs a custom message to the console without object context.

Simple console logging for standalone messages

Parameters

Message

The message to log

Here is the caller graph for this function:

CustomLogScreen()

void IBCR_Helper::CustomLogScreen ( const FString & Message = TEXT(""), float Duration = 5.0f, FColor Color = FColor::White )

virtual

Logs a custom message to the screen without object context.

Simple on-screen logging for standalone messages

Parameters

Message	The message to log
Duration	How long to display the message on screen
Color	Color of the on-screen message

Here is the caller graph for this function:

GetBasicObjectInfo()

FString IBCR_Helper::GetBasicObjectInfo ( const UObject * Object )

static

Extracts basic information from a UObject.

UTILITY METHODS //////// Helper functions

Gets object name and class name for logging purposes

Parameters

Object

The object to extract information from

Returns

Formatted string with object name and class

Here is the caller graph for this function:

GetCustomLogInfo()

virtual FString IBCR_Helper::GetCustomLogInfo ( ) const

pure virtual

VIRTUAL INTERFACE //////// Customizable log information

Implemented in AMainPlayer.

LogAll()

void IBCR_Helper::LogAll ( const UObject * Context, const FString & Message = TEXT(""), float Duration = 5.0f, FColor Color = FColor::White )

static

Logs a message to both console and screen with object context.

Combines LogConsole and LogScreen functionality

Parameters

Context	The object providing context for the log message
Message	The message to log
Duration	How long to display the message on screen
Color	Color of the on-screen message

Here is the call graph for this function:

Here is the caller graph for this function:

LogConsole()

void IBCR_Helper::LogConsole ( const UObject * Context, const FString & Message = TEXT("") )

static

Logs a message to the console with object context.

STATIC LOGGING METHODS //////// Context-based logging

Outputs formatted log information including object name and class to the console

Parameters

Context	The object providing context for the log message
Message	The message to log

Here is the call graph for this function:

Here is the caller graph for this function:

LogScreen()

void IBCR_Helper::LogScreen ( const UObject * Context, const FString & Message = TEXT(""), float Duration = 5.0f, FColor Color = FColor::White )

static

Logs a message to the screen with object context.

Displays formatted log information as an on-screen debug message

Parameters

Context	The object providing context for the log message
Message	The message to log
Duration	How long to display the message on screen
Color	Color of the on-screen message

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• /sources/Source/BCR/Headers/Interfaces/BCR_Helper.h
• /sources/Source/BCR/Sources/Interfaces/BCR_Helper.cpp