botaccount
/
limboai
mirror of https://github.com/limbonaut/limboai.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update class docs 

(cherry picked from commit 0e4c06f3b8)
This commit is contained in:
Serhii Snitsaruk 2024-09-15 14:35:48 +02:00
parent 576692294b
commit a5c318bbf2
No known key found for this signature in database
GPG Key ID: A965EF8799FFEC2D
4 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc_classes/BTPlayer.xml
View File

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

2
doc_classes/BTState.xml
View File

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

10
doc_classes/BlackboardPlan.xml
View File

@ -10,10 +10,11 @@
<methods>
<method name="create_blackboard">
<return type="Blackboard" />
<param index="0" name="node" type="Node" />
<param index="0" name="prefetch_root" type="Node" />
<param index="1" name="parent_scope" type="Blackboard" default="null" />
<param index="2" name="prefetch_root_for_base_plan" type="Node" default="null" />
<description>
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.
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.
</description>
</method>
<method name="get_base_plan" qualifiers="const">
@ -38,9 +39,10 @@
<return type="void" />
<param index="0" name="blackboard" type="Blackboard" />
<param index="1" name="overwrite" type="bool" />
<param index="2" name="node" type="Node" />
<param index="2" name="prefetch_root" type="Node" />
<param index="3" name="prefetch_root_for_base_plan" type="Node" default="null" />
<description>
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.
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.
</description>
</method>
<method name="set_base_plan">

2
doc_classes/LimboState.xml
View File

@ -43,7 +43,7 @@
<description>
Registers a [param handler] to be called when [param event] is dispatched. The handler function should have the following signature:
[codeblock]
func my_event_handler(cargo=null) -> bool:
func my_event_handler(cargo=null) -&gt; bool:
[/codeblock]
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].
</description>