BTState

A state node for LimboHSM that hosts a BehaviorTree.

Description

BTState is a LimboState node that manages a BehaviorTree to provide behavior logic for the state. It instantiates and runs the BehaviorTree resource, dispatching a state machine event upon SUCCESS or FAILURE. Event names are customizable through success_event and failure_event. For further details on state machine events, see LimboState.dispatch.

Properties

BehaviorTree	behavior_tree
StringName	failure_event	`&"failure"`
StringName	success_event	`&"success"`

Methods

BTTask

get_tree_instance ( ) const

Property Descriptions

BehaviorTree behavior_tree

void set_behavior_tree ( BehaviorTree value )
BehaviorTree get_behavior_tree ( )

A BehaviorTree resource that defines state behavior.

StringName failure_event = &"failure"

void set_failure_event ( StringName value )
StringName get_failure_event ( )

HSM event that will be dispatched when the behavior tree results in FAILURE. See LimboState.dispatch.

StringName success_event = &"success"

void set_success_event ( StringName value )
StringName get_success_event ( )

HSM event that will be dispatched when the behavior tree results in SUCCESS. See LimboState.dispatch.

Method Descriptions

BTTask get_tree_instance ( ) const

Returns the root task of the instantiated behavior tree.