AWeaponAttachmentPickup Class Reference

Pickup for weapon attachments. More...

#include <WeaponAttachmentPickup.h>

Inheritance diagram for AWeaponAttachmentPickup:

Public Member Functions
	AWeaponAttachmentPickup (const FObjectInitializer &ObjectInitializer)
Public Member Functions inherited from AInteractableActorWithPrompt
	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)

Public Attributes
FString	AttachmentPickupID

Protected Member Functions
virtual void	BeginPlay () override
virtual void	OnInteract (AActor *Caller, const int32 SelectedInteraction) override
virtual void	InteractionComplete () override
virtual void	OnEndInteract (AActor *Caller) override
virtual bool	OnOverlap (AActor *Caller) override
virtual void	StartFocus () override
virtual void	EndFocus () override
virtual void	ToggleSwitch (AActor *Caller, bool bOn) override
virtual FVector	GetInteractionLocation () const override
virtual UPrimitiveComponent *	GetGrabComponent () const override
Protected Member Functions inherited from AInteractableActorWithPrompt
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 UStaticMeshComponent *	AttachmentMesh
class UCapsuleComponent *	CapsuleComponent
Protected Attributes inherited from AInteractableActorWithPrompt
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 Member Functions
void	SetMesh () const

Private Attributes
FWeaponAttachment	AttachmentPickupData

Detailed Description

Pickup for weapon attachments.

This class inherits from AInteractableActorWithPrompt and provides functionality specific to weapon attachment pickups.

Constructor & Destructor Documentation

AWeaponAttachmentPickup()

AWeaponAttachmentPickup::AWeaponAttachmentPickup

(

const FObjectInitializer &

ObjectInitializer

)

    : Super(ObjectInitializer.DoNotCreateDefaultSubobject(TEXT("Scene Root")))
{
    bReplicates = true;
    SetReplicatingMovement(true);
    AttachmentMesh = CreateDefaultSubobject<UStaticMeshComponent>("Attachment Mesh");
    AttachmentMesh->SetGenerateOverlapEvents(true);
    AttachmentMesh->SetCollisionProfileName(TEXT("DefaultPickup"));
    AttachmentMesh->SetSimulatePhysics(true);
    AttachmentMesh->SetRenderCustomDepth(true);
    RootComponent = AttachmentMesh;
    AttachmentMesh->bRenderCustomDepth = false;
    
    CapsuleComponent = CreateDefaultSubobject<UCapsuleComponent>("Capsule Component");
    CapsuleComponent->SetupAttachment(AttachmentMesh);
    CapsuleComponent->SetWorldRotation(FRotator(0,0,90));
    FWalkableSlopeOverride WalkableSlopeOverride;
    WalkableSlopeOverride.WalkableSlopeBehavior = EWalkableSlopeBehavior::WalkableSlope_Unwalkable;
    CapsuleComponent->SetWalkableSlopeOverride(WalkableSlopeOverride);
    
    InteractionData = FInteractionData(EInteractionType::Pickup, EAIStimuliType::WeaponAttachment);
    InteractionPromptComponent->SetupAttachment(AttachmentMesh);
    InteractionPromptCollision->SetupAttachment(AttachmentMesh);
 
}

Member Function Documentation

BeginPlay()

void AWeaponAttachmentPickup::BeginPlay ( )

overrideprotectedvirtual

Reimplemented from AInteractableActorWithPrompt.

{
    Super::BeginPlay();
    bool bSuccess = false;
    AttachmentPickupData = UWeaponBPLib::GetWeaponAttachment(this, AttachmentPickupID, bSuccess);
    if(!bSuccess)
    {
        UE_LOG(LogWeaponSystem, Error, TEXT("Attachment FAiled to Create"));
        Destroy();
    }
    DisplayName = AttachmentPickupData.AttachmentTypeName().ToString();
    SetMesh();
    
}

EndFocus()

void AWeaponAttachmentPickup::EndFocus ( )

overrideprotectedvirtual

{
    Super::EndFocus();
    if(AttachmentMesh != nullptr)
    {
        AttachmentMesh->SetRenderCustomDepth(false);
    }
}

GetGrabComponent()

virtual UPrimitiveComponent * AWeaponAttachmentPickup::GetGrabComponent ( ) const

inlineoverrideprotectedvirtual

{return Cast<UPrimitiveComponent>(RootComponent);};

GetInteractionLocation()

FVector AWeaponAttachmentPickup::GetInteractionLocation ( ) const

overrideprotectedvirtual

{
    return Super::GetInteractionLocation();
}

InteractionComplete()

void AWeaponAttachmentPickup::InteractionComplete ( )

overrideprotectedvirtual

Reimplemented from AInteractableActorWithPrompt.

{
    Super::InteractionComplete();
    if(CurrentInteractCaller == nullptr){return;}
    ICharacterWeaponPickups* CharacterInteracting = Cast<ICharacterWeaponPickups>(CurrentInteractCaller);
    IBaseServer* ServerCharacterInteracting = Cast<IBaseServer>(CurrentInteractCaller);
    if(CharacterInteracting != nullptr)
    {
        CharacterInteracting->PickupAttachmentEvent(AttachmentPickupID);
        if(ServerCharacterInteracting != nullptr)
        {
            ServerCharacterInteracting->DestroyActor(this);
        }
    }
}

OnEndInteract()

void AWeaponAttachmentPickup::OnEndInteract ( AActor * Caller )

overrideprotectedvirtual

{
    Super::OnEndInteract(Caller);
    if(InteractionPromptComponent != nullptr)
    {
        InteractionPromptComponent->SetAvailable();
    }
}

OnInteract()

void AWeaponAttachmentPickup::OnInteract ( AActor * Caller, const int32 SelectedInteraction )

overrideprotectedvirtual

{
    ICharacterWeaponPickups* CharacterInteracting = Cast<ICharacterWeaponPickups>(Caller);
    if(CharacterInteracting == nullptr){return;}
    if(!AttachmentPickupData.IsValid()){return;}
 
    SetOwner(Caller);
    const bool bCanPickup = CharacterInteracting->PickupAttachmentCheck(AttachmentPickupData);
    if(bCanPickup)
    {
        if(InteractionPromptComponent != nullptr)
        {
            InteractionPromptComponent->SetAvailable();
        }
        Super::OnInteract(Caller, SelectedInteraction);
    }
    else
    {
        if(InteractionPromptComponent != nullptr)
        {
            InteractionPromptComponent->SetUnavailable();
        }
    }   
}

OnOverlap()

bool AWeaponAttachmentPickup::OnOverlap ( AActor * Caller )

overrideprotectedvirtual

{
    return Super::OnOverlap(Caller);
}

SetMesh()

void AWeaponAttachmentPickup::SetMesh ( ) const

private

{
    if(AttachmentPickupData.StaticMesh != nullptr && AttachmentMesh != nullptr)
    {
        AttachmentMesh->SetStaticMesh(AttachmentPickupData.StaticMesh);
    }
}

StartFocus()

void AWeaponAttachmentPickup::StartFocus ( )

overrideprotectedvirtual

{
    Super::StartFocus();
    if(AttachmentMesh != nullptr)
    {
        AttachmentMesh->SetRenderCustomDepth(true);
    }
}

ToggleSwitch()

void AWeaponAttachmentPickup::ToggleSwitch ( AActor * Caller, bool bOn )

overrideprotectedvirtual

{
    Super::ToggleSwitch(Caller, bOn);
}

Member Data Documentation

AttachmentMesh

class UStaticMeshComponent* AWeaponAttachmentPickup::AttachmentMesh

protected

AttachmentPickupData

FWeaponAttachment AWeaponAttachmentPickup::AttachmentPickupData

private

AttachmentPickupID

FString AWeaponAttachmentPickup::AttachmentPickupID

CapsuleComponent

class UCapsuleComponent* AWeaponAttachmentPickup::CapsuleComponent

protected

---

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

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/WeaponSystem/Source/WeaponSystem/Public/Weapons/WeaponAttachmentPickup.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/WeaponSystem/Source/WeaponSystem/Private/Weapons/WeaponAttachmentPickup.cpp