PawnSensingComponent.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 "Engine/EngineTypes.h"
#include "Components/ActorComponent.h"
#include "PawnSensingComponent.generated.h"
 
class AActor;
class AController;
class APawn;
class UPawnNoiseEmitterComponent;
 
class UE_DEPRECATED_FORGAME(5.5, "Pawn sensing is deprecated. AI Perception should be used instead.") UPawnSensingComponent;
UCLASS(ClassGroup=AI, HideCategories=(Activation, "Components|Activation", Collision), meta=(BlueprintSpawnableComponent), MinimalAPI)
class UPawnSensingComponent : public UActorComponent
{
    GENERATED_UCLASS_BODY()
 
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam( FSeePawnDelegate, APawn*, Pawn );
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams( FHearNoiseDelegate, APawn*, Instigator, const FVector&, Location, float, Volume);
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=AI)
    float HearingThreshold;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=AI)
    float LOSHearingThreshold;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=AI)
    float SightRadius;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=AI)
    float SensingInterval;
 
    // Max age of sounds we can hear. Should be greater than SensingInterval, or you might miss hearing some sounds!
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=AI)
    float HearingMaxSoundAge;
    
public:
 
    UFUNCTION(BlueprintCallable, BlueprintAuthorityOnly, Category="AI|Components|PawnSensing")
    AIMODULE_API virtual void SetSensingInterval(const float NewSensingInterval);
 
    UFUNCTION(BlueprintCallable, BlueprintAuthorityOnly, Category="AI|Components|PawnSensing")
    AIMODULE_API virtual void SetSensingUpdatesEnabled(const bool bEnabled);
 
    UFUNCTION(BlueprintCallable, BlueprintAuthorityOnly, Category="AI|Components|PawnSensing")
    AIMODULE_API virtual void SetPeripheralVisionAngle(const float NewPeripheralVisionAngle);
 
    UFUNCTION(BlueprintCallable, Category="AI|Components|PawnSensing")
    float GetPeripheralVisionAngle() const;
 
    UFUNCTION(BlueprintCallable, Category="AI|Components|PawnSensing")
    float GetPeripheralVisionCosine() const;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=AI)
    uint32 bEnableSensingUpdates:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=AI)
    uint32 bOnlySensePlayers:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=AI)
    uint32 bSeePawns:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=AI)
    uint32 bHearNoises:1;
 
    AIMODULE_API virtual bool IsSensorActor(const AActor* Actor) const;
 
    AIMODULE_API virtual bool CanSenseAnything() const;
 
    AIMODULE_API virtual bool ShouldCheckVisibilityOf(APawn* Pawn) const;
 
    AIMODULE_API virtual bool CouldSeePawn(const APawn* Other, bool bMaySkipChecks = false) const;
 
    AIMODULE_API virtual bool ShouldCheckAudibilityOf(APawn* Pawn) const;
 
    AIMODULE_API virtual bool HasLineOfSightTo(const AActor* Other) const;
 
    AIMODULE_API bool IsNoiseRelevant(const APawn& Pawn, const UPawnNoiseEmitterComponent& NoiseEmitterComponent, bool bSourceWithinNoiseEmitter) const;
 
    AIMODULE_API virtual bool CanHear(const FVector& NoiseLoc, float Loudness, bool bFailedLOS) const;
 
    //~ Begin UActorComponent Interface.
    AIMODULE_API virtual void InitializeComponent() override;
    //~ End UActorComponent Interface.
 
    AIMODULE_API virtual FVector GetSensorLocation() const;
 
    AIMODULE_API virtual FRotator GetSensorRotation() const;
 
protected:
 
    AIMODULE_API virtual void SensePawn(APawn& Pawn);
 
    AIMODULE_API virtual void OnTimer();
 
    FTimerHandle TimerHandle_OnTimer;
 
    AIMODULE_API virtual void SetTimer(const float TimeDelay);
 
    AIMODULE_API virtual void UpdateAISensing();
 
    AIMODULE_API AActor* GetSensorActor() const;    // Get the actor used as the actual sensor location is derived from this actor.
    AIMODULE_API AController* GetSensorController() const; // Get the controller of the sensor actor.
 
public:
    UPROPERTY(BlueprintAssignable)
    FSeePawnDelegate OnSeePawn;
 
    UPROPERTY(BlueprintAssignable)
    FHearNoiseDelegate OnHearNoise;
 
protected:
 
    // Broadcasts notification that our sensor sees a Pawn, using the OnSeePawn delegates.
    AIMODULE_API virtual void BroadcastOnSeePawn(APawn& Pawn);
 
    // Broadcasts notification that our sensor hears a noise made local to a Pawn's position, using the OnHearNoise delegates.
    AIMODULE_API virtual void BroadcastOnHearLocalNoise(APawn& Instigator, const FVector& Location, float Volume);
 
    // Broadcasts notification that our sensor hears a noise made remotely from a Pawn's position, using the OnHearNoise delegates.
    AIMODULE_API virtual void BroadcastOnHearRemoteNoise(APawn& Instigator, const FVector& Location, float Volume);
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=AI)
    float PeripheralVisionAngle;
 
    UPROPERTY()
    float PeripheralVisionCosine;
};
 
 
 
inline float UPawnSensingComponent::GetPeripheralVisionAngle() const
{
    return PeripheralVisionAngle;
}
 
inline float UPawnSensingComponent::GetPeripheralVisionCosine() const
{
    return PeripheralVisionCosine;
}