UAnimNotifyFootstep Class Reference

#include <AnimNotifyFootstep.h>

Inheritance diagram for UAnimNotifyFootstep:

Public Member Functions
virtual void	Notify (USkeletalMeshComponent *MeshComp, UAnimSequenceBase *Animation, const FAnimNotifyEventReference &EventReference) override
virtual FString	GetNotifyName_Implementation () const override

Public Attributes
bool	bSpawnSound = true
float	VolumeMultiplier = 1.0f
float	PitchMultiplier = 1.0f
EFootstepType	FootstepType = EFootstepType::Step
bool	bLeftFoot = true
bool	bRightFoot = false

Member Function Documentation

GetNotifyName_Implementation()

FString UAnimNotifyFootstep::GetNotifyName_Implementation ( ) const

overridevirtual

{
    FString Foot(TEXT("Right Foot"));
    if(bLeftFoot)
    {
        Foot = (TEXT("Left Foot"));
    }
    if(bLeftFoot && bRightFoot)
    {
        Foot = (TEXT("Both Feet"));
    }
    FString Name(Foot +TEXT("Footstep Type: "));
    Name.Append(StaticEnum<EFootstepType>()->GetNameStringByValue(static_cast<int64>(FootstepType)));
    return Name;
}

Notify()

void UAnimNotifyFootstep::Notify ( USkeletalMeshComponent * MeshComp, UAnimSequenceBase * Animation, const FAnimNotifyEventReference & EventReference )

overridevirtual

{
    TRACE_CPUPROFILER_EVENT_SCOPE(UAnimNotifyFootstep::Notify);
 
    Super::Notify(MeshComp, Animation, EventReference);
    if(MeshComp == nullptr){return;}
    const AActor* MeshOwner = MeshComp->GetOwner();
    if(MeshOwner == nullptr){return;}
    
    TArray<UActorComponent*> Components = MeshOwner->GetComponentsByInterface(UFootstepInterface::StaticClass());
    if(Components.IsEmpty()){return;}
    for(UActorComponent* Component : Components)
    {
        IFootstepInterface* FootstepComponent = Cast<IFootstepInterface>(Component);
        if(Component == nullptr){return;}
        if(bLeftFoot)
        {
            FootstepComponent->PlayFootstepSoundEvent();
        }
        if(bRightFoot)
        {
            FootstepComponent->PlayFootstepSoundEvent(bRightFoot);
        }
    }
    
    // if(HitDataTable)
    // {
    //  UWorld* World = MeshComp->GetWorld();
    //  check(World);
    //
    //  const FVector FootLocation = MeshComp->GetSocketLocation(FootSocketName);
    //  const FRotator FootRotation = MeshComp->GetSocketRotation(FootSocketName);
    //  const FVector TraceEnd = FootLocation - MeshOwner->GetActorUpVector() * TraceLength;
    //  FHitResult Hit;
    //
    //  if (UKismetSystemLibrary::LineTraceSingle(MeshOwner /*used by bIgnoreSelf*/, FootLocation, TraceEnd, TraceChannel, true /*bTraceComplex*/, MeshOwner->Children,
    //                                    DrawDebugType, Hit, true /*bIgnoreSelf*/))
    //  {
    //      if(!Hit.PhysMaterial.Get()){return;}
    //      
    //      const EPhysicalSurface SurfaceType = Hit.PhysMaterial.Get()->SurfaceType;
    //      check(IsInGameThread());
    //      checkNoRecursion();
    //      static TArray<FALSHitFX*> HitFXRows;
    //      HitFXRows.Reset();
    //      HitDataTable->GetAllRows<FALSHitFX>(FString(), HitFXRows);
    //      FALSHitFX* HitFX = nullptr;
    //      if (auto FoundResult = HitFXRows.FindByPredicate([&](const FALSHitFX* Value)
    //      {
    //          return SurfaceType == Value->SurfaceType;
    //      }))
    //      {
    //          HitFX = *FoundResult;
    //      }
    //      else if (auto DefaultResult = HitFXRows.FindByPredicate([&](const FALSHitFX* Value)
    //      {
    //          return EPhysicalSurface::SurfaceType_Default == Value->SurfaceType;
    //      }))
    //      {
    //          HitFX = *DefaultResult;
    //      }
    //      else
    //      {
    //          return;
    //      }
    //      if(bSpawnSound && HitFX->Sound.LoadSynchronous())
    //      {
    //          UAudioComponent* SpawnedSound = nullptr;
    //
    //          const float MaskCurveValue = MeshComp->GetAnimInstance()->GetCurveValue(
    //              NAME_Mask_FootstepSound);
    //          const float FinalVolMult = bOverrideMaskCurve
    //                                         ? VolumeMultiplier
    //                                         : VolumeMultiplier * (1.0f - MaskCurveValue);
    //
    //          switch (HitFX->SoundSpawnType)
    //          {
    //          case EALSSpawnType::Location:
    //              SpawnedSound = UGameplayStatics::SpawnSoundAtLocation(
    //                  World, HitFX->Sound.Get(), Hit.Location + HitFX->SoundLocationOffset,
    //                  HitFX->SoundRotationOffset, FinalVolMult, PitchMultiplier);
    //              break;
    //
    //          case EALSSpawnType::Attached:
    //              SpawnedSound = UGameplayStatics::SpawnSoundAttached(HitFX->Sound.Get(), MeshComp, FootSocketName,
    //                                                                  HitFX->SoundLocationOffset,
    //                                                                  HitFX->SoundRotationOffset,
    //                                                                  HitFX->SoundAttachmentType, true, FinalVolMult,
    //                                                                  PitchMultiplier);
    //
    //              break;
    //          }
    //          if(SpawnedSound)
    //          {
    //              SpawnedSound->SetIntParameter(SoundParameterName, static_cast<int32>(FootstepType));
    //          }
    //      }
    //      if (bSpawnNiagara && HitFX->NiagaraSystem.LoadSynchronous())
    //      {
    //          UNiagaraComponent* SpawnedParticle = nullptr;
    //          const FVector Location = Hit.Location + MeshOwner->GetTransform().TransformVector(
    //              HitFX->DecalLocationOffset);
    //
    //          switch (HitFX->NiagaraSpawnType)
    //          {
    //          case EALSSpawnType::Location:
    //              SpawnedParticle = UNiagaraFunctionLibrary::SpawnSystemAtLocation(
    //                  World, HitFX->NiagaraSystem.Get(), Location, FootRotation + HitFX->NiagaraRotationOffset);
    //              break;
    //
    //          case EALSSpawnType::Attached:
    //              SpawnedParticle = UNiagaraFunctionLibrary::SpawnSystemAttached(
    //                  HitFX->NiagaraSystem.Get(), MeshComp, FootSocketName, HitFX->NiagaraLocationOffset,
    //                  HitFX->NiagaraRotationOffset, HitFX->NiagaraAttachmentType, true);
    //              break;
    //          }
    //      }
    //      if (bSpawnDecal && HitFX->DecalMaterial.LoadSynchronous())
    //      {
    //          SpawnDecal(Hit);
    //      }
    //  }
 
    // }
}

Member Data Documentation

bLeftFoot

bool UAnimNotifyFootstep::bLeftFoot = true

bRightFoot

bool UAnimNotifyFootstep::bRightFoot = false

bSpawnSound

bool UAnimNotifyFootstep::bSpawnSound = true

FootstepType

EFootstepType UAnimNotifyFootstep::FootstepType = EFootstepType::Step

PitchMultiplier

float UAnimNotifyFootstep::PitchMultiplier = 1.0f

VolumeMultiplier

float UAnimNotifyFootstep::VolumeMultiplier = 1.0f

---

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

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/FootstepFXComponent/Source/FootstepFXComponent/Public/AnimNotifyFootstep.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/FootstepFXComponent/Source/FootstepFXComponent/Private/AnimNotifyFootstep.cpp