Show / Hide Table of Contents

Class BTFunctionLibrary

BTFunction Library

Inheritance
System.Object
UObject
BlueprintFunctionLibrary
BTFunctionLibrary
Inherited Members
UObject.TransientPackage
UObject.CastTo<T>(UObject)
UObject.CastTo(UObject, Type)
UObject.RemoveObject(UObject)
UObject.MakeObjectArrayField<T>(NativeArray*)
UObject.NotImplemented<T>()
UObject.Construct()
UObject.GetHashCode()
UObject.GetName()
UObject.ToString()
UObject.Name
UObject._None
UObject.None
UObject.ObjPointer
UObject.LoadObjectFromClass(Class, UObject, String, String, LoadFlags, PackageMap, Boolean)
UObject.LoadClass(Class, UObject, String, String, LoadFlags, PackageMap)
UObject.GetPropertyFor<T>(Name)
UObject.ExecuteUbergraph
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.AIModule
Assembly: UE4DotNet.dll
Syntax
public class BTFunctionLibrary : BlueprintFunctionLibrary

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static BTFunctionLibrary DefaultObject { get; }
Property Value
Type Description
BTFunctionLibrary
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

ClearBlackboardValue(BTNode, BlackboardKeySelector)

Resets indicated value to "not set" value, based on values type

Declaration
public static void ClearBlackboardValue(BTNode NodeOwner, BlackboardKeySelector Key)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
| Improve this Doc View Source

ClearBlackboardValueAsVector(BTNode, BlackboardKeySelector)

(DEPRECATED) Use ClearBlackboardValue instead

Declaration
public static void ClearBlackboardValueAsVector(BTNode NodeOwner, BlackboardKeySelector Key)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
| Improve this Doc View Source

GetBlackboardValueAsActor(BTNode, BlackboardKeySelector)

Get Blackboard Value as Actor

Declaration
public static Actor GetBlackboardValueAsActor(BTNode NodeOwner, BlackboardKeySelector Key)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
Returns
Type Description
Actor
| Improve this Doc View Source

GetBlackboardValueAsBool(BTNode, BlackboardKeySelector)

Get Blackboard Value as Bool

Declaration
public static bool GetBlackboardValueAsBool(BTNode NodeOwner, BlackboardKeySelector Key)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GetBlackboardValueAsClass(BTNode, BlackboardKeySelector)

Get Blackboard Value as Class

Declaration
public static SubclassOf<UObject> GetBlackboardValueAsClass(BTNode NodeOwner, BlackboardKeySelector Key)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
Returns
Type Description
SubclassOf<UObject>
| Improve this Doc View Source

GetBlackboardValueAsEnum(BTNode, BlackboardKeySelector)

Get Blackboard Value as Enum

Declaration
public static byte GetBlackboardValueAsEnum(BTNode NodeOwner, BlackboardKeySelector Key)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
Returns
Type Description
System.Byte
| Improve this Doc View Source

GetBlackboardValueAsFloat(BTNode, BlackboardKeySelector)

Get Blackboard Value as Float

Declaration
public static float GetBlackboardValueAsFloat(BTNode NodeOwner, BlackboardKeySelector Key)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
Returns
Type Description
System.Single
| Improve this Doc View Source

GetBlackboardValueAsInt(BTNode, BlackboardKeySelector)

Get Blackboard Value as Int

Declaration
public static int GetBlackboardValueAsInt(BTNode NodeOwner, BlackboardKeySelector Key)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetBlackboardValueAsName(BTNode, BlackboardKeySelector)

Get Blackboard Value as Name

Declaration
public static Name GetBlackboardValueAsName(BTNode NodeOwner, BlackboardKeySelector Key)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
Returns
Type Description
Name
| Improve this Doc View Source

GetBlackboardValueAsObject(BTNode, BlackboardKeySelector)

Get Blackboard Value as Object

Declaration
public static UObject GetBlackboardValueAsObject(BTNode NodeOwner, BlackboardKeySelector Key)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
Returns
Type Description
UObject
| Improve this Doc View Source

GetBlackboardValueAsRotator(BTNode, BlackboardKeySelector)

Get Blackboard Value as Rotator

Declaration
public static Rotator GetBlackboardValueAsRotator(BTNode NodeOwner, BlackboardKeySelector Key)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
Returns
Type Description
Rotator
| Improve this Doc View Source

GetBlackboardValueAsString(BTNode, BlackboardKeySelector)

Get Blackboard Value as String

Declaration
public static string GetBlackboardValueAsString(BTNode NodeOwner, BlackboardKeySelector Key)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
Returns
Type Description
System.String
| Improve this Doc View Source

GetBlackboardValueAsVector(BTNode, BlackboardKeySelector)

Get Blackboard Value as Vector

Declaration
public static Vector GetBlackboardValueAsVector(BTNode NodeOwner, BlackboardKeySelector Key)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
Returns
Type Description
Vector
| Improve this Doc View Source

GetOwnerComponent(BTNode)

Get Owner Component

Declaration
public static BehaviorTreeComponent GetOwnerComponent(BTNode NodeOwner)
Parameters
Type Name Description
BTNode NodeOwner
Returns
Type Description
BehaviorTreeComponent
| Improve this Doc View Source

GetOwnersBlackboard(BTNode)

Get Owners Blackboard

Declaration
public static BlackboardComponent GetOwnersBlackboard(BTNode NodeOwner)
Parameters
Type Name Description
BTNode NodeOwner
Returns
Type Description
BlackboardComponent
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static BTFunctionLibrary New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
BTFunctionLibrary
| Improve this Doc View Source

SetBlackboardValueAsBool(BTNode, BlackboardKeySelector, Boolean)

Set Blackboard Value as Bool

Declaration
public static void SetBlackboardValueAsBool(BTNode NodeOwner, BlackboardKeySelector Key, bool Value)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
System.Boolean Value
| Improve this Doc View Source

SetBlackboardValueAsClass(BTNode, BlackboardKeySelector, SubclassOf<UObject>)

Set Blackboard Value as Class

Declaration
public static void SetBlackboardValueAsClass(BTNode NodeOwner, BlackboardKeySelector Key, SubclassOf<UObject> Value)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
SubclassOf<UObject> Value
| Improve this Doc View Source

SetBlackboardValueAsEnum(BTNode, BlackboardKeySelector, Byte)

Set Blackboard Value as Enum

Declaration
public static void SetBlackboardValueAsEnum(BTNode NodeOwner, BlackboardKeySelector Key, byte Value)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
System.Byte Value
| Improve this Doc View Source

SetBlackboardValueAsFloat(BTNode, BlackboardKeySelector, Single)

Set Blackboard Value as Float

Declaration
public static void SetBlackboardValueAsFloat(BTNode NodeOwner, BlackboardKeySelector Key, float Value)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
System.Single Value
| Improve this Doc View Source

SetBlackboardValueAsInt(BTNode, BlackboardKeySelector, Int32)

Set Blackboard Value as Int

Declaration
public static void SetBlackboardValueAsInt(BTNode NodeOwner, BlackboardKeySelector Key, int Value)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
System.Int32 Value
| Improve this Doc View Source

SetBlackboardValueAsName(BTNode, BlackboardKeySelector, Name)

Set Blackboard Value as Name

Declaration
public static void SetBlackboardValueAsName(BTNode NodeOwner, BlackboardKeySelector Key, Name Value)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
Name Value
| Improve this Doc View Source

SetBlackboardValueAsObject(BTNode, BlackboardKeySelector, UObject)

Set Blackboard Value as Object

Declaration
public static void SetBlackboardValueAsObject(BTNode NodeOwner, BlackboardKeySelector Key, UObject Value)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
UObject Value
| Improve this Doc View Source

SetBlackboardValueAsRotator(BTNode, BlackboardKeySelector, Rotator)

Set Blackboard Value as Rotator

Declaration
public static void SetBlackboardValueAsRotator(BTNode NodeOwner, BlackboardKeySelector Key, Rotator Value)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
Rotator Value
| Improve this Doc View Source

SetBlackboardValueAsString(BTNode, BlackboardKeySelector, String)

Set Blackboard Value as String

Declaration
public static void SetBlackboardValueAsString(BTNode NodeOwner, BlackboardKeySelector Key, string Value)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
System.String Value
| Improve this Doc View Source

SetBlackboardValueAsVector(BTNode, BlackboardKeySelector, Vector)

Set Blackboard Value as Vector

Declaration
public static void SetBlackboardValueAsVector(BTNode NodeOwner, BlackboardKeySelector Key, Vector Value)
Parameters
Type Name Description
BTNode NodeOwner
BlackboardKeySelector Key
Vector Value
| Improve this Doc View Source

StartUsingExternalEvent(BTNode, Actor)

Initialize variables marked as "instance memory" and set owning actor for blackboard operations

Declaration
public static void StartUsingExternalEvent(BTNode NodeOwner, Actor OwningActor)
Parameters
Type Name Description
BTNode NodeOwner
Actor OwningActor
| Improve this Doc View Source

StopUsingExternalEvent(BTNode)

Save variables marked as "instance memory" and clear owning actor

Declaration
public static void StopUsingExternalEvent(BTNode NodeOwner)
Parameters
Type Name Description
BTNode NodeOwner

Operators

| Improve this Doc View Source

Implicit(IntPtr to BTFunctionLibrary)

Convert from IntPtr to UObject

Declaration
public static implicit operator BTFunctionLibrary(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
BTFunctionLibrary
  • Improve this Doc
  • View Source
Back to top Generated by DocFX