Skip to content

Commit a5c318b

Browse files
committed
Update class docs
(cherry picked from commit 0e4c06f)
1 parent 5766922 commit a5c318b

File tree

4 files changed

+9
-7
lines changed

4 files changed

+9
-7
lines changed

doc_classes/BTPlayer.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
<member name="blackboard_plan" type="BlackboardPlan" setter="set_blackboard_plan" getter="get_blackboard_plan">
6161
Stores and manages variables that will be used in constructing new [Blackboard] instances.
6262
</member>
63-
<member name="monitor_performance" type="bool" setter="_set_monitor_performance" getter="_get_monitor_performance" default="false">
63+
<member name="monitor_performance" type="bool" setter="set_monitor_performance" getter="get_monitor_performance" default="false">
6464
If [code]true[/code], adds a performance monitor to "Debugger-&gt;Monitors" for each instance of this [BTPlayer] node.
6565
</member>
6666
<member name="update_mode" type="int" setter="set_update_mode" getter="get_update_mode" enum="BTPlayer.UpdateMode" default="1">

doc_classes/BTState.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
<member name="failure_event" type="StringName" setter="set_failure_event" getter="get_failure_event" default="&amp;&quot;failure&quot;">
3131
HSM event that will be dispatched when the behavior tree results in [code]FAILURE[/code]. See [method LimboState.dispatch].
3232
</member>
33-
<member name="monitor_performance" type="bool" setter="_set_monitor_performance" getter="_get_monitor_performance" default="false">
33+
<member name="monitor_performance" type="bool" setter="set_monitor_performance" getter="get_monitor_performance" default="false">
3434
If [code]true[/code], adds a performance monitor to "Debugger-&gt;Monitors" for each instance of this [BTState] node.
3535
</member>
3636
<member name="success_event" type="StringName" setter="set_success_event" getter="get_success_event" default="&amp;&quot;success&quot;">

doc_classes/BlackboardPlan.xml

+6-4
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@
1010
<methods>
1111
<method name="create_blackboard">
1212
<return type="Blackboard" />
13-
<param index="0" name="node" type="Node" />
13+
<param index="0" name="prefetch_root" type="Node" />
1414
<param index="1" name="parent_scope" type="Blackboard" default="null" />
15+
<param index="2" name="prefetch_root_for_base_plan" type="Node" default="null" />
1516
<description>
16-
Constructs a new instance of a [Blackboard] using this plan. If [NodePath] prefetching is enabled, [param node] will be used to retrieve node instances for [NodePath] variables and substitute their values.
17+
Constructs a new instance of a [Blackboard] using this plan. If [NodePath] prefetching is enabled, [param prefetch_root] will be used to retrieve node instances for [NodePath] variables and substitute their values.
1718
</description>
1819
</method>
1920
<method name="get_base_plan" qualifiers="const">
@@ -38,9 +39,10 @@
3839
<return type="void" />
3940
<param index="0" name="blackboard" type="Blackboard" />
4041
<param index="1" name="overwrite" type="bool" />
41-
<param index="2" name="node" type="Node" />
42+
<param index="2" name="prefetch_root" type="Node" />
43+
<param index="3" name="prefetch_root_for_base_plan" type="Node" default="null" />
4244
<description>
43-
Populates [param blackboard] with the variables from this plan. If [param overwrite] is [code]true[/code], existing variables with the same names will be overwritten. If [NodePath] prefetching is enabled, [param node] will be used to retrieve node instances for [NodePath] variables and substitute their values.
45+
Populates [param blackboard] with the variables from this plan. If [param overwrite] is [code]true[/code], existing variables with the same names will be overwritten. If [NodePath] prefetching is enabled, [param prefetch_root] will be used to retrieve node instances for [NodePath] variables and substitute their values.
4446
</description>
4547
</method>
4648
<method name="set_base_plan">

doc_classes/LimboState.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
<description>
4444
Registers a [param handler] to be called when [param event] is dispatched. The handler function should have the following signature:
4545
[codeblock]
46-
func my_event_handler(cargo=null) -> bool:
46+
func my_event_handler(cargo=null) -&gt; bool:
4747
[/codeblock]
4848
If the handler returns [code]true[/code], the event will be consumed. Cargo is an optional parameter that can be passed to the handler. See also [method dispatch].
4949
</description>

0 commit comments

Comments
 (0)