AWeaponPickupPad Class Reference

This class represents a weapon pickup pad in the game. More...

#include <WeaponPickupPad.h>

Inheritance diagram for AWeaponPickupPad:

Public Member Functions
	AWeaponPickupPad ()
virtual void	OnConstruction (const FTransform &Transform) override
virtual void	Tick (float DeltaTime) override
void	OnOverlapBegin (UPrimitiveComponent *OverlappedComponent, AActor *OtherActor, UPrimitiveComponent *OtherComp, int32 OtherBodyIndex, bool bFromSweep, const FHitResult &SweepHitResult)
void	CheckForExistingOverlaps ()
void	AttemptPickUpWeapon (APawn *Pawn)
void	OnRep_WeaponAvailability ()

Protected Member Functions
virtual void	BeginPlay () override
void	StartCoolDown ()
void	ResetCoolDown ()
void	OnCoolDownTimerComplete ()
void	SetWeaponPickupVisibility (bool bShouldBeVisible)
void	PlayPickupEffects ()
void	PlayRespawnEffects ()

Protected Attributes
TObjectPtr< UCapsuleComponent >	CollisionVolume
USceneComponent *	RootSceneComponent
TObjectPtr< UStaticMeshComponent >	PadMesh
TObjectPtr< USkeletalMeshComponent >	WeaponMesh
FWeaponData_T	WeaponDefinition
bool	bIsWeaponAvailable
float	CoolDownTime
float	CheckExistingOverlapDelay
float	CoolDownPercentage
float	WeaponMeshRotationSpeed
FTimerHandle	CoolDownTimerHandle
FTimerHandle	CheckOverlapsDelayTimerHandle

Detailed Description

This class represents a weapon pickup pad in the game.

Weapons can be spawned on these pads and picked up by players. Players can pick the weapon up again after a cooldown.

See also

WeaponPickupPad

Constructor & Destructor Documentation

AWeaponPickupPad()

AWeaponPickupPad::AWeaponPickupPad

(

)

{
    PrimaryActorTick.bCanEverTick = true;
    RootComponent = CollisionVolume = CreateDefaultSubobject<UCapsuleComponent>(TEXT("CollisionVolume"));
    CollisionVolume->InitCapsuleSize(80.f, 80.f);
    CollisionVolume->OnComponentBeginOverlap.AddDynamic(this, &AWeaponPickupPad::OnOverlapBegin);
    
    PadMesh = CreateDefaultSubobject<UStaticMeshComponent>(TEXT("PadMesh"));
    PadMesh->SetupAttachment(RootComponent);
    
    WeaponMesh = CreateDefaultSubobject<USkeletalMeshComponent>(TEXT("WeaponMesh"));
    WeaponMesh->SetupAttachment(RootComponent);
 
    WeaponMeshRotationSpeed = 40.0f;
    CoolDownTime = 30.0f;
    CheckExistingOverlapDelay = 0.25f;
    bIsWeaponAvailable = true;
    bReplicates = true;
}

Member Function Documentation

AttemptPickUpWeapon()

void AWeaponPickupPad::AttemptPickUpWeapon

(

APawn *

Pawn

)

BeginPlay()

void AWeaponPickupPad::BeginPlay ( )

overrideprotectedvirtual

{
    Super::BeginPlay();
    if(WeaponMesh->GetSkeletalMeshAsset() == nullptr)
    {
        UE_LOG(LogWeaponSystem, Error, TEXT("'%s' does not have a valid weapon definition! Make sure to set this data on the instance!"), *GetNameSafe(this));
    }
}

CheckForExistingOverlaps()

void AWeaponPickupPad::CheckForExistingOverlaps

(

)

{
    TArray<AActor*> OverlappingActors;
    GetOverlappingActors(OverlappingActors, APawn::StaticClass());
 
    for (AActor* OverlappingActor : OverlappingActors)
    {
        AttemptPickUpWeapon(Cast<APawn>(OverlappingActor));
    }
}

OnConstruction()

void AWeaponPickupPad::OnConstruction ( const FTransform & Transform )

overridevirtual

{
    if(WeaponDefinition.IsValid())
    {
        bool bSuccess = false;
        USkeletalMesh* MeshForPickup = UWeaponBPLib::GetWeaponMesh(this, WeaponDefinition.WeaponID, bSuccess);
        if(bSuccess && MeshForPickup != nullptr)
        {
            WeaponMesh->SetSkeletalMeshAsset(MeshForPickup);
        }
        WeaponMesh->SetRelativeLocation(WeaponDefinition.WeaponOffset);
        // WeaponMesh->SetRelativeRotation(WeaponDefinition.RotationOffset);
    }   
}

OnCoolDownTimerComplete()

void AWeaponPickupPad::OnCoolDownTimerComplete ( )

protected

{
    ResetCoolDown();
}

OnOverlapBegin()

void AWeaponPickupPad::OnOverlapBegin	(	UPrimitiveComponent *	OverlappedComponent,
		AActor *	OtherActor,
		UPrimitiveComponent *	OtherComp,
		int32	OtherBodyIndex,
		bool	bFromSweep,
		const FHitResult &	SweepHitResult )

{
    APawn* OverlappingPawn = Cast<APawn>(OtherActor);
    if (GetLocalRole() == ROLE_Authority && bIsWeaponAvailable && OverlappingPawn != nullptr)
    {
        AttemptPickUpWeapon(OverlappingPawn);
    }
}

OnRep_WeaponAvailability()

void AWeaponPickupPad::OnRep_WeaponAvailability

(

)

{
    if (bIsWeaponAvailable)
    {
        PlayRespawnEffects();
        SetWeaponPickupVisibility(true);
    }
    else
    {
        SetWeaponPickupVisibility(false);
        StartCoolDown();
        PlayPickupEffects();
    }
}

PlayPickupEffects()

void AWeaponPickupPad::PlayPickupEffects ( )

protected

PlayRespawnEffects()

void AWeaponPickupPad::PlayRespawnEffects ( )

protected

ResetCoolDown()

void AWeaponPickupPad::ResetCoolDown ( )

protected

{
    UWorld* World = GetWorld();
 
    if (World)
    {
        World->GetTimerManager().ClearTimer(CoolDownTimerHandle);
    }
 
    if (GetLocalRole() == ROLE_Authority)
    {
        bIsWeaponAvailable = true;
        PlayRespawnEffects();
        SetWeaponPickupVisibility(true);
 
        if (World)
        {
            World->GetTimerManager().SetTimer(CheckOverlapsDelayTimerHandle, this, &AWeaponPickupPad::CheckForExistingOverlaps, CheckExistingOverlapDelay);
        }
    }
    CoolDownPercentage = 0.0f;
}

SetWeaponPickupVisibility()

void AWeaponPickupPad::SetWeaponPickupVisibility ( bool bShouldBeVisible )

protected

{
    WeaponMesh->SetVisibility(bShouldBeVisible, true);
}

StartCoolDown()

void AWeaponPickupPad::StartCoolDown ( )

protected

{
    if (UWorld* World = GetWorld())
    {
        World->GetTimerManager().SetTimer(CoolDownTimerHandle, this, &AWeaponPickupPad::OnCoolDownTimerComplete, CoolDownTime);
    }
}

Tick()

void AWeaponPickupPad::Tick ( float DeltaTime )

overridevirtual

{
    Super::Tick(DeltaTime);
 
    //Update the CoolDownPercentage property to drive respawn time indicators
    UWorld* World = GetWorld();
    if(World->GetTimerManager().IsTimerActive(CoolDownTimerHandle))
    {
        CoolDownPercentage = 1.0f - World->GetTimerManager().GetTimerRemaining(CoolDownTimerHandle)/CoolDownTime;
    }
    WeaponMesh->AddRelativeRotation(FRotator(0.0f, World->GetDeltaSeconds() * WeaponMeshRotationSpeed, 0.0f));
}

Member Data Documentation

bIsWeaponAvailable

bool AWeaponPickupPad::bIsWeaponAvailable

protected

CheckExistingOverlapDelay

float AWeaponPickupPad::CheckExistingOverlapDelay

protected

CheckOverlapsDelayTimerHandle

FTimerHandle AWeaponPickupPad::CheckOverlapsDelayTimerHandle

protected

CollisionVolume

TObjectPtr<UCapsuleComponent> AWeaponPickupPad::CollisionVolume

protected

CoolDownPercentage

float AWeaponPickupPad::CoolDownPercentage

protected

CoolDownTime

float AWeaponPickupPad::CoolDownTime

protected

CoolDownTimerHandle

FTimerHandle AWeaponPickupPad::CoolDownTimerHandle

protected

PadMesh

TObjectPtr<UStaticMeshComponent> AWeaponPickupPad::PadMesh

protected

RootSceneComponent

USceneComponent* AWeaponPickupPad::RootSceneComponent

protected

WeaponDefinition

FWeaponData_T AWeaponPickupPad::WeaponDefinition

protected

WeaponMesh

TObjectPtr<USkeletalMeshComponent> AWeaponPickupPad::WeaponMesh

protected

WeaponMeshRotationSpeed

float AWeaponPickupPad::WeaponMeshRotationSpeed

protected

---

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

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