AdvancedAIPerceptionComponent.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 "Perception/AIPerceptionComponent.h"
#include "AdvancedAIPerceptionComponent.generated.h"
 
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnForgottenStimulus, FAIStimulus, Stimulus);
 
 
UCLASS()
class AITOOLKIT_API UAdvancedAIPerceptionComponent : public UAIPerceptionComponent
{
    GENERATED_BODY()
 
public:
    UPROPERTY(BlueprintAssignable)
    FOnForgottenStimulus OnForgottenStimulus;
    
    //- Currently only works with Sight & Hearing   //
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit")
    UAISenseConfig* GetPerceptionSenseConfig(const TSubclassOf<UAISense> SenseClass);
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit")
    bool SetPerceptionSenseConfig(const TSubclassOf<UAISense> SenseClass, const bool DetectEnemies, const bool DetectNeutrals, const bool DetectFriendlies);
 
    virtual void GetNeutralActors(TArray<AActor*>& OutActors) const;
    void GetNeutralActorsBySense(TSubclassOf<UAISense> SenseToFilterBy, TArray<AActor*>& OutActors) const;
 
    UFUNCTION(BlueprintCallable, Category = "AI Tool Kit")
    void GetPerceivedNeutralActors(TArray<AActor*>& OutActors) const;
    UFUNCTION(BlueprintCallable, Category = "AI Tool Kit")
    void GetPerceivedNeutralActorsBySense(const TSubclassOf<UAISense> SenseToUse, TArray<AActor*>& OutActors) const;
 
    virtual void GetFriendlyActors(TArray<AActor*>& OutActors) const;
    void GetFriendlyActorsBySense(TSubclassOf<UAISense> SenseToFilterBy, TArray<AActor*>& OutActors) const;
 
    UFUNCTION(BlueprintCallable, Category = "AI Tool Kit")
    void GetPerceivedFriendlyActors(TArray<AActor*>& OutActors) const;
    UFUNCTION(BlueprintCallable, Category = "AI Tool Kit")
    void GetPerceivedFriendlyActorsBySense(const TSubclassOf<UAISense> SenseToUse, TArray<AActor*>& OutActors) const;
 
    // UFUNCTION(BlueprintCallable, Category="AI Tool Kit")
    // bool IsFriendly(const FGenericTeamId& OwnerID, const TWeakObjectPtr<AActor> Target) const;
    // UFUNCTION(BlueprintCallable, Category="AI Tool Kit")
    // bool IsNeutral(const TWeakObjectPtr<AActor> Target) const;
 
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit")
    AAIController* GetOwnerController() const{return AIOwner;};
    
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit")
    float GetMaxAge(const TSubclassOf<UAISense> SenseClass);
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit")
    bool SetMaxAge(const TSubclassOf<UAISense> SenseClass, const float MaxAge);
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Sight")
    bool SetSightMaxAge(const float MaxAge);
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Hearing")
    bool SetHearingMaxAge(const float MaxAge);
 
 
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Sight")
    float GetSightRange();
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Sight")
    bool SetSightRange(const float SightRange);
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Sight")
    float GetLoseSightRange();
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Sight")
    bool SetLoseSightRange(const float LoseSightRange);
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Sight")
    float GetVisionAngle();
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Sight")
    bool SetVisionAngle(const float VisionAngle);
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Sight")
    float GetAutoSuccessRange();
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Sight")
    bool SetAutoSuccessRange(const float AutoSuccessRange);
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Sight")
    float GetPOVBackwardOffset();
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Sight")
    bool SetPOVBackwardOffset(const float POVBackwardOffset);
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Sight")
    float GetNearClippingRadius();
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Sight")
    bool SetNearClippingRadius(const float NearClippingRadius);
    // UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Sight")
    // void ShowSightVisionAngle(FGameplayDebuggerCategory* DebuggerCategory);
    // UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Sight")
    // void HideSightVisionAngle(FGameplayDebuggerCategory* DebuggerCategory);
 
 
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Hearing")
    float GetHearingRange();
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Hearing")
    bool SetHearingRange(const float HearingRange);
    //- pre 5.2 //
    // UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Hearing")
    // bool GetUseLoSHearing();
    // UFUNCTION(BlueprintCallable, Category="AI Tool Kit|Hearing")
    // bool SetUseLoSHearing(const bool UseLoSHearing);
 
 
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit")
    FAISenseAffiliationFilter GetDetectionByAffiliation(const TSubclassOf<UAISense> SenseClass);
 
 
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit")
    class UAISenseConfig_Sight* GetSightConfig();
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit")
    class UAISenseConfig_Hearing* GetHearingConfig();
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit")
    class UAISenseConfig_Actions* GetActionsConfig();
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit")
    class UAISenseConfig_Damage* GetDamageConfig();
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit")
    class UAISenseConfig_Prediction* GetPredictionConfig();
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit")
    class UAISenseConfig_Team* GetTeamConfig();
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit")
    class UAISenseConfig_Touch* GetTouchConfig();
 
protected:
    virtual void HandleExpiredStimulus(FAIStimulus& StimulusStore) override;
 
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit", DisplayName="Forget Actor")
    bool ForgetActorBP(AActor* ActorToForget);
 
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit", DisplayName="Set Dominant Sense")
    bool SetDominantSenseBP(const TSubclassOf<UAISense> SenseClass);
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit", DisplayName="Get Dominant Sense")
    TSubclassOf<UAISense> GetDominantSenseBP() const;
 
 
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit", DisplayName="Get Body Actor")
    const AActor* GetBodyActorBP() const;
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit", DisplayName="Get Mutable Body Actor")
    AActor* GetMutableBodyActorBP();
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit", DisplayName="Get Location And Direction")
    void GetLocationAndDirectionBP(FVector& Location, FVector& Direction) const;
 
 
    //- Extras?     //
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit", DisplayName="Get Team Identifier")
    FGenericTeamId GetTeamIdentifierBP() const;
 
    // UFUNCTION(BlueprintCallable, Category="AI Tool Kit", DisplayName="Get Actor Info")
    // const FActorPerceptionInfo* GetActorInfoBP(const AActor* Actor) const;
 
    // UFUNCTION(BlueprintCallable, Category="AI Tool Kit", DisplayName="Get Freshest Trace")
    // const FActorPerceptionInfo* GetFreshestTraceBP(const TSubclassOf<UAISense> SenseClass) const;
 
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit", DisplayName="Update Perception Allow List")
    void UpdatePerceptionAllowListBP(const TSubclassOf<UAISense> SenseClass, const bool bNewValue);
 
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit", DisplayName="Get Youngest Stimulus Age")
    float GetYoungestStimulusAgeBP(AActor* Source) const;
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit", DisplayName="Has Any Active Stimulus")
    bool HasAnyActiveStimulusBP(const AActor* Source) const;
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit", DisplayName="Has Any Current Stimulus")
    bool HasAnyCurrentStimulusBP(const AActor* Source) const;
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit", DisplayName="Has Active Stimulus")
    bool HasActiveStimulusBP(const AActor* Source, const TSubclassOf<UAISense> SenseClass) const;
 
 
#if WITH_GAMEPLAY_DEBUGGER_MENU
    virtual void DescribeSelfToGameplayDebugger(FGameplayDebuggerCategory* DebuggerCategory) const override;
#endif // WITH_GAMEPLAY_DEBUGGER_MENU
 
 
 
};