AISense_Actions.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 "Data/BaseData.h"
#include "Perception/AISense.h"
#include "AISense_Actions.generated.h"
 
 
class UAISense_Actions;
class UAISenseConfig_Actions; //forward declaration to avoid circular dependencies
 
USTRUCT()
struct AITOOLKIT_API FAIActionEvent
{   
    GENERATED_USTRUCT_BODY()
 
    typedef UAISense_Actions FSenseClass;
 
    FVector Location;
    FGenericTeamId TeamIdentifier;
    // float RangeSq;
    float RangeMultiplier = 1.0f;
 
    float InformationAge = 0.0f;
    float Strength = 1.0f;
 
    UPROPERTY()
    TObjectPtr<AActor> Broadcaster;
    UPROPERTY()
    TObjectPtr<AActor> OtherActor;
    FName ActionName;
    
    EAIActionType Action;
 
        
    FAIActionEvent() : Broadcaster(nullptr), OtherActor(nullptr), Action(EAIActionType::Default) {}
    FAIActionEvent(AActor* Broadcaster, AActor* OtherActor, const FVector& TargetLocation, const EAIActionType ActionType, const float EventRangeMultiplier = 1.0f, const float PassedInfoAge = 0.f, const float InStrength = 1.f);
 
    
    FORCEINLINE void CacheBroadcastLocation()
    {
        BroadcastLocation = Broadcaster ? Broadcaster->GetActorLocation() : FAISystem::InvalidLocation;
    }
    FORCEINLINE const FVector& GetBroadcastLocation() const 
    {
        return BroadcastLocation;
    }
 
private:
    FVector BroadcastLocation;
 
    // IAIPerceptionListenerInterface* GetTouchedActorAsPerceptionListener() const;
};
 
 
 
UCLASS(meta = (DisplayName = "AI Sense Actions"))
class AITOOLKIT_API UAISense_Actions : public UAISense
{
    GENERATED_BODY()
 
public:
    
    /*
     * After inspecting the engine's code it seems like there's a pattern to use a struct
     * to consume the properties from the config class so it's better to follow the engine's
     * standards and workflows.
     */
    struct FDigestedActionProperties
    {
        float ActionRadius;
        // bool bDisplayDebugSphere;
        uint8 AffiliationFlags;
        FPerceptionListenerID ListenerID;
        
        FDigestedActionProperties();
        FDigestedActionProperties(const UAISenseConfig_Actions& SenseConfig, const FPerceptionListenerID& ID);
 
        // bool operator==(const FDigestedActionProperties& Other) const
        // {
        //  return Other.ListenerID == ListenerID;
        // }
    };
 
    /* Consumed properties from config */
    TArray<FDigestedActionProperties> DigestedProperties;
    const FDigestedActionProperties* GetActionConfigByListenerID(const FPerceptionListenerID& TargetID);
    
    UAISense_Actions(const FObjectInitializer& ObjectInitializer);
 
    UFUNCTION(BlueprintCallable, Category = "AI|Perception", meta = (WorldContext = "WorldContextObject"))
    static void ReportActionEvent(UObject* WorldContextObject, AActor* Broadcaster, AActor* OtherActor,
        const FVector& TargetLocation, const EAIActionType ActionType,
        const float EventRangeMultiplier = 1.0f, const float PassedInfoAge = 0.f, const float InStrength = 1.f);
 
 
 
    UPROPERTY()
    TArray<FAIActionEvent> RegisteredEvents;
    
    void RegisterEvent(const FAIActionEvent& Event);    
 
    
protected:
    /* Core logic for the sense */
    virtual float Update() override;
 
    /* A listener is someone who has a Perception component with various senses
     * This function will be called when a new listener gained this sense 
     */
    void OnNewListenerImpl(const FPerceptionListener& NewListener);
 
    /*
     * Called whenever the listener is removed (eg destroyed or game has stopped)
     */
    void OnListenerRemovedImpl(const FPerceptionListener& UpdatedListener);
 
    FGenericTeamId TeamIdentifier;
 
};