AActorBase Class Reference

#include <ActorBase.h>

Inheritance diagram for AActorBase:

Public Member Functions
	AActorBase ()
virtual bool	SaveGame () override
virtual bool	LoadGame () override
void	SetGravityEnabledEvent (const bool bValue)

Protected Member Functions
virtual void	BeginPlay () override
void	LogDebugError (const FString &Message) const
void	LogDebugError (const FString &Message, const int32 Value) const
void	LogDebugError (const FString &Message, const float Value) const
void	LogDebugWarning (const FString &Message) const
void	LogDebugWarning (const FString &Message, const int32 Value) const
void	LogDebugWarning (const FString &Message, const float Value) const
void	LogDebugMessage (const FString &Message, const bool bWarning=false, const bool bError=false) const
void	LogDebugMessage (const FString &Message, const int32 Value, const bool bWarning=false, const bool bError=false) const
void	LogDebugMessage (const FString &Message, const float Value, const bool bWarning=false, const bool bError=false) const
void	LogDebugMessage (const FString &Message, const bool bValue, const bool bWarning, const bool bError) const
void	LogOnScreenMessage (const int32 Key, const FString &Message, FColor Color=FColor::Green) const
void	SetCategoryName (const FLogCategoryBase &Category)

Protected Attributes
FString	DisplayName = "Display Name"
bool	bDebuggingMode = false

Private Attributes
FLogCategoryName	CategoryName = LogActorBase.GetCategoryName()

Constructor & Destructor Documentation

AActorBase()

AActorBase::AActorBase

(

)

{
    PrimaryActorTick.bCanEverTick = false;
 
}

Member Function Documentation

BeginPlay()

void AActorBase::BeginPlay ( )

overrideprotectedvirtual

Reimplemented in ABaseRoomActor, ADoubleDoorActor, AInteractableActor, AInteractableActorWithPrompt, AInteractableBox, AInteractableSwitch, AInteractionPingActor, AOpenableDoorActor, ARoomWithDoorsActor, ATerminal, AWeaponAttachmentPickup, AWeaponPickup, and AGravityRoom.

{
    Super::BeginPlay();
    //@ Register To Save Game?
    // 
    
}

LoadGame()

bool AActorBase::LoadGame ( )

overridevirtual

Implements ISaveLoad.

{
    const bool bComponentsSaved = USaveLoadBPLib::LoadAllComponents(this);
    return bComponentsSaved;
    // return true;
}

LogDebugError() [1/3]

void AActorBase::LogDebugError ( const FString & Message ) const

protected

{
    TRACE_CPUPROFILER_EVENT_SCOPE(AActorBase::LogDebugError);
    SCOPE_CYCLE_COUNTER(STATGROUP_BaseHelpers_ActorBase);
    LogDebugMessage(Message, true, true);
}

LogDebugError() [2/3]

void AActorBase::LogDebugError ( const FString & Message, const float Value ) const

protected

{
    LogDebugMessage(Message, Value, true, true);
}

LogDebugError() [3/3]

void AActorBase::LogDebugError ( const FString & Message, const int32 Value ) const

protected

{
    LogDebugMessage(Message, Value, true, true);
}

LogDebugMessage() [1/4]

void AActorBase::LogDebugMessage ( const FString & Message, const bool bValue, const bool bWarning, const bool bError ) const

protected

{
    LogDebugMessage(FString::Printf(TEXT("%s: %s"), *Message, bValue ? *FString("true") : *FString("false")), bWarning, bError);
}

LogDebugMessage() [2/4]

void AActorBase::LogDebugMessage ( const FString & Message, const bool bWarning = false, const bool bError = false ) const

protected

{
    TRACE_CPUPROFILER_EVENT_SCOPE(AActorBase::LogDebugMessage);
    SCOPE_CYCLE_COUNTER(STATGROUP_BaseHelpers_ActorBase);
    if(bDebuggingMode == false && bError == false){return;}
    FOutputDevice* OutputDevice = GWarn;
    if(OutputDevice == nullptr){return;}
    FString NetModeString;
    switch(GetWorld()->GetNetMode())
    {
    case NM_Standalone:
        NetModeString = FString("SDL");
        break;
    case NM_DedicatedServer:
        NetModeString = FString("DServer");
        break;
    case NM_ListenServer:
        NetModeString = FString("LServer");
        break;
    case NM_Client:
        NetModeString = FString("Client");
        break;
    default:
        NetModeString = FString("Unknown");
        break;
    }
    const FString FullMessage = FString::Printf(TEXT("%s: %s::%s"), *NetModeString, *GetName(), *Message);
    if(bError)
    {
        OutputDevice->Log(CategoryName, ELogVerbosity::Error, FullMessage);
    }
    else if(bWarning)
    {
        OutputDevice->Log(CategoryName, ELogVerbosity::Warning, FullMessage);
    }
    else
    {
        OutputDevice->Log(CategoryName, ELogVerbosity::Log, FullMessage);
    }
 
}

LogDebugMessage() [3/4]

void AActorBase::LogDebugMessage ( const FString & Message, const float Value, const bool bWarning = false, const bool bError = false ) const

protected

{
    LogDebugMessage(FString::Printf(TEXT("%s: %f"), *Message, Value), bWarning, bError);    
}

LogDebugMessage() [4/4]

void AActorBase::LogDebugMessage ( const FString & Message, const int32 Value, const bool bWarning = false, const bool bError = false ) const

protected

{
    LogDebugMessage(FString::Printf(TEXT("%s: %i"), *Message, Value), bWarning, bError);
}

LogDebugWarning() [1/3]

void AActorBase::LogDebugWarning ( const FString & Message ) const

protected

{
    TRACE_CPUPROFILER_EVENT_SCOPE(AActorBase::LogDebugWarning);
    SCOPE_CYCLE_COUNTER(STATGROUP_BaseHelpers_ActorBase);
    LogDebugMessage(Message, true);
}

LogDebugWarning() [2/3]

void AActorBase::LogDebugWarning ( const FString & Message, const float Value ) const

protected

{
    TRACE_CPUPROFILER_EVENT_SCOPE(AActorBase::LogDebugWarning);
    SCOPE_CYCLE_COUNTER(STATGROUP_BaseHelpers_ActorBase);
    LogDebugMessage(Message, Value, true);
}

LogDebugWarning() [3/3]

void AActorBase::LogDebugWarning ( const FString & Message, const int32 Value ) const

protected

{
    TRACE_CPUPROFILER_EVENT_SCOPE(AActorBase::LogDebugWarning);
    SCOPE_CYCLE_COUNTER(STATGROUP_BaseHelpers_ActorBase);
    LogDebugMessage(Message, Value, true);
}

LogOnScreenMessage()

void AActorBase::LogOnScreenMessage ( const int32 Key, const FString & Message, FColor Color = FColor::Green ) const

protected

{
    TRACE_CPUPROFILER_EVENT_SCOPE(AActorBase::LogOnScreenMessage);
    // SCOPE_CYCLE_COUNTER(STATGROUP_BaseHelpers_ActorBase);
    if(bDebuggingMode)
    {
        GEngine->AddOnScreenDebugMessage(Key, 2.0f, Color,
            FString::Printf(TEXT(" %s  - in %s of %s"), ToCStr(Message), ToCStr(GetName()), ToCStr(GetOwner()->GetName())));
    }
}

SaveGame()

bool AActorBase::SaveGame ( )

overridevirtual

Implements ISaveLoad.

{
    const bool bComponentsSaved = USaveLoadBPLib::SaveAllComponents(this);
    return bComponentsSaved;
}

SetCategoryName()

void AActorBase::SetCategoryName ( const FLogCategoryBase & Category )

inlineprotected

{CategoryName = Category.GetCategoryName();};

SetGravityEnabledEvent()

void AActorBase::SetGravityEnabledEvent

(

const bool

bValue

)

Member Data Documentation

bDebuggingMode

bool AActorBase::bDebuggingMode = false

protected

CategoryName

FLogCategoryName AActorBase::CategoryName = LogActorBase.GetCategoryName()

private

DisplayName

FString AActorBase::DisplayName = "Display Name"

protected

---

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

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/BaseHelpers/Source/BaseHelpers/Public/Actors/ActorBase.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/BaseHelpers/Source/BaseHelpers/Private/Actors/ActorBase.cpp