FootstepFXHandler.h

Go to the documentation of this file.

// Fill out your copyright notice in the Description page of Project Settings.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Components/CharacterComponent.h"
#include "Interface/FootstepInterface.h"
#include "FootstepFXHandler.generated.h"
 
class UNiagaraSystem;
 
USTRUCT(BlueprintType)
struct FFootstepsVFX
{
    GENERATED_USTRUCT_BODY();
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> Dirt;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> General01;
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> General02;
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> Grass;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> Gravel;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> Ice;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> Leaves;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> Mud;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> Sand;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> SnowHeavy;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> SnowLight;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> Sparks;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> SpecialAbility;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> WaterHeavy;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> WaterLight;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> Carpet;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> Concrete;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> Metal;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> Plastic;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> Wood;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="VFX")
    TSoftObjectPtr<UNiagaraSystem> Flesh;
 
};
 
 
UCLASS( ClassGroup=(Custom), meta=(BlueprintSpawnableComponent))
class FOOTSTEPFXCOMPONENT_API UFootstepFXHandler : public UCharacterComponent, public IFootstepInterface
{
    GENERATED_BODY()
 
public: 
    UFootstepFXHandler();
 
    virtual void PlayFootstepSoundEvent(const bool bRightFoot = false, const float VolumeMultiplier = 1.0f, const float PitchMultiplier = 1.0f) override;
    virtual void PlayFootstepVFXEvent(const int32 FloorType, const float Speed, const bool bRightFoot, const float Multiplier = 1.0f);
 
    UFUNCTION(BlueprintCallable, Category = "Footsteps")
    void PlayJumpSoundEvent(const bool bRightFoot, const bool bJumpStart) const;
 
    //-     Footstep Variables  //
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    bool bPlayPerceptionSound = true;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    float FootstepPerceptionVolume = 1.0f;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    float FootstepPerceptionCrouchMultiplier = 0.3f;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    bool bPlaySound = true;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    bool bFootstepsPlay = true;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    bool bRattlePlay = false;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    bool bVoiceJumpPlay = true;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    float FootstepsVolume = 5.0f;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    float RattleVolume = 1.0f;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    float VoiceJumpVolume = 1.0f;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    bool bIsMale = true;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    bool bPlayVFX = true;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    float VFXSize = 1.0f;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    float FootstepCooldownTime = 0.2f;
 
protected:
    
    virtual void BeginPlay() override;
    void FootstepVFXSelector(const int32 FloorType, const float Speed, FVector& Scale, UNiagaraSystem*& FootstepParticle) const;
 
    //Sounds
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    TSoftObjectPtr<USoundBase> FootstepSFX;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    TSoftObjectPtr<USoundBase> JumpStartSFX;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    TSoftObjectPtr<USoundBase> JumpEndSFX;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    FString RightFootSocketName = "ik_foot_r";
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    FString LeftFootSocketName = "ik_foot_l";
 
    //VFX
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    FFootstepsVFX VFX;
 
 
    //-     Put Floor Materials here    //
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Footsteps")
    TArray<class UPhysicalMaterial*> Surfaces;
 
 
private:
    //-     TraceParams for finding Surface below character     //
    FCollisionQueryParams TraceParams;
    FVector TraceDown;
 
    void FootstepCooldown();
    
    //-     Components      //
    UPROPERTY()
    class UAudioComponent* FootstepAudioComponent = nullptr;
    UPROPERTY()
    class UAudioComponent* JumpStartAudioComponent = nullptr;
    UPROPERTY()
    class UAudioComponent* JumpEndAudioComponent = nullptr;
 
    UPROPERTY(VisibleAnywhere, Category = "Footsteps")
    bool bFootstepPlaying = false;
    FTimerHandle FootstepTimerHandle;
};