1. Epic GamesDeveloper
  3. UBTFunctionLibrary

UBTFunctionLibrary

API > API/Runtime > API/Runtime/AIModule

   
Name UBTFunctionLibrary
Type class
Header File /Engine/Source/Runtime/AIModule/Classes/BehaviorTree/BTFunctionLibrary.h
Include Path #include "BehaviorTree/BTFunctionLibrary.h"

Syntax

UCLASS (Meta=(RestrictedToClasses="BTNode"), MinimalAPI)  
class UBTFunctionLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static void ClearBlackboardValue ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key
)

 Resets indicated value to "not set" value, based on values type BehaviorTree/BTFunctionLibrary.h
  • BlueprintCallable
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static void ClearBlackboardValueAsVector ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key
)

 (DEPRECATED) Use ClearBlackboardValue instead BehaviorTree/BTFunctionLibrary.h
  • BlueprintCallable
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner", DeprecatedFunction, DeprecationMessage="Use ClearBlackboardValue instead.")

static AActor * GetBlackboardValueAsActor ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintPure
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static bool GetBlackboardValueAsBool ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintPure
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static UClass * GetBlackboardValueAsClass ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintPure
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static uint8 GetBlackboardValueAsEnum ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintPure
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static float GetBlackboardValueAsFloat ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintPure
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static int32 GetBlackboardValueAsInt ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintPure
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static FName GetBlackboardValueAsName ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintPure
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static UObject * GetBlackboardValueAsObject ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintPure
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static FRotator GetBlackboardValueAsRotator ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintPure
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static FString GetBlackboardValueAsString ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintPure
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static FVector GetBlackboardValueAsVector ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintPure
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static UBehaviorTreeComponent * GetOwnerComponent ( UBTNode* NodeOwner
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintPure
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static UBlackboardComponent * GetOwnersBlackboard ( UBTNode* NodeOwner
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintPure
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static void SetBlackboardValueAsBool ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key,
bool Value
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintCallable
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static void SetBlackboardValueAsClass ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key,
UClass* Value
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintCallable
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static void SetBlackboardValueAsEnum ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key,
uint8 Value
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintCallable
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static void SetBlackboardValueAsFloat ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key,
float Value
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintCallable
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static void SetBlackboardValueAsInt ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key,
int32 Value
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintCallable
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static void SetBlackboardValueAsName ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key,
FName Value
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintCallable
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static void SetBlackboardValueAsObject ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key,
UObject* Value
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintCallable
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static void SetBlackboardValueAsRotator ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key,
FRotator Value
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintCallable
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static void SetBlackboardValueAsString ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key,
FString Value
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintCallable
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static void SetBlackboardValueAsVector ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key,
FVector Value
)

   BehaviorTree/BTFunctionLibrary.h
  • BlueprintCallable
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner")

static void StartUsingExternalEvent ( UBTNode* NodeOwner,
AActor* OwningActor
)

 Initialize variables marked as "instance memory" and set owning actor for blackboard operations BehaviorTree/BTFunctionLibrary.h
  • BlueprintCallable
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner", DeprecatedFunction, DeprecationMessage="No longer needed")

static void StopUsingExternalEvent ( UBTNode* NodeOwner
)

 Save variables marked as "instance memory" and clear owning actor BehaviorTree/BTFunctionLibrary.h
  • BlueprintCallable
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner", DeprecatedFunction, DeprecationMessage="No longer needed")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page