From 7b5b7c00c2a5045b6ea9fe84c61cf56729537ff7 Mon Sep 17 00:00:00 2001 From: Laurent Senta Date: Fri, 10 Jan 2025 09:22:19 +0100 Subject: [PATCH] doc: clarify scoping for BTState --- doc/source/behavior-trees/using-blackboard.rst | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/doc/source/behavior-trees/using-blackboard.rst b/doc/source/behavior-trees/using-blackboard.rst index a37a228..61acd36 100644 --- a/doc/source/behavior-trees/using-blackboard.rst +++ b/doc/source/behavior-trees/using-blackboard.rst @@ -122,10 +122,15 @@ This creates a "blackboard scope chain," where each :ref:`Blackboard` doesn't modify values in the parent scopes. -Some scopes are created automatically. For instance, when using the :ref:`BTNewScope` -and :ref:`BTSubtree` decorators, or when a :ref:`LimboState` -has non-empty blackboard plan defined, or when a root-level :ref:`LimboHSM` -node is used. Such scopes prevent naming collisions between contextually separate environments. +Scopes are created automatically to prevent naming collisions between contextually separate environments: + +- Within :ref:`BTNewScope`. +- Under :ref:`BTSubtree` decorators. +- With :ref:`LimboState` that have a non-empty blackboard plan defined. +- Under :ref:LimboHSM nodes: A new scope is created at the root level, + and each :ref:BTState child also receives its own separate scope. + +Such scopes Sharing data between several agents ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~