AISense.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 "UObject/Object.h"
#include "Templates/SubclassOf.h"
#include "Perception/AIPerceptionTypes.h"
#include "AISense.generated.h"
 
class APawn;
class FGameplayDebuggerCategory;
class UAIPerceptionSystem;
class UAISenseEvent;
 
DECLARE_DELEGATE_OneParam(FOnPerceptionListenerUpdateDelegate, const FPerceptionListener&);
 
UCLASS(ClassGroup = AI, abstract, config = Engine, MinimalAPI)
class UAISense : public UObject
{
    GENERATED_UCLASS_BODY()
 
    static AIMODULE_API const float SuspendNextUpdate;
 
protected:
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "AI Perception", config)
    EAISenseNotifyType NotifyType;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "AI Perception", config)
    uint32 bWantsNewPawnNotification : 1;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "AI Perception", config)
    uint32 bAutoRegisterAllPawnsAsSources : 1;
 
    uint32 bNeedsForgettingNotification : 1;
    
private:
    UPROPERTY()
    TObjectPtr<UAIPerceptionSystem> PerceptionSystemInstance;
 
    float TimeUntilNextUpdate;
 
    FAISenseID SenseID;
 
protected:
    FOnPerceptionListenerUpdateDelegate OnNewListenerDelegate;
 
    FOnPerceptionListenerUpdateDelegate OnListenerUpdateDelegate;
 
    FOnPerceptionListenerUpdateDelegate OnListenerRemovedDelegate;
                
public:
 
    AIMODULE_API virtual UWorld* GetWorld() const override;
 
    static AIMODULE_API void HardcodeSenseID(TSubclassOf<UAISense> SenseClass, FAISenseID HardcodedID);
 
    static FAISenseID GetSenseID(const TSubclassOf<UAISense> SenseClass) { return SenseClass ? ((const UAISense*)SenseClass->GetDefaultObject())->SenseID : FAISenseID::InvalidID(); }
    template<typename TSense>
    static FAISenseID GetSenseID() 
    { 
        return GetDefault<TSense>()->GetSenseID();
    }
    inline FAISenseID GetSenseID() const { return SenseID; }
 
    inline bool WantsUpdateOnlyOnPerceptionValueChange() const { return (NotifyType == EAISenseNotifyType::OnPerceptionChange); }
 
    AIMODULE_API virtual void PostInitProperties() override;
 
    bool ProgressTime(float DeltaSeconds)
    {
        TimeUntilNextUpdate -= DeltaSeconds;
        return TimeUntilNextUpdate <= 0.f;
    }
 
    void Tick()
    {
        if (TimeUntilNextUpdate <= 0.f)
        {
            TimeUntilNextUpdate = Update();
        }
    }
 
    //virtual void RegisterSources(TArray<AActor&> SourceActors) {}
    virtual void RegisterSource(AActor& SourceActors){}
    virtual void UnregisterSource(AActor& SourceActors){}
 
    AIMODULE_API virtual void RegisterWrappedEvent(UAISenseEvent& PerceptionEvent);
    AIMODULE_API virtual FAISenseID UpdateSenseID();
 
    bool NeedsNotificationOnForgetting() const { return bNeedsForgettingNotification; }
    virtual void OnListenerForgetsActor(const FPerceptionListener& Listener, AActor& ActorToForget) {}
    virtual void OnListenerForgetsAll(const FPerceptionListener& Listener) {}
 
    inline void OnNewListener(const FPerceptionListener& NewListener) { OnNewListenerDelegate.ExecuteIfBound(NewListener); }
    inline void OnListenerUpdate(const FPerceptionListener& UpdatedListener) { OnListenerUpdateDelegate.ExecuteIfBound(UpdatedListener); }
    inline void OnListenerRemoved(const FPerceptionListener& RemovedListener) { OnListenerRemovedDelegate.ExecuteIfBound(RemovedListener); }
    virtual void OnListenerConfigUpdated(const FPerceptionListener& UpdatedListener) { OnListenerUpdate(UpdatedListener); }
 
    bool WantsNewPawnNotification() const { return bWantsNewPawnNotification; }
    bool ShouldAutoRegisterAllPawnsAsSources() const { return bAutoRegisterAllPawnsAsSources; }
 
#if WITH_GAMEPLAY_DEBUGGER_MENU
    AIMODULE_API virtual void DescribeSelfToGameplayDebugger(const UAIPerceptionSystem& PerceptionSystem, FGameplayDebuggerCategory& DebuggerCategory) const;
#endif // WITH_GAMEPLAY_DEBUGGER_MENU
 
protected:
    friend UAIPerceptionSystem;
    AIMODULE_API virtual void OnNewPawn(APawn& NewPawn);
 
    virtual float Update() { return FLT_MAX; }
 
    inline void RequestImmediateUpdate() { TimeUntilNextUpdate = 0.f; }
 
    inline void RequestUpdateInSeconds(float UpdateInSeconds) { TimeUntilNextUpdate = UpdateInSeconds; }
 
    inline UAIPerceptionSystem* GetPerceptionSystem() { return PerceptionSystemInstance; }
 
    AIMODULE_API void SetSenseID(FAISenseID Index);
 
    AIMODULE_API AIPerception::FListenerMap* GetListeners();
 
    AIMODULE_API void ForceSenseID(FAISenseID SenseID);
};