AIBlueprintHelperLibrary.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 "Templates/SubclassOf.h"
#include "GameFramework/Pawn.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "AIBlueprintHelperLibrary.generated.h"
 
class AAIController;
class UAIAsyncTaskBlueprintProxy;
class UAnimInstance;
class UBehaviorTree;
class UBlackboardComponent;
class UNavigationPath;
class UPathFollowingComponent;
 
UCLASS(meta=(ScriptName="AIHelperLibrary"), MinimalAPI)
class UAIBlueprintHelperLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_UCLASS_BODY()
 
    UFUNCTION(BlueprintCallable, meta=(WorldContext="WorldContextObject", BlueprintInternalUseOnly = "TRUE"))
    static AIMODULE_API UAIAsyncTaskBlueprintProxy* CreateMoveToProxyObject(UObject* WorldContextObject, APawn* Pawn, FVector Destination, AActor* TargetActor = NULL, float AcceptanceRadius = 5.f, bool bStopOnOverlap = false);
 
    UFUNCTION(BlueprintCallable, Category="AI", meta=(DefaultToSelf="MessageSource"))
    static AIMODULE_API void SendAIMessage(APawn* Target, FName Message, UObject* MessageSource, bool bSuccess = true);
 
    UFUNCTION(BlueprintCallable, Category="AI", meta=(WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true", AdvancedDisplay = "Owner"))
    static AIMODULE_API APawn* SpawnAIFromClass(UObject* WorldContextObject, TSubclassOf<APawn> PawnClass, UBehaviorTree* BehaviorTree, FVector Location, FRotator Rotation = FRotator::ZeroRotator, bool bNoCollisionFail = false, AActor* Owner = nullptr);
 
    UFUNCTION(BlueprintPure, Category = "AI", meta = (DefaultToSelf = "ControlledObject"))
    static AIMODULE_API AAIController* GetAIController(AActor* ControlledActor);
 
    UFUNCTION(BlueprintPure, Category="AI", meta=(DefaultToSelf="Target"))
    static AIMODULE_API UBlackboardComponent* GetBlackboard(AActor* Target);
 
    UFUNCTION(BlueprintCallable, Category = "Animation", BlueprintAuthorityOnly, meta = (DefaultToSelf = "AnimInstance"))
    static AIMODULE_API void LockAIResourcesWithAnimation(UAnimInstance* AnimInstance, bool bLockMovement, bool LockAILogic);
 
    UFUNCTION(BlueprintCallable, Category = "Animation", BlueprintAuthorityOnly, meta = (DefaultToSelf = "AnimInstance"))
    static AIMODULE_API void UnlockAIResourcesWithAnimation(UAnimInstance* AnimInstance, bool bUnlockMovement, bool UnlockAILogic);
 
    UFUNCTION(BlueprintPure, Category = "AI")
    static AIMODULE_API bool IsValidAILocation(FVector Location);
 
    UFUNCTION(BlueprintPure, Category = "AI")
    static AIMODULE_API bool IsValidAIDirection(FVector DirectionVector);
 
    UFUNCTION(BlueprintPure, Category = "AI")
    static AIMODULE_API bool IsValidAIRotation(FRotator Rotation);
 
    UFUNCTION(BlueprintPure, Category = "AI", meta = (UnsafeDuringActorConstruction = "true"))
    static AIMODULE_API UNavigationPath* GetCurrentPath(AController* Controller);
 
    UFUNCTION(BlueprintPure, Category = "AI", meta = (UnsafeDuringActorConstruction = "true"))
    static AIMODULE_API const TArray<FVector> GetCurrentPathPoints(AController* Controller);
 
    UFUNCTION(BlueprintPure, Category = "AI", meta = (UnsafeDuringActorConstruction = "true"))
    static AIMODULE_API int32 GetCurrentPathIndex(const AController* Controller);
 
    UFUNCTION(BlueprintPure, Category = "AI", meta = (UnsafeDuringActorConstruction = "true"))
    static AIMODULE_API int32 GetNextNavLinkIndex(const AController* Controller);
 
    UFUNCTION(BlueprintCallable, Category = "AI|Navigation")
    static AIMODULE_API void SimpleMoveToActor(AController* Controller, const AActor* Goal);
 
    UFUNCTION(BlueprintCallable, Category = "AI|Navigation")
    static AIMODULE_API void SimpleMoveToLocation(AController* Controller, const FVector& Goal);
 
private:
    static UPathFollowingComponent* GetPathComp(const AController* Controller);
};