<779> <1/> update_interval_msec = <2/> 🔗 <780> <1/> set_update_interval_msec(value: <2/>) <781> <1/> get_update_interval_msec() <782> Minimum delay between two updates (in milliseconds). Set to higher values for a lower CPU load. <783> <1/> clear() 🔗 <784> Clears the tree view. <785> <1/> update_tree(behavior_tree_data: BehaviorTreeData) 🔗 <786> Updates the representation of a BehaviorTree instance. See also BehaviorTreeData. <787> BlackboardPlan <788> prefetch_nodepath_vars <789> create_blackboard(prefetch_root: <2/>, parent_scope: Blackboard = null, prefetch_root_for_base_plan: <4/> = null) <790> BlackboardPlan <791> get_base_plan() <2/> <792> get_parent_scope_plan_provider() <2/> <793> is_derived() <2/> <794> populate_blackboard(blackboard: Blackboard, overwrite: <3/>, prefetch_root: <4/>, prefetch_root_for_base_plan: <5/> = null) <795> set_base_plan(blackboard_plan: BlackboardPlan) <796> set_parent_scope_plan_provider(callable: <2/>) <797> sync_with_base_plan() <798> <1/> prefetch_nodepath_vars = <2/> 🔗 <799> <1/> set_prefetch_nodepath_vars(value: <2/>) <800> <1/> is_prefetching_nodepath_vars() <801> Enables or disables <1/> variable prefetching. If <2/>, <3/> values will be replaced with node instances when the Blackboard is created. <802> Blackboard create_blackboard(prefetch_root: <2/>, parent_scope: Blackboard = null, prefetch_root_for_base_plan: <4/> = null) 🔗 <803> Constructs a new instance of a Blackboard using this plan. If <2/> prefetching is enabled, <3/> will be used to retrieve node instances for <4/> variables and substitute their values. <804> BlackboardPlan get_base_plan() <2/> 🔗 <805> Returns the base plan. See is_derived. <806> <1/> get_parent_scope_plan_provider() <2/> 🔗 <807> Returns the parent scope plan provider - a callable that returns a BlackboardPlan. <808> <1/> is_derived() <2/> 🔗 <809> Returns <1/> if this plan is derived from another, i.e., the base plan is not <2/>. A derived plan can only contain variables that are present in the base plan, and only variable values can be different. <810> <1/> populate_blackboard(blackboard: Blackboard, overwrite: <3/>, prefetch_root: <4/>, prefetch_root_for_base_plan: <5/> = null) 🔗 <811> Populates <1/> with the variables from this plan. If <2/> is <3/>, existing variables with the same names will be overwritten. If <4/> prefetching is enabled, <5/> will be used to retrieve node instances for <6/> variables and substitute their values. <812> <1/> set_base_plan(blackboard_plan: BlackboardPlan) 🔗 <813> Sets the base plan. If assigned, this plan will be derived from the base plan. <814> Use with caution, as it will remove variables not present in the base plan. Only use this for custom tooling. <815> <1/> set_parent_scope_plan_provider(callable: <2/>) 🔗 <816> Sets the parent scope plan provider - a callable that returns a BlackboardPlan. Used to provide hints in the inspector. When set, mapping feature becomes available. <817> <1/> sync_with_base_plan() 🔗 <818> Synchronizes this plan with the base plan: removes variables not present in the base plan, and updates type information. Only use this for custom tooling. <819> BT <820> Inherited By: BTTask <821> Base of BTTask. <822> enum Status: 🔗 <823> Status FRESH = <2/> <824> Task wasn’t executed yet or it was aborted and reset. <825> Status RUNNING = <2/> <826> Task is being performed and hasn’t finished yet. <827> Status FAILURE = <2/> <828> Task has finished with failure. <829> Status SUCCESS = <2/> <830> Task has finished with success. <831> BTAction <832> Inherits: BTTask < BT <833> Inherited By: BTAwaitAnimation, BTCallMethod, BTConsolePrint, BTEvaluateExpression, BTFail, BTPauseAnimation, BTPlayAnimation, BTRandomWait, BTSetAgentProperty, BTSetVar, BTStopAnimation, BTWait, BTWaitTicks <834> Base class for all BehaviorTree actions. <835> Base class for all actions within a BehaviorTree. You can create your own actions by extending the BTAction class. <836> Represents a specific behavior or action in a BehaviorTree that an agent should execute. Actions are the lowest level of the BehaviorTree hierarchy and are responsible for performing the actual work required to achieve a goal. Actions do not have child tasks. <837> A single action can perform a task within one or multiple ticks. If it takes more than one tick to complete the task, the action should return <1/> status. When the task is finished, the action returns either <2/> or <3/> to indicate the outcome. <838> BTAlwaysFail <839> Inherits: BTDecorator < BTTask < BT <840> BT decorator that converts <1/> into <2/>. <841> BTAlwaysSucceed <842> BT decorator that converts <1/> into <2/>. <843> BTAwaitAnimation <844> Inherits: BTAction < BTTask < BT <845> BT action that waits for an animation to finish playing. <846> BTAwaitAnimation action waits for an animation on the specified <1/> node to finish playing and returns <2/>. <847> Returns <1/> if the specified animation has finished playing or if the specified animation is not currently playing. <848> Returns <1/> if the specified animation doesn’t exist or if the action fails to get the <2/> node. <849> animation_name <850> BBNode <851> animation_player <852> max_time <853> <1/> animation_name = <2/> 🔗 <854> <1/> set_animation_name(value: <2/>) <855> <1/> get_animation_name() <856> Animation’s key within the <1/> node. <857> BBNode animation_player 🔗 <858> <1/> set_animation_player(value: BBNode) <859> BBNode get_animation_player() <860> Parameter that specifies the <1/> node. <861> <1/> max_time = <2/> 🔗 <862> <1/> set_max_time(value: <2/>) <863> <1/> get_max_time() <864> The maximum duration to wait for the animation to complete (in seconds). If the animation doesn’t finish within this time, BTAwaitAnimation will stop waiting and return <1/>. <865> BTCallMethod <866> BT action that calls a method on a specified <1/> or <2/>. <867> BTCallMethod action calls a method on the specified <2/> or <3/> instance and returns <4/>. <868> Returns <1/> if the action encounters an issue during the method execution. <869> Array[BBVariant] <870> args <871> args_include_delta <872> method <873> node <874> result_var <875> Array[BBVariant] args = <2/> 🔗 <876> <1/> set_args(value: Array[BBVariant]) <877> Array[BBVariant] get_args() <878> The arguments to be passed when calling the method. <879> <1/> args_include_delta = <2/> 🔗 <880> <1/> set_include_delta(value: <2/>) <881> <1/> is_delta_included() <882> Include delta as a first parameter and shift the position of the rest of the arguments if any. <883> <1/> method = <2/> 🔗 <884> <1/> set_method(value: <2/>) <885> <1/> get_method() <886> The name of the method to be called. <887> BBNode node 🔗 <888> <1/> set_node_param(value: BBNode) <889> BBNode get_node_param() <890> Specifies the <1/> or <2/> instance containing the method to be called. <891> <1/> result_var = <2/> 🔗 <892> <1/> set_result_var(value: <2/>) <893> <1/> get_result_var() <894> if non-empty, assign the result of the method call to the blackboard variable specified by this property. <895> BTCheckAgentProperty <896> Inherits: BTCondition < BTTask < BT <897> BT condition that checks agent’s property value. <898> BTCheckAgentProperty examines the agent’s property value and compares it to value. <899> Returns <1/> or <2/> based on the check_type. <900> CheckType <901> check_type <902> property <903> BBVariant <904> value <905> CheckType check_type = <2/> 🔗 <906> <1/> set_check_type(value: CheckType) <907> CheckType get_check_type() <908> The type of check to be performed. <909> <1/> property = <2/> 🔗 <910> <1/> set_property(value: <2/>) <911> <1/> get_property() <912> Parameter that specifies the agent’s property to be compared. <913> BBVariant value 🔗 <914> <1/> set_value(value: BBVariant) <915> BBVariant get_value() <916> Parameter that specifies the value against which an agent’s property will be compared. <917> BTCheckTrigger <918> BT condition that checks a trigger (a boolean variable). <919> BTCheckTrigger verifies whether the variable is set to <2/>. If it is, the task switches it to <3/> and returns <4/>. Otherwise, it returns <5/>. <920> BTCheckTrigger can function as a “gate” within a BTSequence: when the trigger variable is set to <2/>, it permits the execution of subsequent tasks and then changes the variable to <3/>. <921> variable <922> <1/> variable = <2/> 🔗 <923> A boolean variable on the blackboard used as a trigger. See also BTTask.blackboard. <924> If variable’s value is <1/>, BTCheckTrigger will switch it to <2/> and return <3/>. <925> If variable’s value is <1/>, BTCheckTrigger will return <2/>. <926> BTCheckVar <927> BT condition that checks a variable on the blackboard. <928> BTCheckVar evaluates the variable against value and returns <3/> or <4/> based on the check_type. <929> check_type <930> value <931> variable <932> CheckType check_type = <2/> 🔗 <933> BBVariant value 🔗 <934> A parameter that specifies the value against which the variable will be compared. <935> <1/> variable = <2/> 🔗 <936> The name of the variable to check its value. <937> BTComment <938> BTComment adds annotations or explanatory notes to a BehaviorTree. <939> BTComment is used to add annotations or explanatory notes to a BehaviorTree. <940> Comments are not executed as part of the tree and are removed from runtime instances of the BehaviorTree. <941> BTComposite <942> Inherited By: BTDynamicSelector, BTDynamicSequence, BTParallel, BTProbabilitySelector, BTRandomSelector, BTRandomSequence, BTSelector, BTSequence