Represents a weapon pickup in the game. More...

#include <WeaponPickup.h>

Inheritance diagram for AWeaponPickup:

Public Member Functions
	AWeaponPickup (const FObjectInitializer &ObjectInitializer)

virtual void	WeaponDroppedEvent (const FWeaponData_T &DroppedWeaponData) override

virtual void	AddImpulseToWeapon (const FVector &Impulse, const FName &BoneName=NAME_None, const bool bVelChange=false) override

virtual void	OnFinishSpawning () override

virtual void	MulticastOnFinishSpawning ()

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)

Protected Member Functions
virtual void	OnConstruction (const FTransform &Transform) override

virtual void	BeginPlay () override

void	SetMesh () const

void	SetAttachments ()

void	AddAttachment (const FString &AttachmentID)

virtual void	Multicast_WeaponDroppedEvent (const FWeaponData_T &DroppedWeaponData)

virtual void	OnInteract (AActor *Caller, const int32 InteractionType) 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
bool	bManuallySpawned = true

FString	WeaponID = "DefaultWeapon"

bool	bOverrideWeaponData = false

FWeaponData_T	WeaponPickupData

class USkeletalMeshComponent *	GunMesh

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

Detailed Description

Represents a weapon pickup in the game.

This class inherits from AActor and implements several interfaces for interaction and pickup functionality.

See also: WeaponPickup

Constructor & Destructor Documentation

◆ AWeaponPickup()

AWeaponPickup::AWeaponPickup ( const FObjectInitializer & ObjectInitializer )

explicit

    : AInteractableActorWithPrompt(ObjectInitializer
        .DoNotCreateDefaultSubobject(TEXT("Scene Root"))
        .DoNotCreateDefaultSubobject(TEXT("Interaction Prompt")))
{
    bReplicates = true;
    SetReplicatingMovement(true);
    GunMesh = CreateDefaultSubobject<USkeletalMeshComponent>("Gun Mesh");
    GunMesh->SetGenerateOverlapEvents(true);
    GunMesh->SetCollisionProfileName(TEXT("DefaultPickup"));
    GunMesh->SetSimulatePhysics(true);
    GunMesh->SetRenderCustomDepth(true);
    RootComponent = GunMesh;
    
    GunMesh->bRenderCustomDepth = false;
    CapsuleComponent = CreateDefaultSubobject<UCapsuleComponent>("Capsule Component");
    CapsuleComponent->SetupAttachment(GunMesh);
    CapsuleComponent->SetWorldRotation(FRotator(0,0,90));
    FWalkableSlopeOverride WalkableSlopeOverride;
    WalkableSlopeOverride.WalkableSlopeBehavior = EWalkableSlopeBehavior::WalkableSlope_Unwalkable;
    CapsuleComponent->SetWalkableSlopeOverride(WalkableSlopeOverride);
    
    InteractionData = FInteractionData(EInteractionType::Pickup, EAIStimuliType::WeaponPickup);
    InteractionPromptCollision->SetupAttachment(GunMesh);
    bLoseFocusAfterInteract = true;
}

Member Function Documentation

◆ AddAttachment()

void AWeaponPickup::AddAttachment ( const FString & AttachmentID )

protected

{
    SCOPE_CYCLE_COUNTER(STATGROUP_WeaponSystem_Weapons);
    TRACE_CPUPROFILER_EVENT_SCOPE(AWeaponPickup::AddAttachment);
    bool bSuccess = false;
    const FWeaponAttachment WeaponAttachment = UWeaponBPLib::GetWeaponAttachment(this, AttachmentID, bSuccess);
    if(!bSuccess){return;}
    if(!WeaponAttachment.IsValid()){return;}
    if(!GunMesh->DoesSocketExist(WeaponAttachment.AttachmentTypeName())){return;}
    
    const FWeaponStats_T WeaponStats = UWeaponBPLib::GetWeaponStats(this, WeaponPickupData.WeaponID, bSuccess);
    if(!bSuccess){return;}
    if(!WeaponStats.GetIsAttachmentCompatible(AttachmentID, WeaponAttachment.AttachmentType)){return;}
        
    UStaticMeshComponent* AttachmentComponent = NewObject<UStaticMeshComponent>(this);
    if(AttachmentComponent == nullptr){return;}
    AttachmentComponent->RegisterComponent(); 
    AttachmentComponent->SetStaticMesh(WeaponAttachment.StaticMesh);
    AttachmentComponent->SetCollisionEnabled(ECollisionEnabled::NoCollision);
    AttachmentComponent->AttachToComponent(GunMesh, FAttachmentTransformRules::SnapToTargetIncludingScale, WeaponAttachment.AttachmentTypeName());
    AttachmentComponent->ComponentTags.Add(FName(WeaponAttachment.WeaponAttachmentID));
    AttachmentComponent->ComponentTags.Add(WeaponAttachment.AttachmentTypeName());
    AttachmentComponent->SetRelativeLocation(WeaponAttachment.AttachmentOffset);
    AttachmentComponent->SetRelativeRotation(WeaponAttachment.AttachmentRotationOffset);
}

◆ AddImpulseToWeapon()

void AWeaponPickup::AddImpulseToWeapon	(	const FVector &	Impulse,
		const FName &	BoneName = NAME_None,
		const bool	bVelChange = false )

overridevirtual

Implements IWeaponPickupInterface.

{
    SCOPE_CYCLE_COUNTER(STATGROUP_WeaponSystem_Weapons);
    TRACE_CPUPROFILER_EVENT_SCOPE(AWeaponPickup::AddImpulseToWeapon);
    GunMesh->AddImpulse(Impulse, BoneName, bVelChange);
}

◆ BeginPlay()

void AWeaponPickup::BeginPlay ( )

overrideprotectedvirtual

Reimplemented from AInteractableActorWithPrompt.

{
    SCOPE_CYCLE_COUNTER(STATGROUP_WeaponSystem_Weapons);
    TRACE_CPUPROFILER_EVENT_SCOPE(AWeaponPickup::BeginPlay);
    Super::BeginPlay();
    DisplayName = UWeaponBPLib::GetWeaponDisplayName(this, WeaponID);
    if(bOverrideWeaponData)
    {
        DisplayName = UWeaponBPLib::GetWeaponDisplayName(this, WeaponPickupData.WeaponID);
        if(!bManuallySpawned)
        {
            if(UWeaponBPLib::GetDoesWeaponHaveBurstMode(this, WeaponPickupData.WeaponID)){WeaponPickupData.FireMode = EWeaponFireMode::Burst;}
            if(UWeaponBPLib::GetDoesWeaponHaveAutoMode(this, WeaponPickupData.WeaponID)){WeaponPickupData.FireMode = EWeaponFireMode::FullAuto;}
        }
    }
    else
    {
        bool bSuccess = false;
        WeaponPickupData = UWeaponBPLib::GetDefaultWeaponData(this, WeaponID, bSuccess);
        if(bSuccess == false)
        {
            UE_LOG(LogWeaponSystem, Error, TEXT("AWeaponPickup::BeginPlay Weapon Data Failed "));
            Destroy();
            return;
        }
    }
    SetMesh();
    SetAttachments();
}

◆ EndFocus()

void AWeaponPickup::EndFocus ( )

overrideprotectedvirtual

{
    SCOPE_CYCLE_COUNTER(STATGROUP_WeaponSystem_Weapons);
    TRACE_CPUPROFILER_EVENT_SCOPE(AWeaponPickup::EndFocus);
    Super::EndFocus();
    if(GunMesh != nullptr)
    {
        GunMesh->SetRenderCustomDepth(false);
    }
}

◆ GetGrabComponent()

virtual UPrimitiveComponent * AWeaponPickup::GetGrabComponent ( ) const

inlineoverrideprotectedvirtual

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

◆ GetInteractionLocation()

FVector AWeaponPickup::GetInteractionLocation ( ) const

overrideprotectedvirtual

{
    return GetActorLocation();
}

◆ InteractionComplete()

void AWeaponPickup::InteractionComplete ( )

overrideprotectedvirtual

Reimplemented from AInteractableActorWithPrompt.

{
    SCOPE_CYCLE_COUNTER(STATGROUP_WeaponSystem_Weapons);
    TRACE_CPUPROFILER_EVENT_SCOPE(AWeaponPickup::InteractionComplete);
    if(CurrentInteractCaller == nullptr){return;}
    ICharacterWeaponPickups* CharacterInteracting = Cast<ICharacterWeaponPickups>(CurrentInteractCaller);
    IBaseServer* ServerCharacterInteracting = Cast<IBaseServer>(CurrentInteractCaller);
    if(CharacterInteracting != nullptr)
    {
        const int32 RemainingAmmo = CharacterInteracting->PickupGunEvent(WeaponPickupData);
        if(RemainingAmmo)
        {
            WeaponPickupData.TotalAmmoCount = RemainingAmmo;
        }
        else
        {
            if(ServerCharacterInteracting != nullptr)
            {
                ServerCharacterInteracting->DestroyActor(this);
            }
        }
    }
    Super::InteractionComplete();
}

◆ Multicast_WeaponDroppedEvent()

virtual void AWeaponPickup::Multicast_WeaponDroppedEvent ( const FWeaponData_T & DroppedWeaponData )

protectedvirtual

◆ MulticastOnFinishSpawning()

virtual void AWeaponPickup::MulticastOnFinishSpawning ( )

virtual

◆ OnConstruction()

void AWeaponPickup::OnConstruction ( const FTransform & Transform )

overrideprotectedvirtual

{
    Super::OnConstruction(Transform);
    if(GunMesh != nullptr && GunMesh->GetSkeletalMeshAsset() == nullptr)
    {
        SetMesh();
    }
}

◆ OnEndInteract()

void AWeaponPickup::OnEndInteract ( AActor * Caller )

overrideprotectedvirtual

{
    SCOPE_CYCLE_COUNTER(STATGROUP_WeaponSystem_Weapons);
    TRACE_CPUPROFILER_EVENT_SCOPE(AWeaponPickup::OnEndInteract);
    Super::OnEndInteract(Caller);
    
    // if(InteractionPromptComponent != nullptr)
    // {
    //  InteractionPromptComponent->SetAvailable();
    // }
 
    
    // ICharacterWeaponPickups* CharacterInteracting = Cast<ICharacterWeaponPickups>(Caller);
    // IBaseServer* ServerCharacterInteracting = Cast<IBaseServer>(Caller);
    // if(CharacterInteracting != nullptr)
    // {
    //  const int32 RemainingAmmo = CharacterInteracting->PickupGunEvent(WeaponPickupData);
    //  if(RemainingAmmo)
    //  {
    //      WeaponPickupData.TotalAmmoCount = RemainingAmmo;
    //  }
    //  else
    //  {
    //      if(ServerCharacterInteracting != nullptr)
    //      {
    //          ServerCharacterInteracting->DestroyActor(this);
    //      }
    //  }
    // }
}

◆ OnFinishSpawning()

void AWeaponPickup::OnFinishSpawning ( )

overridevirtual

{
    SCOPE_CYCLE_COUNTER(STATGROUP_WeaponSystem_Weapons);
    TRACE_CPUPROFILER_EVENT_SCOPE(AWeaponPickup::OnFinishSpawning);
    DisplayName = UWeaponBPLib::GetWeaponDisplayName(this, WeaponPickupData.WeaponID);
    if(UWeaponBPLib::GetDoesWeaponHaveBurstMode(this, WeaponPickupData.WeaponID)){WeaponPickupData.FireMode = EWeaponFireMode::Burst;}
    if(UWeaponBPLib::GetDoesWeaponHaveAutoMode(this, WeaponPickupData.WeaponID)){WeaponPickupData.FireMode = EWeaponFireMode::FullAuto;}
    SetMesh();
    MulticastOnFinishSpawning();
}

◆ OnInteract()

void AWeaponPickup::OnInteract	(	AActor *	Caller,
		const int32	InteractionType )

overrideprotectedvirtual

{
    SCOPE_CYCLE_COUNTER(STATGROUP_WeaponSystem_Weapons);
    TRACE_CPUPROFILER_EVENT_SCOPE(AWeaponPickup::OnInteract);
    Super::OnInteract(Caller, InteractionType);
    if(Caller == nullptr){UE_LOG(LogWeaponSystem, Warning, TEXT("AWeaponPickup::OnInteract Caller NULLPTR "));return;}
    if(bDebuggingMode){UE_LOG(LogWeaponSystem, Warning, TEXT("AWeaponPickup::OnInteract %s %i "), *Caller->GetHumanReadableName(), InteractionType);}
    ICharacterWeaponPickups* CharacterInteracting = Cast<ICharacterWeaponPickups>(Caller);
    if(CharacterInteracting == nullptr){if(bDebuggingMode){UE_LOG(LogWeaponSystem, Warning, TEXT("AWeaponPickup::OnInteract CharacterInteracting"));}return;}
    if(!WeaponPickupData.IsValid()){if(bDebuggingMode){UE_LOG(LogWeaponSystem, Warning, TEXT("AWeaponPickup::OnInteract WeaponPickupData INVALID"));}return;}
 
    SetOwner(Caller);
    const bool bCanPickup = CharacterInteracting->PickupGunCheck(WeaponPickupData);
    if(bCanPickup)
    {
        InteractionComplete();
        // if(InteractionPromptComponent != nullptr)
        // {
        //  InteractionPromptComponent->SetAvailable();
        // }
    }
    else
    {
        // if(InteractionPromptComponent != nullptr)
        // {
        //  InteractionPromptComponent->SetUnavailable();
        // }
    }
}

◆ OnOverlap()

bool AWeaponPickup::OnOverlap ( AActor * Caller )

overrideprotectedvirtual

{
    SCOPE_CYCLE_COUNTER(STATGROUP_WeaponSystem_Weapons);
    TRACE_CPUPROFILER_EVENT_SCOPE(AWeaponPickup::OnOverlap);
    return Super::OnOverlap(Caller);
}

◆ SetAttachments()

void AWeaponPickup::SetAttachments ( )

protected

{
    SCOPE_CYCLE_COUNTER(STATGROUP_WeaponSystem_Weapons);
    TRACE_CPUPROFILER_EVENT_SCOPE(AWeaponPickup::SetAttachments);
    for(const FString& WeaponAttachmentID : WeaponPickupData.CurrentWeaponAttachments)
    {
        AddAttachment(WeaponAttachmentID);
    }
}

◆ SetMesh()

void AWeaponPickup::SetMesh ( ) const

protected

{
    SCOPE_CYCLE_COUNTER(STATGROUP_WeaponSystem_Weapons);
    TRACE_CPUPROFILER_EVENT_SCOPE(AWeaponPickup::SetMesh);
    bool bSuccess = false;
    const FWeaponStats_T WeaponStats = UWeaponBPLib::GetWeaponStats(this, WeaponID, bSuccess);
    if(bSuccess && WeaponStats.IsValid() && WeaponStats.MeshForPickup != nullptr)
    {
        GunMesh->SetSkeletalMesh(WeaponStats.MeshForPickup);
    }
}

◆ StartFocus()

void AWeaponPickup::StartFocus ( )

overrideprotectedvirtual

{
    SCOPE_CYCLE_COUNTER(STATGROUP_WeaponSystem_Weapons);
    TRACE_CPUPROFILER_EVENT_SCOPE(AWeaponPickup::StartFocus);
    Super::StartFocus();
    if(GunMesh != nullptr)
    {
        GunMesh->SetRenderCustomDepth(true);
    }
}

◆ ToggleSwitch()

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

overrideprotectedvirtual

{
    SCOPE_CYCLE_COUNTER(STATGROUP_WeaponSystem_Weapons);
    TRACE_CPUPROFILER_EVENT_SCOPE(AWeaponPickup::ToggleSwitch);
    UE_LOG(LogWeaponSystem,Warning,TEXT("Toggle Switch, Weapon pickup"));
}

◆ WeaponDroppedEvent()

void AWeaponPickup::WeaponDroppedEvent ( const FWeaponData_T & DroppedWeaponData )

overridevirtual

Implements IWeaponPickupInterface.

{
    SCOPE_CYCLE_COUNTER(STATGROUP_WeaponSystem_Weapons);
    TRACE_CPUPROFILER_EVENT_SCOPE(AWeaponPickup::WeaponDroppedEvent);
    if(!DroppedWeaponData.IsValid()){UE_LOG(LogWeaponSystem, Error, TEXT("No WeaponClass Was Set in Weapon Pickup"));return;}
    bOverrideWeaponData = true;
    WeaponID = DroppedWeaponData.WeaponID;
    WeaponPickupData = DroppedWeaponData;
    DisplayName = UWeaponBPLib::GetWeaponDisplayName(this, WeaponPickupData.WeaponID);
    SetMesh();
    SetAttachments();
    Multicast_WeaponDroppedEvent(WeaponPickupData);
}

Member Data Documentation

◆ bManuallySpawned

bool AWeaponPickup::bManuallySpawned = true

protected

If the weapon has been placed in the world, false if a player is dropping a weapon

◆ bOverrideWeaponData

bool AWeaponPickup::bOverrideWeaponData = false

protected

If we want it to spawn with custom weapon data, used for player dropped weapons and custom spawns

◆ CapsuleComponent

class UCapsuleComponent* AWeaponPickup::CapsuleComponent

protected

◆ GunMesh

class USkeletalMeshComponent* AWeaponPickup::GunMesh

protected

◆ WeaponID

FString AWeaponPickup::WeaponID = "DefaultWeapon"

protected

What Weapon it is, Will get the Default Weapon data from a DataTable

◆ WeaponPickupData

FWeaponData_T AWeaponPickup::WeaponPickupData

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AWeaponPickup()

Member Function Documentation

◆ AddAttachment()

◆ AddImpulseToWeapon()

◆ BeginPlay()

◆ EndFocus()

◆ GetGrabComponent()

◆ GetInteractionLocation()

◆ InteractionComplete()

◆ Multicast_WeaponDroppedEvent()

◆ MulticastOnFinishSpawning()

◆ OnConstruction()

◆ OnEndInteract()

◆ OnFinishSpawning()

◆ OnInteract()

◆ OnOverlap()

◆ SetAttachments()

◆ SetMesh()

◆ StartFocus()

◆ ToggleSwitch()

◆ WeaponDroppedEvent()

Member Data Documentation

◆ bManuallySpawned

◆ bOverrideWeaponData

◆ CapsuleComponent

◆ GunMesh

◆ WeaponID

◆ WeaponPickupData