1. Epic GamesDeveloper
  3. UAIBlueprintHelperLibrary

UAIBlueprintHelperLibrary

API > API/Runtime > API/Runtime/AIModule

   
Name UAIBlueprintHelperLibrary
Type class
Header File /Engine/Source/Runtime/AIModule/Classes/Blueprint/AIBlueprintHelperLibrary.h
Include Path #include "Blueprint/AIBlueprintHelperLibrary.h"

Syntax

UCLASS (Meta=(ScriptName="AIHelperLibrary"), MinimalAPI)  
class UAIBlueprintHelperLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UAIBlueprintHelperLibrary ( const FObjectInitializer& ObjectInitializer
)

   Blueprint/AIBlueprintHelperLibrary.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static UAIAsyncTaskBlueprintProxy * CreateMoveToProxyObject ( UObject* WorldContextObject,
APawn* Pawn,
FVector Destination,
AActor* TargetActor,
float AcceptanceRadius,
bool bStopOnOverlap
)

   Blueprint/AIBlueprintHelperLibrary.h
  • BlueprintCallable
  • Meta=(WorldContext="WorldContextObject", BlueprintInternalUseOnly="TRUE")

static AAIController * GetAIController ( AActor* ControlledActor
)

 The way it works exactly is if the actor passed in is a pawn, then the function retrieves pawn's controller cast to AIController. Blueprint/AIBlueprintHelperLibrary.h
  • BlueprintPure
  • Category="AI"
  • Meta=(DefaultToSelf="ControlledObject")

static UBlackboardComponent * GetBlackboard ( AActor* Target
)

   Blueprint/AIBlueprintHelperLibrary.h
  • BlueprintPure
  • Category="AI"
  • Meta=(DefaultToSelf="Target")

static UNavigationPath * GetCurrentPath ( AController* Controller
)

 Returns a NEW UOBJECT that is a COPY of navigation path given controller is currently using. Blueprint/AIBlueprintHelperLibrary.h
  • BlueprintPure
  • Category="AI"
  • Meta=(UnsafeDuringActorConstruction="true")

static int32 GetCurrentPathIndex ( const AController* Controller
)

 Return the path index the given controller is currently at. Returns INDEX_NONE if no path. Blueprint/AIBlueprintHelperLibrary.h
  • BlueprintPure
  • Category="AI"
  • Meta=(UnsafeDuringActorConstruction="true")

static const TArray< FVector > GetCurrentPathPoints ( AController* Controller
)

 Returns an array of navigation path points given controller is currently using. Blueprint/AIBlueprintHelperLibrary.h
  • BlueprintPure
  • Category="AI"
  • Meta=(UnsafeDuringActorConstruction="true")

static int32 GetNextNavLinkIndex ( const AController* Controller
)

 Return the path index of the next nav link for the current path of the given controller. Blueprint/AIBlueprintHelperLibrary.h
  • BlueprintPure
  • Category="AI"
  • Meta=(UnsafeDuringActorConstruction="true")

static UPathFollowingComponent * GetPathComp ( const AController* Controller
)

   Blueprint/AIBlueprintHelperLibrary.h  

static bool IsValidAIDirection ( FVector DirectionVector
)

   Blueprint/AIBlueprintHelperLibrary.h
  • BlueprintPure
  • Category="AI"

static bool IsValidAILocation ( FVector Location
)

   Blueprint/AIBlueprintHelperLibrary.h
  • BlueprintPure
  • Category="AI"

static bool IsValidAIRotation ( FRotator Rotation
)

   Blueprint/AIBlueprintHelperLibrary.h
  • BlueprintPure
  • Category="AI"

static void LockAIResourcesWithAnimation ( UAnimInstance* AnimInstance,
bool bLockMovement,
bool LockAILogic
)

 Locks indicated AI resources of animated pawn Blueprint/AIBlueprintHelperLibrary.h
  • BlueprintCallable
  • Category="Animation"
  • BlueprintAuthorityOnly
  • Meta=(DefaultToSelf="AnimInstance")

static void SendAIMessage ( APawn* Target,
FName Message,
UObject* MessageSource,
bool bSuccess
)

   Blueprint/AIBlueprintHelperLibrary.h
  • BlueprintCallable
  • Category="AI"
  • Meta=(DefaultToSelf="MessageSource")

static void SimpleMoveToActor ( AController* Controller,
const AActor* Goal
)

   Blueprint/AIBlueprintHelperLibrary.h
  • BlueprintCallable
  • Category="AI|Navigation"

static void SimpleMoveToLocation ( AController* Controller,
const FVector& Goal
)

   Blueprint/AIBlueprintHelperLibrary.h
  • BlueprintCallable
  • Category="AI|Navigation"

static APawn * SpawnAIFromClass ( UObject* WorldContextObject,
TSubclassOf< APawn > PawnClass,
UBehaviorTree* BehaviorTree,
FVector Location,
FRotator Rotation,
bool bNoCollisionFail,
AActor* Owner
)

 Spawns AI agent of a given class. Blueprint/AIBlueprintHelperLibrary.h
  • BlueprintCallable
  • Category="AI"
  • Meta=(WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true", AdvancedDisplay="Owner")

static void UnlockAIResourcesWithAnimation ( UAnimInstance* AnimInstance,
bool bUnlockMovement,
bool UnlockAILogic
)

 Unlocks indicated AI resources of animated pawn. Will unlock only animation-locked resources Blueprint/AIBlueprintHelperLibrary.h
  • BlueprintCallable
  • Category="Animation"
  • BlueprintAuthorityOnly
  • Meta=(DefaultToSelf="AnimInstance")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page