AISense_Hearing.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "GenericTeamAgentInterface.h"
#include "Perception/AISense.h"
#include "AISense_Hearing.generated.h"
 
class UAISenseConfig_Hearing;
class UAISenseEvent;
 
USTRUCT(BlueprintType)
struct FAINoiseEvent
{   
    GENERATED_USTRUCT_BODY()
 
    typedef class UAISense_Hearing FSenseClass;
 
    float Age;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Sense")
    FVector NoiseLocation;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Sense", meta = (UIMin = 0, ClampMin = 0))
    float Loudness;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Sense", meta = (UIMin = 0, ClampMin = 0))
    float MaxRange;
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Sense")
    TObjectPtr<AActor> Instigator;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Sense")
    FName Tag;
 
    FGenericTeamId TeamIdentifier;
        
    AIMODULE_API FAINoiseEvent();
    AIMODULE_API FAINoiseEvent(AActor* InInstigator, const FVector& InNoiseLocation, float InLoudness = 1.f, float InMaxRange = 0.f, FName Tag = NAME_None);
 
    AIMODULE_API void Compile();
};
 
UCLASS(ClassGroup=AI, Config=Game, MinimalAPI)
class UAISense_Hearing : public UAISense
{
    GENERATED_UCLASS_BODY()
        
protected:
    UPROPERTY()
    TArray<FAINoiseEvent> NoiseEvents;
 
    UPROPERTY(config)
    float SpeedOfSoundSq;
 
    struct FDigestedHearingProperties
    {
        float HearingRangeSq;
        uint8 AffiliationFlags;
 
        FDigestedHearingProperties(const UAISenseConfig_Hearing& SenseConfig);
        FDigestedHearingProperties();
    };
    TMap<FPerceptionListenerID, FDigestedHearingProperties> DigestedProperties;
 
public: 
    AIMODULE_API void RegisterEvent(const FAINoiseEvent& Event);    
    AIMODULE_API void RegisterEventsBatch(const TArray<FAINoiseEvent>& Events);
 
    AIMODULE_API virtual void PostInitProperties() override;
 
    // part of BP interface. Translates PerceptionEvent to FAINoiseEvent and call RegisterEvent(const FAINoiseEvent& Event)
    AIMODULE_API virtual void RegisterWrappedEvent(UAISenseEvent& PerceptionEvent) override;
 
    UFUNCTION(BlueprintCallable, Category = "AI|Perception", meta = (WorldContext="WorldContextObject"))
    static AIMODULE_API void ReportNoiseEvent(UObject* WorldContextObject, FVector NoiseLocation, float Loudness = 1.f, AActor* Instigator = nullptr, float MaxRange = 0.f, FName Tag = NAME_None);
 
protected:
    AIMODULE_API virtual float Update() override;
    AIMODULE_API virtual void RegisterMakeNoiseDelegate();
 
    AIMODULE_API void OnNewListenerImpl(const FPerceptionListener& NewListener);
    AIMODULE_API void OnListenerUpdateImpl(const FPerceptionListener& UpdatedListener);
    AIMODULE_API void OnListenerRemovedImpl(const FPerceptionListener& RemovedListener);
};