unreal.BTFunctionLibrary

class unreal.BTFunctionLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

BTFunction Library

C++ Source:

  • Module: AIModule

  • File: BTFunctionLibrary.h

classmethod clear_blackboard_value(node_owner, key) None

Resets indicated value to “not set” value, based on values type

Parameters:
classmethod clear_blackboard_value_as_vector(node_owner, key) None

(DEPRECATED) Use ClearBlackboardValue instead deprecated: Use ClearBlackboardValue instead.

Parameters:
classmethod get_blackboard(node_owner: BTNode) BlackboardComponent

deprecated: ‘get_blackboard’ was renamed to ‘get_owners_blackboard’.

classmethod get_blackboard_value_as_actor(node_owner, key) Actor

Get Blackboard Value as Actor

Parameters:
Return type:

Actor

classmethod get_blackboard_value_as_bool(node_owner, key) bool

Get Blackboard Value as Bool

Parameters:
Return type:

bool

classmethod get_blackboard_value_as_class(node_owner, key)

Get Blackboard Value as Class

Parameters:
Return type:

type(Class)

classmethod get_blackboard_value_as_enum(node_owner, key) uint8

Get Blackboard Value as Enum

Parameters:
Return type:

uint8

classmethod get_blackboard_value_as_float(node_owner, key) float

Get Blackboard Value as Float

Parameters:
Return type:

float

classmethod get_blackboard_value_as_int(node_owner, key) int32

Get Blackboard Value as Int

Parameters:
Return type:

int32

classmethod get_blackboard_value_as_name(node_owner, key) Name

Get Blackboard Value as Name

Parameters:
Return type:

Name

classmethod get_blackboard_value_as_object(node_owner, key) Object

Get Blackboard Value as Object

Parameters:
Return type:

Object

classmethod get_blackboard_value_as_rotator(node_owner, key) Rotator

Get Blackboard Value as Rotator

Parameters:
Return type:

Rotator

classmethod get_blackboard_value_as_string(node_owner, key) str

Get Blackboard Value as String

Parameters:
Return type:

str

classmethod get_blackboard_value_as_vector(node_owner, key) Vector

Get Blackboard Value as Vector

Parameters:
Return type:

Vector

classmethod get_owner_component(node_owner) BehaviorTreeComponent

Get Owner Component

Parameters:

node_owner (BTNode) –

Return type:

BehaviorTreeComponent

classmethod get_owners_blackboard(node_owner) BlackboardComponent

Get Owners Blackboard

Parameters:

node_owner (BTNode) –

Return type:

BlackboardComponent

classmethod set_blackboard_value_as_bool(node_owner, key, value) None

Set Blackboard Value as Bool

Parameters:
classmethod set_blackboard_value_as_class(node_owner, key, value) None

Set Blackboard Value as Class

Parameters:
classmethod set_blackboard_value_as_enum(node_owner, key, value) None

Set Blackboard Value as Enum

Parameters:
classmethod set_blackboard_value_as_float(node_owner, key, value) None

Set Blackboard Value as Float

Parameters:
classmethod set_blackboard_value_as_int(node_owner, key, value) None

Set Blackboard Value as Int

Parameters:
classmethod set_blackboard_value_as_name(node_owner, key, value) None

Set Blackboard Value as Name

Parameters:
classmethod set_blackboard_value_as_object(node_owner, key, value) None

Set Blackboard Value as Object

Parameters:
classmethod set_blackboard_value_as_rotator(node_owner, key, value) None

Set Blackboard Value as Rotator

Parameters:
classmethod set_blackboard_value_as_string(node_owner, key, value) None

Set Blackboard Value as String

Parameters:
classmethod set_blackboard_value_as_vector(node_owner, key, value) None

Set Blackboard Value as Vector

Parameters:
classmethod start_using_external_event(node_owner, owning_actor) None

Initialize variables marked as “instance memory” and set owning actor for blackboard operations deprecated: No longer needed

Parameters:
classmethod stop_using_external_event(node_owner) None

Save variables marked as “instance memory” and clear owning actor deprecated: No longer needed

Parameters:

node_owner (BTNode) –