164 lines
11 KiB
Plaintext
164 lines
11 KiB
Plaintext
<779> <1/> <b>update_interval_msec</b> = <2/> <l3>🔗</l>
|
||
<780> <1/> <b>set_update_interval_msec</b>(value: <2/>)
|
||
<781> <1/> <b>get_update_interval_msec</b>()
|
||
<782> Minimum delay between two updates (in milliseconds). Set to higher values for a lower CPU load.
|
||
<783> <1/> <b>clear</b>() <l2>🔗</l>
|
||
<784> Clears the tree view.
|
||
<785> <1/> <b>update_tree</b>(behavior_tree_data: <l2>BehaviorTreeData</l>) <l3>🔗</l>
|
||
<786> Updates the representation of a <l1>BehaviorTree</l> instance. See also <l2>BehaviorTreeData</l>.
|
||
<787> BlackboardPlan
|
||
<788> <l1>prefetch_nodepath_vars</l>
|
||
<789> <l1>create_blackboard</l>(prefetch_root: <2/>, parent_scope: <l3>Blackboard</l> = null, prefetch_root_for_base_plan: <4/> = null)
|
||
<790> <l1>BlackboardPlan</l>
|
||
<791> <l1>get_base_plan</l>() <2/>
|
||
<792> <l1>get_parent_scope_plan_provider</l>() <2/>
|
||
<793> <l1>is_derived</l>() <2/>
|
||
<794> <l1>populate_blackboard</l>(blackboard: <l2>Blackboard</l>, overwrite: <3/>, prefetch_root: <4/>, prefetch_root_for_base_plan: <5/> = null)
|
||
<795> <l1>set_base_plan</l>(blackboard_plan: <l2>BlackboardPlan</l>)
|
||
<796> <l1>set_parent_scope_plan_provider</l>(callable: <2/>)
|
||
<797> <l1>sync_with_base_plan</l>()
|
||
<798> <1/> <b>prefetch_nodepath_vars</b> = <2/> <l3>🔗</l>
|
||
<799> <1/> <b>set_prefetch_nodepath_vars</b>(value: <2/>)
|
||
<800> <1/> <b>is_prefetching_nodepath_vars</b>()
|
||
<801> Enables or disables <1/> variable prefetching. If <2/>, <3/> values will be replaced with node instances when the <l4>Blackboard</l> is created.
|
||
<802> <l1>Blackboard</l> <b>create_blackboard</b>(prefetch_root: <2/>, parent_scope: <l3>Blackboard</l> = null, prefetch_root_for_base_plan: <4/> = null) <l5>🔗</l>
|
||
<803> Constructs a new instance of a <l1>Blackboard</l> using this plan. If <2/> prefetching is enabled, <3/> will be used to retrieve node instances for <4/> variables and substitute their values.
|
||
<804> <l1>BlackboardPlan</l> <b>get_base_plan</b>() <2/> <l3>🔗</l>
|
||
<805> Returns the base plan. See <l1>is_derived</l>.
|
||
<806> <1/> <b>get_parent_scope_plan_provider</b>() <2/> <l3>🔗</l>
|
||
<807> Returns the parent scope plan provider - a callable that returns a <b>BlackboardPlan</b>.
|
||
<808> <1/> <b>is_derived</b>() <2/> <l3>🔗</l>
|
||
<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/> <b>populate_blackboard</b>(blackboard: <l2>Blackboard</l>, overwrite: <3/>, prefetch_root: <4/>, prefetch_root_for_base_plan: <5/> = null) <l6>🔗</l>
|
||
<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/> <b>set_base_plan</b>(blackboard_plan: <l2>BlackboardPlan</l>) <l3>🔗</l>
|
||
<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/> <b>set_parent_scope_plan_provider</b>(callable: <2/>) <l3>🔗</l>
|
||
<816> Sets the parent scope plan provider - a callable that returns a <b>BlackboardPlan</b>. Used to provide hints in the inspector. When set, mapping feature becomes available.
|
||
<817> <1/> <b>sync_with_base_plan</b>() <l2>🔗</l>
|
||
<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> <b>Inherited By:</b> <l1>BTTask</l>
|
||
<821> Base of <l1>BTTask</l>.
|
||
<822> enum <b>Status</b>: <l1>🔗</l>
|
||
<823> <l1>Status</l> <b>FRESH</b> = <2/>
|
||
<824> Task wasn’t executed yet or it was aborted and reset.
|
||
<825> <l1>Status</l> <b>RUNNING</b> = <2/>
|
||
<826> Task is being performed and hasn’t finished yet.
|
||
<827> <l1>Status</l> <b>FAILURE</b> = <2/>
|
||
<828> Task has finished with failure.
|
||
<829> <l1>Status</l> <b>SUCCESS</b> = <2/>
|
||
<830> Task has finished with success.
|
||
<831> BTAction
|
||
<832> <b>Inherits:</b> <l1>BTTask</l> <b><</b> <l2>BT</l>
|
||
<833> <b>Inherited By:</b> <l1>BTAwaitAnimation</l>, <l2>BTCallMethod</l>, <l3>BTConsolePrint</l>, <l4>BTEvaluateExpression</l>, <l5>BTFail</l>, <l6>BTPauseAnimation</l>, <l7>BTPlayAnimation</l>, <l8>BTRandomWait</l>, <l9>BTSetAgentProperty</l>, <l10>BTSetVar</l>, <l11>BTStopAnimation</l>, <l12>BTWait</l>, <l13>BTWaitTicks</l>
|
||
<834> Base class for all <l1>BehaviorTree</l> actions.
|
||
<835> Base class for all actions within a <l1>BehaviorTree</l>. You can create your own actions by extending the <b>BTAction</b> class.
|
||
<836> Represents a specific behavior or action in a <l1>BehaviorTree</l> that an agent should execute. Actions are the lowest level of the <l2>BehaviorTree</l> 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> <b>Inherits:</b> <l1>BTDecorator</l> <b><</b> <l2>BTTask</l> <b><</b> <l3>BT</l>
|
||
<840> BT decorator that converts <1/> into <2/>.
|
||
<841> BTAlwaysSucceed
|
||
<842> BT decorator that converts <1/> into <2/>.
|
||
<843> BTAwaitAnimation
|
||
<844> <b>Inherits:</b> <l1>BTAction</l> <b><</b> <l2>BTTask</l> <b><</b> <l3>BT</l>
|
||
<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> <l1>animation_name</l>
|
||
<850> <l1>BBNode</l>
|
||
<851> <l1>animation_player</l>
|
||
<852> <l1>max_time</l>
|
||
<853> <1/> <b>animation_name</b> = <2/> <l3>🔗</l>
|
||
<854> <1/> <b>set_animation_name</b>(value: <2/>)
|
||
<855> <1/> <b>get_animation_name</b>()
|
||
<856> Animation’s key within the <1/> node.
|
||
<857> <l1>BBNode</l> <b>animation_player</b> <l2>🔗</l>
|
||
<858> <1/> <b>set_animation_player</b>(value: <l2>BBNode</l>)
|
||
<859> <l1>BBNode</l> <b>get_animation_player</b>()
|
||
<860> Parameter that specifies the <1/> node.
|
||
<861> <1/> <b>max_time</b> = <2/> <l3>🔗</l>
|
||
<862> <1/> <b>set_max_time</b>(value: <2/>)
|
||
<863> <1/> <b>get_max_time</b>()
|
||
<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 <l1>method</l> 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[<l1>BBVariant</l>]
|
||
<870> <l1>args</l>
|
||
<871> <l1>args_include_delta</l>
|
||
<872> <l1>method</l>
|
||
<873> <l1>node</l>
|
||
<874> <l1>result_var</l>
|
||
<875> Array[<l1>BBVariant</l>] <b>args</b> = <2/> <l3>🔗</l>
|
||
<876> <1/> <b>set_args</b>(value: Array[<l2>BBVariant</l>])
|
||
<877> Array[<l1>BBVariant</l>] <b>get_args</b>()
|
||
<878> The arguments to be passed when calling the method.
|
||
<879> <1/> <b>args_include_delta</b> = <2/> <l3>🔗</l>
|
||
<880> <1/> <b>set_include_delta</b>(value: <2/>)
|
||
<881> <1/> <b>is_delta_included</b>()
|
||
<882> Include delta as a first parameter and shift the position of the rest of the arguments if any.
|
||
<883> <1/> <b>method</b> = <2/> <l3>🔗</l>
|
||
<884> <1/> <b>set_method</b>(value: <2/>)
|
||
<885> <1/> <b>get_method</b>()
|
||
<886> The name of the method to be called.
|
||
<887> <l1>BBNode</l> <b>node</b> <l2>🔗</l>
|
||
<888> <1/> <b>set_node_param</b>(value: <l2>BBNode</l>)
|
||
<889> <l1>BBNode</l> <b>get_node_param</b>()
|
||
<890> Specifies the <1/> or <2/> instance containing the method to be called.
|
||
<891> <1/> <b>result_var</b> = <2/> <l3>🔗</l>
|
||
<892> <1/> <b>set_result_var</b>(value: <2/>)
|
||
<893> <1/> <b>get_result_var</b>()
|
||
<894> if non-empty, assign the result of the method call to the blackboard variable specified by this property.
|
||
<895> BTCheckAgentProperty
|
||
<896> <b>Inherits:</b> <l1>BTCondition</l> <b><</b> <l2>BTTask</l> <b><</b> <l3>BT</l>
|
||
<897> BT condition that checks agent’s property value.
|
||
<898> BTCheckAgentProperty examines the agent’s property value and compares it to <l1>value</l>.
|
||
<899> Returns <1/> or <2/> based on the <l3>check_type</l>.
|
||
<900> <l1>CheckType</l>
|
||
<901> <l1>check_type</l>
|
||
<902> <l1>property</l>
|
||
<903> <l1>BBVariant</l>
|
||
<904> <l1>value</l>
|
||
<905> <l1>CheckType</l> <b>check_type</b> = <2/> <l3>🔗</l>
|
||
<906> <1/> <b>set_check_type</b>(value: <l2>CheckType</l>)
|
||
<907> <l1>CheckType</l> <b>get_check_type</b>()
|
||
<908> The type of check to be performed.
|
||
<909> <1/> <b>property</b> = <2/> <l3>🔗</l>
|
||
<910> <1/> <b>set_property</b>(value: <2/>)
|
||
<911> <1/> <b>get_property</b>()
|
||
<912> Parameter that specifies the agent’s property to be compared.
|
||
<913> <l1>BBVariant</l> <b>value</b> <l2>🔗</l>
|
||
<914> <1/> <b>set_value</b>(value: <l2>BBVariant</l>)
|
||
<915> <l1>BBVariant</l> <b>get_value</b>()
|
||
<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> <b>BTCheckTrigger</b> verifies whether the <l1>variable</l> is set to <2/>. If it is, the task switches it to <3/> and returns <4/>. Otherwise, it returns <5/>.
|
||
<920> <b>BTCheckTrigger</b> can function as a “gate” within a <l1>BTSequence</l>: when the trigger variable is set to <2/>, it permits the execution of subsequent tasks and then changes the variable to <3/>.
|
||
<921> <l1>variable</l>
|
||
<922> <1/> <b>variable</b> = <2/> <l3>🔗</l>
|
||
<923> A boolean variable on the blackboard used as a trigger. See also <l1>BTTask.blackboard</l>.
|
||
<924> If variable’s value is <1/>, <b>BTCheckTrigger</b> will switch it to <2/> and return <3/>.
|
||
<925> If variable’s value is <1/>, <b>BTCheckTrigger</b> will return <2/>.
|
||
<926> BTCheckVar
|
||
<927> BT condition that checks a variable on the blackboard.
|
||
<928> BTCheckVar evaluates the <l1>variable</l> against <l2>value</l> and returns <3/> or <4/> based on the <l5>check_type</l>.
|
||
<929> <l1>check_type</l>
|
||
<930> <l1>value</l>
|
||
<931> <l1>variable</l>
|
||
<932> <l1>CheckType</l> <b>check_type</b> = <2/> <l3>🔗</l>
|
||
<933> <l1>BBVariant</l> <b>value</b> <l2>🔗</l>
|
||
<934> A parameter that specifies the value against which the <l1>variable</l> will be compared.
|
||
<935> <1/> <b>variable</b> = <2/> <l3>🔗</l>
|
||
<936> The name of the variable to check its value.
|
||
<937> BTComment
|
||
<938> BTComment adds annotations or explanatory notes to a <l1>BehaviorTree</l>.
|
||
<939> BTComment is used to add annotations or explanatory notes to a <l1>BehaviorTree</l>.
|
||
<940> Comments are not executed as part of the tree and are removed from runtime instances of the <l1>BehaviorTree</l>.
|
||
<941> BTComposite
|
||
<942> <b>Inherited By:</b> <l1>BTDynamicSelector</l>, <l2>BTDynamicSequence</l>, <l3>BTParallel</l>, <l4>BTProbabilitySelector</l>, <l5>BTRandomSelector</l>, <l6>BTRandomSequence</l>, <l7>BTSelector</l>, <l8>BTSequence</l> |