EnvQueryInstanceBlueprintWrapper.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 "UObject/ScriptMacros.h"
#include "EnvironmentQuery/Items/EnvQueryItemType.h"
#include "EnvironmentQuery/EnvQueryTypes.h"
#include "EnvironmentQuery/EQSQueryResultSourceInterface.h"
#include "EnvQueryInstanceBlueprintWrapper.generated.h"
 
class AActor;
struct FEnvQueryRequest;
 
UCLASS(Blueprintable, BlueprintType, meta = (DisplayName = "EQS Query Instance"), MinimalAPI)
class UEnvQueryInstanceBlueprintWrapper : public UObject, public IEQSQueryResultSourceInterface
{
    GENERATED_BODY()
 
public:
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FEQSQueryDoneSignature, UEnvQueryInstanceBlueprintWrapper*, QueryInstance, EEnvQueryStatus::Type, QueryStatus);
 
    virtual const FEnvQueryResult* GetQueryResult() const { return QueryResult.Get(); }
 
    virtual const FEnvQueryInstance* GetQueryInstance() const { return QueryInstance.Get(); }
 
protected:
    UPROPERTY(BlueprintReadOnly, Category = "EQS")
    int32 QueryID;
 
    EEnvQueryRunMode::Type RunMode;
 
    TSharedPtr<FEnvQueryResult> QueryResult;
    TSharedPtr<FEnvQueryInstance> QueryInstance;
 
    UPROPERTY(BlueprintReadOnly, Category = "EQS")
    TSubclassOf<UEnvQueryItemType> ItemType;
 
    UPROPERTY(BlueprintReadOnly, Category = "EQS")
    int32 OptionIndex;
 
    UPROPERTY(BlueprintAssignable, Category = "AI|EQS", meta = (DisplayName = "OnQueryFinished"))
    FEQSQueryDoneSignature OnQueryFinishedEvent;
 
#if !UE_BUILD_SHIPPING
    FWeakObjectPtr Instigator;
#endif // !UE_BUILD_SHIPPING
 
public:
    AIMODULE_API UEnvQueryInstanceBlueprintWrapper(const FObjectInitializer& ObjectInitializer);
    
    AIMODULE_API void RunQuery(const EEnvQueryRunMode::Type InRunMode, FEnvQueryRequest& QueryRequest);
 
    UFUNCTION(BlueprintPure, Category = "AI|EQS")
    AIMODULE_API float GetItemScore(int32 ItemIndex) const;
 
    UFUNCTION(BlueprintCallable, BlueprintPure = false, Category = "AI|EQS")
    AIMODULE_API bool GetQueryResultsAsActors(TArray<AActor*>& ResultActors) const;
 
    UFUNCTION(BlueprintCallable, BlueprintPure = false, Category = "AI|EQS")
    AIMODULE_API bool GetQueryResultsAsLocations(TArray<FVector>& ResultLocations) const;
 
    UFUNCTION(BlueprintPure, Category = "AI|EQS", Meta=(DeprecatedFunction,
        DeprecationMessage="Use GetQueryResultsAsActors instead, which is more efficient itself and protects against very bad perf issues in some blueprints."))
    AIMODULE_API TArray<AActor*> GetResultsAsActors() const;
 
    UFUNCTION(BlueprintPure, Category = "AI|EQS", Meta=(DeprecatedFunction,
        DeprecationMessage="GetQueryResultsAsLocations instead, which is more efficient itself and protects against very bad perf issues in some blueprints."))
    AIMODULE_API TArray<FVector> GetResultsAsLocations() const;
 
    UFUNCTION(BlueprintCallable, Category = "AI|EQS")
    AIMODULE_API void SetNamedParam(FName ParamName, float Value);
 
    AIMODULE_API void SetInstigator(const UObject* Object);
 
    inline EEnvQueryRunMode::Type GetRunMode() const { return RunMode; };
 
    FEQSQueryDoneSignature& GetOnQueryFinishedEvent() { return OnQueryFinishedEvent; }
 
protected:
    AIMODULE_API void OnQueryFinished(TSharedPtr<FEnvQueryResult> Result);
 
    AIMODULE_API virtual bool IsSupportedForNetworking() const override;
};