intrinsic.solutions.behavior_tree.Debug

View source on GitHub

A BT node of type Debug for behavior_tree_pb2.BehaviorTree.DebugNode.

Inherits From: Node

intrinsic.solutions.behavior_tree.Debug(
fail_on_resume: Optional[bool] = False, name: Optional[str] = None
)

A node that can be used to suspend the tree. Using the optional suspend behavior the outcome of the debug node can be defined (success vs failure).

Attributes
fail_on_resume	Describes whether the node should succeed or fail after resuming. Defaults to succeed.
proto	The proto representation of the node.
node_type	A string label of the node type.
breakpoint
decorators
execution_mode
name
node_id

Methods

create_from_proto

View source

@classmethodcreate_from_proto(
proto_object: behavior_tree_pb2.BehaviorTree.Node
) -> 'Node'

Instantiates a Node instance from a proto.

disable_execution

View source

disable_execution(
result_state: Optional[intrinsic.solutions.behavior_tree.DisabledResultState] = None
) -> 'Node'

Disables a node, so that it is not executed and appears to be skipped.

Args
result_state	Optionally force the result of the execution to this state. If not set, the resulting state is automatically determined, so that the node is skipped.

Returns
Builder pattern, returns self.

dot_graph

View source

dot_graph(
node_id_suffix: str = ''
) -> Tuple[graphviz.Digraph, str]

Generates a graphviz subgraph with a single node for self.

Args
node_id_suffix	A little string of form _1_2, which is just a suffix to make a unique node name in the graph. If the node names clash within the graph, they are merged into one, and we do not want to merge unrelated nodes.
node_label	The label is typically just the type of the node. To use a different value, this argument can be used.
name	name of the node as set by the user.

Returns
A tuple of the generated graphviz dot graph and the name of the graph's root node.

enable_execution

View source

enable_execution() -> 'Node'

Enables a node, so that it will be executed.

Returns
Builder pattern, returns self.

generate_and_set_unique_id

View source

generate_and_set_unique_id() -> int

Generates a new random id and sets it for this node.

set_breakpoint

View source

set_breakpoint(
breakpoint_type: Optional['BreakpointType']
) -> 'Node'

Sets the breakpoint type on the decorator.

Args
breakpoint_type	desired breakpoint type, None to remove type.

Returns
Builder pattern, returns self.

set_decorators

View source

set_decorators(
decorators: Optional['Decorators']
) -> 'Node'

show

View source

show() -> None

visit

View source

visit(
containing_tree: 'BehaviorTree',
callback: Callable[['BehaviorTree', Union['BehaviorTree', 'Node', 'Condition']], None]
) -> None