diff --git a/doc/source/classes/class_behaviortree.rst b/doc/source/classes/class_behaviortree.rst index 1781152..c066836 100644 --- a/doc/source/classes/class_behaviortree.rst +++ b/doc/source/classes/class_behaviortree.rst @@ -174,7 +174,7 @@ Returns the root task of the BehaviorTree resource. :ref:`BTInstance` **instantiate**\ (\ agent\: ``Node``, blackboard\: :ref:`Blackboard`, instance_owner\: ``Node``, custom_scene_root\: ``Node`` = null\ ) |const| :ref:`🔗` -Instantiates the behavior tree and returns :ref:`BTInstance`. ``instance_owner`` should be the scene node that will own the behavior tree instance. This is typically a :ref:`BTPlayer`, :ref:`BTState`, or a custom player node that controls the behavior tree execution. Make sure to pass a :ref:`Blackboard` with values populated from :ref:`blackboard_plan`. See also ``BlackboardPlan.populate_blackboard`` & ``BlackboardPlan.create_blackboard``. +Instantiates the behavior tree and returns :ref:`BTInstance`. ``instance_owner`` should be the scene node that will own the behavior tree instance. This is typically a :ref:`BTPlayer`, :ref:`BTState`, or a custom player node that controls the behavior tree execution. Make sure to pass a :ref:`Blackboard` with values populated from :ref:`blackboard_plan`. See also :ref:`BlackboardPlan.populate_blackboard` & :ref:`BlackboardPlan.create_blackboard`. If ``custom_scene_root`` is not ``null``, it will be used as the scene root for the newly instantiated behavior tree; otherwise, the scene root will be set to ``instance_owner.owner``. Scene root is essential for :ref:`BBNode` instances to work properly. diff --git a/doc/source/classes/class_btplayer.rst b/doc/source/classes/class_btplayer.rst index 3f5a8cc..60bd8c7 100644 --- a/doc/source/classes/class_btplayer.rst +++ b/doc/source/classes/class_btplayer.rst @@ -299,7 +299,7 @@ Resets the behavior tree's execution. Each running task will be aborted and the |void| **set_bt_instance**\ (\ bt_instance\: :ref:`BTInstance`\ ) :ref:`🔗` -Sets the :ref:`BTInstance` to play. This method is useful when you want to switch to a different behavior tree instance at runtime. See also :ref:`BehaviorTree.instantiate`. +Sets the :ref:`BTInstance` to play. This method is useful when you want to switch to a different behavior tree instance at runtime. See also :ref:`BehaviorTree.instantiate`. .. rst-class:: classref-item-separator diff --git a/doc_classes/BTPlayer.xml b/doc_classes/BTPlayer.xml index 1296fc8..7ce6ffd 100644 --- a/doc_classes/BTPlayer.xml +++ b/doc_classes/BTPlayer.xml @@ -26,7 +26,7 @@ - Sets the [BTInstance] to play. This method is useful when you want to switch to a different behavior tree instance at runtime. See also [member BehaviorTree.instantiate]. + Sets the [BTInstance] to play. This method is useful when you want to switch to a different behavior tree instance at runtime. See also [method BehaviorTree.instantiate]. diff --git a/doc_classes/BehaviorTree.xml b/doc_classes/BehaviorTree.xml index bf56cce..f2a4f2d 100644 --- a/doc_classes/BehaviorTree.xml +++ b/doc_classes/BehaviorTree.xml @@ -41,7 +41,7 @@ - Instantiates the behavior tree and returns [BTInstance]. [param instance_owner] should be the scene node that will own the behavior tree instance. This is typically a [BTPlayer], [BTState], or a custom player node that controls the behavior tree execution. Make sure to pass a [Blackboard] with values populated from [member blackboard_plan]. See also [BlackboardPlan.populate_blackboard] & [BlackboardPlan.create_blackboard]. + Instantiates the behavior tree and returns [BTInstance]. [param instance_owner] should be the scene node that will own the behavior tree instance. This is typically a [BTPlayer], [BTState], or a custom player node that controls the behavior tree execution. Make sure to pass a [Blackboard] with values populated from [member blackboard_plan]. See also [method BlackboardPlan.populate_blackboard] & [method BlackboardPlan.create_blackboard]. If [param custom_scene_root] is not [code]null[/code], it will be used as the scene root for the newly instantiated behavior tree; otherwise, the scene root will be set to [code]instance_owner.owner[/code]. Scene root is essential for [BBNode] instances to work properly.