.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/limboai/doc_classes/BTPlayer.xml.
.._class_BTPlayer:
BTPlayer
========
**Inherits:**
Player of :ref:`BehaviorTree<class_BehaviorTree>` resources.
..rst-class:: classref-introduction-group
Description
-----------
BTPlayer node is used for the instantiation and playback of :ref:`BehaviorTree<class_BehaviorTree>` resources at runtime. During instantiation, the behavior tree instance is initialized with a reference to the agent and the :ref:`blackboard<class_BTPlayer_property_blackboard>`. Agent is the owner of the BTPlayer node (see :ref:`Node.owner<class_Node_member_owner>`).
For an introduction to behavior trees, see :ref:`BehaviorTree<class_BehaviorTree>`.
- void **set_prefetch_nodepath_vars****(** bool value **)**
- bool **get_prefetch_nodepath_vars****(****)**
If ``true``, any ``NodePath`` variables in the :ref:`Blackboard<class_Blackboard>` are replaced with ``Node`` references when the tree is instantiated. References are retrieved by calling :ref:`Node.get_node<class_Node_method_get_node>` on the agent instance (agent is the owner of the BTPlayer node).
Determines when the behavior tree is executed. See :ref:`UpdateMode<enum_BTPlayer_UpdateMode>`.
..rst-class:: classref-section-separator
----
..rst-class:: classref-descriptions-group
Method Descriptions
-------------------
.._class_BTPlayer_method_get_last_status:
..rst-class:: classref-method
int **get_last_status****(****)** |const|
Returns the behavior tree's last execution status. See :ref:`Status<enum_BT_Status>`.
..rst-class:: classref-item-separator
----
.._class_BTPlayer_method_restart:
..rst-class:: classref-method
void **restart****(****)**
Resets the behavior tree's execution. Each running task will be aborted and the next tree execution will start anew. This method does not reset :ref:`Blackboard<class_Blackboard>`.
..rst-class:: classref-item-separator
----
.._class_BTPlayer_method_update:
..rst-class:: classref-method
void **update****(** float p_delta **)**
Executes the root task of the behavior tree instance if :ref:`active<class_BTPlayer_property_active>` is ``true``. Call this method when :ref:`update_mode<class_BTPlayer_property_update_mode>` is set to :ref:`MANUAL<class_BTPlayer_constant_MANUAL>`. When :ref:`update_mode<class_BTPlayer_property_update_mode>` is not :ref:`MANUAL<class_BTPlayer_constant_MANUAL>`, the :ref:`update<class_BTPlayer_method_update>` will be called automatically. See :ref:`UpdateMode<enum_BTPlayer_UpdateMode>`.
..|virtual|replace:::abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
..|const|replace:::abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
..|vararg|replace:::abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
..|constructor|replace:::abbr:`constructor (This method is used to construct a type.)`
..|static|replace:::abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
..|operator|replace:::abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
..|bitfield|replace:::abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
