AInteractablePawn Class Reference

#include <InteractablePawn.h>

Inheritance diagram for AInteractablePawn:

Public Member Functions
	AInteractablePawn ()
virtual void	ReceiveStartFocus (AActor *Caller)
virtual void	ReceiveEndFocus (AActor *Caller)
virtual void	ReceiveOnInteract (AActor *Caller, const EInteractionType InteractionType)
virtual void	ReceiveOnEndInteract (AActor *Caller)
virtual void	ReceiveOnOverlap (AActor *Caller)
virtual void	ReceiveOnEndOverlap (AActor *Caller)
virtual void	ReceiveToggleSwitch (AActor *Caller, const bool bOn)
virtual void	InteractionDataUpdated ()
virtual void	SetupPlayerInputComponent (class UInputComponent *PlayerInputComponent) override

Protected Member Functions
virtual void	BeginPlay () override
virtual bool	SaveGame () override
virtual bool	LoadGame () override
FVector	GetCustomInteractionLocation () const
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
class UAudioReactionComponent *	AudioReactionComponent
class UInteractableActorComponent *	InteractableActorComponent
class UAIPerceptionStimuliSourceComponent *	PerceptionStimuliComponent
bool	bDebuggingMode = false

Private Attributes
FLogCategoryName	CategoryName = LogInteractablePawn.GetCategoryName()

Constructor & Destructor Documentation

AInteractablePawn()

AInteractablePawn::AInteractablePawn

(

)

{
    PrimaryActorTick.bCanEverTick = true;
    AudioReactionComponent = CreateDefaultSubobject<UAudioReactionComponent>("Audio Reaction");
    InteractableActorComponent = CreateDefaultSubobject<UInteractableActorComponent>(TEXT("Interactable Actor Component"));
    InteractableActorComponent->OnInteractDelegate.AddUniqueDynamic(this, &AInteractablePawn::ReceiveOnInteract);
    InteractableActorComponent->OnEndInteractDelegate.AddUniqueDynamic(this, &AInteractablePawn::ReceiveOnEndInteract);
    InteractableActorComponent->OnStartFocusDelegate.AddUniqueDynamic(this, &AInteractablePawn::ReceiveStartFocus);
    InteractableActorComponent->OnEndFocusDelegate.AddUniqueDynamic(this, &AInteractablePawn::ReceiveEndFocus);
    InteractableActorComponent->OnToggleSwitchDelegate.AddUniqueDynamic(this, &AInteractablePawn::ReceiveToggleSwitch);
    InteractableActorComponent->OnOverlapDelegate.AddUniqueDynamic(this, &AInteractablePawn::ReceiveOnOverlap);
    InteractableActorComponent->OnEndOverlapDelegate.AddUniqueDynamic(this, &AInteractablePawn::ReceiveOnEndOverlap);
    InteractableActorComponent->OnInteractionDataUpdated.AddUniqueDynamic(this, &AInteractablePawn::InteractionDataUpdated);
    InteractableActorComponent->bPickupOnOverlap = false;
    InteractableActorComponent->InteractionData = FInteractionData(EInteractionType::Pilot, EAIStimuliType::Vehicle);
    InteractableActorComponent->bAlwaysShowOutline = true;
    InteractableActorComponent->bOutlineMeshOnFocus = true;
    PerceptionStimuliComponent = CreateDefaultSubobject<UAIPerceptionStimuliSourceComponent>("Perception Stimuli");
    PerceptionStimuliComponent->RegisterForSense(UAISenseConfig_Sight::StaticClass());
#if WITH_EDITOR
    bDebuggingMode = true;
#endif
}

Member Function Documentation

BeginPlay()

void AInteractablePawn::BeginPlay ( )

overrideprotectedvirtual

Reimplemented in AAutoTurret, ADefenseSystemPawn, ASecurityCameraPawn, AShipPawn, and AShipTurret.

{
    Super::BeginPlay();
    PerceptionStimuliComponent->RegisterWithPerceptionSystem();
}

GetCustomInteractionLocation()

FVector AInteractablePawn::GetCustomInteractionLocation ( ) const

protected

InteractionDataUpdated()

void AInteractablePawn::InteractionDataUpdated ( )

virtual

{
    
}

LoadGame()

bool AInteractablePawn::LoadGame ( )

overrideprotectedvirtual

Implements ISaveLoad.

{
    const bool bComponentsLoaded = USaveLoadBPLib::LoadAllComponents(this);
    if(bComponentsLoaded == false)
    {
        LogDebugError("Load components Failed");
    }
    return true;
}

LogDebugError() [1/3]

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

protected

{
    TRACE_CPUPROFILER_EVENT_SCOPE(AInteractablePawn::LogDebugError);
    // SCOPE_CYCLE_COUNTER(STATGROUP_BaseHelpers_CharacterBase);
    LogDebugMessage(Message, true, true);
}

LogDebugError() [2/3]

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

protected

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

LogDebugError() [3/3]

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

protected

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

LogDebugMessage() [1/4]

void AInteractablePawn::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 AInteractablePawn::LogDebugMessage ( const FString & Message, const bool bWarning = false, const bool bError = false ) const

protected

{
    TRACE_CPUPROFILER_EVENT_SCOPE(AInteractablePawn::LogDebugMessage);
    // SCOPE_CYCLE_COUNTER(STATGROUP_BaseHelpers_CharacterBase);
    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 AInteractablePawn::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 AInteractablePawn::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 AInteractablePawn::LogDebugWarning ( const FString & Message ) const

protected

{
    TRACE_CPUPROFILER_EVENT_SCOPE(AInteractablePawn::LogDebugWarning);
    // SCOPE_CYCLE_COUNTER(STATGROUP_BaseHelpers_CharacterBase);
    LogDebugMessage(Message, true);
}

LogDebugWarning() [2/3]

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

protected

{
    TRACE_CPUPROFILER_EVENT_SCOPE(AInteractablePawn::LogDebugWarning);
    // SCOPE_CYCLE_COUNTER(STATGROUP_BaseHelpers_CharacterBase);
    LogDebugMessage(Message, Value, true);
}

LogDebugWarning() [3/3]

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

protected

{
    TRACE_CPUPROFILER_EVENT_SCOPE(AInteractablePawn::LogDebugWarning);
    // SCOPE_CYCLE_COUNTER(STATGROUP_BaseHelpers_CharacterBase);
    LogDebugMessage(Message, Value, true);
}

LogOnScreenMessage()

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

protected

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

ReceiveEndFocus()

void AInteractablePawn::ReceiveEndFocus ( AActor * Caller )

virtual

{
}

ReceiveOnEndInteract()

void AInteractablePawn::ReceiveOnEndInteract ( AActor * Caller )

virtual

{
}

ReceiveOnEndOverlap()

void AInteractablePawn::ReceiveOnEndOverlap ( AActor * Caller )

virtual

{
}

ReceiveOnInteract()

void AInteractablePawn::ReceiveOnInteract ( AActor * Caller, const EInteractionType InteractionType )

virtual

{
}

ReceiveOnOverlap()

void AInteractablePawn::ReceiveOnOverlap ( AActor * Caller )

virtual

{
}

ReceiveStartFocus()

void AInteractablePawn::ReceiveStartFocus ( AActor * Caller )

virtual

{
    
}

ReceiveToggleSwitch()

void AInteractablePawn::ReceiveToggleSwitch ( AActor * Caller, const bool bOn )

virtual

{
}

SaveGame()

bool AInteractablePawn::SaveGame ( )

overrideprotectedvirtual

Implements ISaveLoad.

{
    const bool bComponentsSaved = USaveLoadBPLib::SaveAllComponents(this);
    if(bComponentsSaved == false)
    {
        LogDebugError("Save components Failed");
    }
    return true;
}

SetCategoryName()

void AInteractablePawn::SetCategoryName ( const FLogCategoryBase & Category )

inlineprotected

{CategoryName = Category.GetCategoryName();};

SetupPlayerInputComponent()

void AInteractablePawn::SetupPlayerInputComponent ( class UInputComponent * PlayerInputComponent )

overridevirtual

{
    Super::SetupPlayerInputComponent(PlayerInputComponent);
}

Member Data Documentation

AudioReactionComponent

class UAudioReactionComponent* AInteractablePawn::AudioReactionComponent

protected

bDebuggingMode

bool AInteractablePawn::bDebuggingMode = false

protected

CategoryName

FLogCategoryName AInteractablePawn::CategoryName = LogInteractablePawn.GetCategoryName()

private

InteractableActorComponent

class UInteractableActorComponent* AInteractablePawn::InteractableActorComponent

protected

PerceptionStimuliComponent

class UAIPerceptionStimuliSourceComponent* AInteractablePawn::PerceptionStimuliComponent

protected

---

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

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/Interaction/Source/Interaction/Public/Characters/InteractablePawn.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/Interaction/Source/Interaction/Private/Characters/InteractablePawn.cpp