WeaponInstanceRanged.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Weapons/WeaponInstance.h"
#include "Kismet/KismetMathLibrary.h"
#include "WeaponInstanceRanged.generated.h"
 
UENUM(BlueprintType)
enum class EMovementSpreadType : uint8
{
    NONE = 0,
    MoveTime = 1,       // Move Time applies spread based on for how long you have been moving
    VelocityBased = 2,  // Velocity Based lets you control spread amounts based on your speed using a curve;
};
 
 class UWeaponSpreadDataAsset;
 class UCurveFloat;
 
UCLASS()
class PROJECTX_API UWeaponInstanceRanged : public UWeaponInstance
{
    GENERATED_UCLASS_BODY()
    
//~ Begin UActorComponent Interface.
public:
    virtual void BeginPlay() override;
    virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override;
//~ End UActorComponent Interface.
 
public:
    virtual bool CanFire(EWeaponError& ErrorMessage, uint8 Mode) const override;
    virtual bool Fire(uint8 Mode, float WorldTimeOverride) override;
    virtual void FireComplete(uint8 Mode = 0) override;
    virtual void PrimaryFire(uint8 RemainingBurstCount); //BurstCount is the number of bursts left for this sequence.
    virtual float GetDamage(const FHitResult& HitResult, float DamgeModifier, const UWeaponComponent* WeaponComponent = NULL) const override;
    virtual bool IsHeadshot(const FHitResult& HitResult) const override;
    virtual float GetMovementSpreadModifier() const override;
    virtual float GetReticleSpreadMultiplier() const override;
    virtual float GetWeaponSpread() const override;
 
    /* Curve that modifies damage based on hit distance (in UU) */
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Weapon")
    UCurveFloat* DamageFalloffCurve = NULL;
protected:
    virtual void TickComponent(float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction) override;
    virtual void PlayWeaponFireEffects(uint8 BurstCounter = 0) override;
    virtual void PlayRecoil();
 
    virtual void UpdateSpread();
    virtual float GetCurrentSpread() const;
    virtual void ApplyConeSpread(FVector& Direction, float ProjectilePercent = 0.0f) const;
    virtual void ApplySpreadPattern(FVector& Direction, int ProjectileNum = 0) const;
    virtual void UpdateMovementSpread();
 
protected:
    //This is a weird number. It signifies how many shots have been validated for this weapon.
    UPROPERTY()
    uint8 FireValidationCount = 0;
    /* How many validations do we grant per fire? */
    UPROPERTY()
    uint8 ValidationsPerFire = 1;
 
    UPROPERTY()
    uint32 SpreadInterpolationID = INDEX_NONE;
 
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Recoil")
    bool bHasRecoil = false;
    /* Recoil played per shot expressed as pitch (x) and yaw (y) */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Recoil", meta = (EditCondition = "bHasRecoil"))
    FVector2D Recoil = FVector2D(0.05f, 0.05f);
    /* Rate at which recoil is applied */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Recoil", meta = (EditCondition = "bHasRecoil"))
    float RecoilRate = 0.075f;
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Recoil", meta = (EditCondition = "bHasRecoil"))
    TEnumAsByte<EEasingFunc::Type> RecoilEaseType;
 
    /* Modifies the recoil of weapons depending on tight aim progress */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Tight Aim", meta = (EditCondition = "bCanTightAim && bHasRecoil", DisplayAfter = "TightAimSpreadModifier"))
    FVector2D TightAimRecoilModifier = FVector2D(1.f, 1.f);
    /* Modifies the recoil rate of weapons depending on tight aim progress */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Tight Aim", meta = (EditCondition = "bCanTightAim && bHasRecoil", DisplayAfter = "TightAimRecoilModifier"))
    float TightAimRecoilRateModifier = 1.f;
    /*Multiplier on spread when the weapon is TightAiming. Normal strength is 1.0f */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Tight Aim", meta = (EditCondition = "bCanTightAim"))
    float TightAimSpreadPerShotMultiplier = 1.0f;
    /*Multiplier on spread decay rate when the weapon is TightAiming. Normal strength is 1.0f */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Tight Aim", meta = (EditCondition = "bCanTightAim"))
    float TightAimSpreadDecayRateMultiplier = 1.0f;
    
    /* does the weapon have a spread*/
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Spread")
    bool bHasSpread = false;
    /*Is the spread random or evenly distributed using a spread pattern? */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Spread")
    bool bRandomSpread = true;
 
    /* Does this weapon support Movement-Based Spread?*/
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Spread|MovementBased")
    bool bHasMovementBasedSpread = false;
    /* What type of movement based spread is applied to this weapon? */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Spread|MovementBased", meta = (EditCondition = "bHasMovementBasedSpread"))
    EMovementSpreadType MovementSpreadType = EMovementSpreadType::MoveTime;
    /* Does this weapon support Movement-Based Spread?*/
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Spread|MovementBased|Tight Aim", meta = (EditCondition = "bHasMovementBasedSpread"))
    bool bApplyMovementSpreadWhenTightAiming = true;
    /* How much of the movement-based spread to be applied when tight aiming? [0-1] */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Spread|MovementBased|Tight Aim", meta = (EditCondition = "bHasMovementBasedSpread && bApplyMovementSpreadWhenTightAiming"))
    float MovementSpreadTightAimingMultiplier = 1.f;
    /* A multiplier to the spread caused by movement when it reaches its max amount*/
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Spread|MovementBased|MoveTime", meta = (EditCondition = "bHasMovementBasedSpread && MovementSpreadType == EMovementSpreadType::MoveTime"))
    float MovementSpreadMultiplier = 1.2f;
    /* How long does it take for the max movement-based spread multiplier to be added at full (in seconds)? */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Spread|MovementBased|MoveTime", meta = (EditCondition = "bHasMovementBasedSpread && MovementSpreadType == EMovementSpreadType::MoveTime"))
    float TimeToReachMaxMovementSpreadMultiplier = 0.25f;
    /* How long does it take for the weapon to recovery from a full movement-based spread multiplier (in seconds)? */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Spread|MovementBased|MoveTime", meta = (EditCondition = "bHasMovementBasedSpread && MovementSpreadType == EMovementSpreadType::MoveTime"))
    float TimeToRecoveryFromMovementSpreadMultiplier = 0.25f;
    /*Multiplier on cone spread when crouching. Normal strength is 1.0f */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Spread|Crouch", meta = (EditCondition = "bCanTightAim"))
    float CrouchConeSpreadMultiplier = 1.0f;
 
    /* A curve that control how much movement-based spread we will apply based on the current speed */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Spread|MovementBased|VelocityBased", meta = (EditCondition = "bHasMovementBasedSpread && MovementSpreadType == EMovementSpreadType::VelocityBased"))
    UCurveFloat* VelocityBasedSpreadCurve = NULL;
 
    /* An Weapon Spread Data Asset that can be used for baked spreads */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Spread", meta = (EditCondition = "bHasSpread && !bRandomSpread"))
    UWeaponSpreadDataAsset* BakedSpreadConfigDataAsset = NULL;
    /* A zero conespread is perfect aim, larger numbers will cause shots to miss further targets more frequently. (Number is in degrees). Value interpolates from X to Y based WeaponFiringTime / BloomTime */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Spread", meta = (EditCondition = "bHasSpread"))
    FVector2D SpreadRange = FVector2D(0.0f, 15.0f);
    /* Incrementation of spread per shot (in percent) */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Spread", meta = (EditCondition = "bHasSpread"))
    float SpreadPerShot = 0.1f;
    /* Rate at which spread decays */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Spread", meta = (EditCondition = "bHasSpread"))
    float SpreadDecayRate = 1.0f;
 
    float CurrentMovementSpreadModifier = 1.f;
    float MovementSpreadModifierOnStop = 1.f;
    FTimerHandle BurstTimer;
 
public:
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Burst Fire")
    bool bBurstFire = false;
    /* Number of bursts per fire. */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Burst Fire", meta = (EditCondition = "bBurstFire"))
    uint8 BurstCount = 3;
    /* Time between bursts. */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|Burst Fire", meta = (EditCondition = "bBurstFire"))
    float BurstRate = 0.1f;
 
public:
    static void FormatTraceMultiHitResults(TArray<FHitResult>& HitResults, const UWeaponInstanceRanged* Weapon);
};