AInteractableActorWithPrompt Class Reference

#include <InteractableActorWithPrompt.h>

Inheritance diagram for AInteractableActorWithPrompt:

Public Member Functions
	AInteractableActorWithPrompt ()
Public Member Functions inherited from AInteractableActor
	AInteractableActor ()
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)
Public Member Functions inherited from AActorBase
	AActorBase ()
virtual bool	SaveGame () override
virtual bool	LoadGame () override
void	SetGravityEnabledEvent (const bool bValue)

Protected Member Functions
virtual void	BeginPlay () override
virtual void	InteractionComplete ()
void	OnInteractionComplete (AActor *Caller)
void	HideButtonPrompt ()
Protected Member Functions inherited from AInteractableActor
virtual void	Tick (float DeltaTime) override
virtual void	SetMeshOutline (const bool bValue)
Protected Member Functions inherited from AActorBase
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 UInteractionPromptComponent *	InteractionPromptComponent
class USphereComponent *	InteractionPromptCollision
class USceneComponent *	SceneRootComponent
bool	bHasProgress = true
float	PromptHeight = 75.0f
AActor *	CurrentInteractCaller = nullptr
float	HidePromptTime = 2.5f
Protected Attributes inherited from AInteractableActor
class UInteractableActorComponent *	InteractableActorComponent
class UAudioReactionComponent *	AudioReactionComponent
class UAIPerceptionStimuliSourceComponent *	PerceptionStimuliComponent
Protected Attributes inherited from AActorBase
FString	DisplayName = "Display Name"
bool	bDebuggingMode = false

Private Attributes
FTimerHandle	HidePromptTimerHandle
class UButtonPromptWidget *	ButtonPromptWidget = nullptr

Detailed Description

The AInteractableActorWithPrompt class represents an interactable actor with a prompt for interaction. It inherits from AInteractableActor class.

Constructor & Destructor Documentation

AInteractableActorWithPrompt()

AInteractableActorWithPrompt::AInteractableActorWithPrompt ( )

explicit

{
    SceneRootComponent = CreateOptionalDefaultSubobject<USceneComponent>("Scene Root");
    RootComponent = SceneRootComponent;
    
    InteractionPromptComponent = CreateOptionalDefaultSubobject<UInteractionPromptComponent>("Interaction Prompt");
    if(InteractionPromptComponent != nullptr)
    {
        InteractionPromptComponent->SetupAttachment(RootComponent);
    }
 
    InteractionPromptCollision = CreateDefaultSubobject<USphereComponent>("Interaction Collision");
    InteractionPromptCollision->SetupAttachment(RootComponent);
 
    
    InteractionPromptCollision->SetCollisionResponseToAllChannels(ECR_Ignore);
    InteractionPromptCollision->SetCollisionResponseToChannel(ECC_Pawn, ECR_Overlap);
 
}

Member Function Documentation

BeginPlay()

void AInteractableActorWithPrompt::BeginPlay ( )

overrideprotectedvirtual

Reimplemented from AInteractableActor.

Reimplemented in AWeaponAttachmentPickup, and AWeaponPickup.

{
    Super::BeginPlay();
    // if(InteractionPromptComponent != nullptr)
    // {
    //  InteractionPromptComponent->OnInteractionComplete.AddUniqueDynamic(this, &AInteractableActorWithPrompt::InteractionComplete);
    //  InteractionPromptComponent->SetHasProgressBar(bHasProgress);
    //  InteractionPromptComponent->SetCollapsed(true);
    //  //! Remove getting if has progress bar from widget, should be decided by actor ,
    // }
}

HideButtonPrompt()

void AInteractableActorWithPrompt::HideButtonPrompt ( )

protected

{
    GetWorld()->GetTimerManager().ClearTimer(HidePromptTimerHandle);
    if(InteractionPromptComponent == nullptr){return;}
    InteractionPromptComponent->SetCollapsed(true);
}

InteractionComplete()

void AInteractableActorWithPrompt::InteractionComplete ( )

protectedvirtual

Reimplemented in AWeaponAttachmentPickup, and AWeaponPickup.

{
    UE_LOG(LogTemp,Warning,TEXT("Interaction Complete"));
    OnInteractionComplete(CurrentInteractCaller);
    CurrentInteractCaller = nullptr;
}

OnInteractionComplete()

void AInteractableActorWithPrompt::OnInteractionComplete ( AActor * Caller )

protected

Member Data Documentation

bHasProgress

bool AInteractableActorWithPrompt::bHasProgress = true

protected

ButtonPromptWidget

class UButtonPromptWidget* AInteractableActorWithPrompt::ButtonPromptWidget = nullptr

private

CurrentInteractCaller

AActor* AInteractableActorWithPrompt::CurrentInteractCaller = nullptr

protected

HidePromptTime

float AInteractableActorWithPrompt::HidePromptTime = 2.5f

protected

HidePromptTimerHandle

FTimerHandle AInteractableActorWithPrompt::HidePromptTimerHandle

private

InteractionPromptCollision

class USphereComponent* AInteractableActorWithPrompt::InteractionPromptCollision

protected

InteractionPromptComponent

class UInteractionPromptComponent* AInteractableActorWithPrompt::InteractionPromptComponent

protected

PromptHeight

float AInteractableActorWithPrompt::PromptHeight = 75.0f

protected

SceneRootComponent

class USceneComponent* AInteractableActorWithPrompt::SceneRootComponent

protected

---

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

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