From a5c318bbf28ebab6d61973dd2bf7d3d3c24c204d Mon Sep 17 00:00:00 2001 From: Serhii Snitsaruk Date: Sun, 15 Sep 2024 14:35:48 +0200 Subject: [PATCH] Update class docs (cherry picked from commit 0e4c06f3b81dbba3d5041b1fe1152f548a9ddece) --- doc_classes/BTPlayer.xml | 2 +- doc_classes/BTState.xml | 2 +- doc_classes/BlackboardPlan.xml | 10 ++++++---- doc_classes/LimboState.xml | 2 +- 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/doc_classes/BTPlayer.xml b/doc_classes/BTPlayer.xml index 7ce6ffd..4181c55 100644 --- a/doc_classes/BTPlayer.xml +++ b/doc_classes/BTPlayer.xml @@ -60,7 +60,7 @@ Stores and manages variables that will be used in constructing new [Blackboard] instances. - + If [code]true[/code], adds a performance monitor to "Debugger->Monitors" for each instance of this [BTPlayer] node. diff --git a/doc_classes/BTState.xml b/doc_classes/BTState.xml index d9d644d..ad80af1 100644 --- a/doc_classes/BTState.xml +++ b/doc_classes/BTState.xml @@ -30,7 +30,7 @@ HSM event that will be dispatched when the behavior tree results in [code]FAILURE[/code]. See [method LimboState.dispatch]. - + If [code]true[/code], adds a performance monitor to "Debugger->Monitors" for each instance of this [BTState] node. diff --git a/doc_classes/BlackboardPlan.xml b/doc_classes/BlackboardPlan.xml index 80de4d5..7bb5028 100644 --- a/doc_classes/BlackboardPlan.xml +++ b/doc_classes/BlackboardPlan.xml @@ -10,10 +10,11 @@ - + + - 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. @@ -38,9 +39,10 @@ - + + - 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. diff --git a/doc_classes/LimboState.xml b/doc_classes/LimboState.xml index dee6f47..34550c6 100644 --- a/doc_classes/LimboState.xml +++ b/doc_classes/LimboState.xml @@ -43,7 +43,7 @@ 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) -> 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].