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

190 lines
9.3 KiB
ReStructuredText
Raw Normal View History

Doc: Add sphinx project for class documentation
2024-01-12 20:05:50 +00:00
:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/limboai/doc_classes/Blackboard.xml.
.. _class_Blackboard:
Blackboard
==========
**Inherits:**
A key/value storage for sharing among :ref:`LimboHSM<class_LimboHSM>` states and :ref:`BehaviorTree<class_BehaviorTree>` tasks.
.. rst-class:: classref-introduction-group
Description
-----------
Blackboard is where data is stored and shared between states in the :ref:`LimboHSM<class_LimboHSM>` system and tasks in a :ref:`BehaviorTree<class_BehaviorTree>`. Each state and task in the :ref:`BehaviorTree<class_BehaviorTree>` can access this Blackboard, allowing them to read and write data. This makes it easy to share information between different actions and behaviors.
Blackboard can also act as a parent scope for another Blackboard. If a specific variable is not found in the active scope, it looks in the parent Blackboard to find it. A parent Blackboard can itself have its own parent scope, forming what we call a "blackboard scope chain." Importantly, there is no limit to how many Blackboards can be in this chain, and the Blackboard doesn't modify values in the parent scopes.
New scopes can be created using the :ref:`BTNewScope<class_BTNewScope>` and :ref:`BTSubtree<class_BTSubtree>` decorators. Additionally, a new scope is automatically created for any :ref:`LimboState<class_LimboState>` that has defined non-empty Blackboard data or for any root-level :ref:`LimboHSM<class_LimboHSM>` node.
.. rst-class:: classref-reftable-group
Methods
-------
.. table::
:widths: auto
Doc: Update class rst
2024-02-14 19:34:18 +00:00
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`bind_var_to_property<class_Blackboard_method_bind_var_to_property>` **(** String p_name, Object p_object, StringName p_property **)** |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_var<class_Blackboard_method_erase_var>` **(** String p_name **)** |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Blackboard<class_Blackboard>` | :ref:`get_parent_scope<class_Blackboard_method_get_parent_scope>` **(** **)** |const| |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| Variant | :ref:`get_var<class_Blackboard_method_get_var>` **(** String p_name, Variant p_default=null, bool p_complain=true **)** |const| |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| bool | :ref:`has_var<class_Blackboard_method_has_var>` **(** String p_name **)** |const| |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`prefetch_nodepath_vars<class_Blackboard_method_prefetch_nodepath_vars>` **(** Node p_node **)** |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_parent_scope<class_Blackboard_method_set_parent_scope>` **(** :ref:`Blackboard<class_Blackboard>` p_blackboard **)** |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_var<class_Blackboard_method_set_var>` **(** String p_name, Variant p_value **)** |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Blackboard<class_Blackboard>` | :ref:`top<class_Blackboard_method_top>` **(** **)** |const| |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unbind_var<class_Blackboard_method_unbind_var>` **(** String p_name **)** |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
Doc: Add sphinx project for class documentation
2024-01-12 20:05:50 +00:00
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Method Descriptions
-------------------
Doc: Update class rst
2024-02-14 19:34:18 +00:00
.. _class_Blackboard_method_bind_var_to_property:
.. rst-class:: classref-method
void **bind_var_to_property** **(** String p_name, Object p_object, StringName p_property **)**
Establish a binding between a variable and the object's property specified by ``p_property`` and ``p_object``. Changes to the variable update the property, and vice versa.
.. rst-class:: classref-item-separator
----
Doc: Add sphinx project for class documentation
2024-01-12 20:05:50 +00:00
.. _class_Blackboard_method_erase_var:
.. rst-class:: classref-method
Update class documentation
2024-01-25 13:56:59 +00:00
void **erase_var** **(** String p_name **)**
Doc: Add sphinx project for class documentation
2024-01-12 20:05:50 +00:00
Removes a variable by its name.
.. rst-class:: classref-item-separator
----
.. _class_Blackboard_method_get_parent_scope:
.. rst-class:: classref-method
:ref:`Blackboard<class_Blackboard>` **get_parent_scope** **(** **)** |const|
Returns a Blackboard that serves as the parent scope for this instance.
.. rst-class:: classref-item-separator
----
.. _class_Blackboard_method_get_var:
.. rst-class:: classref-method
Doc: Update class rst
2024-02-14 19:34:18 +00:00
Variant **get_var** **(** String p_name, Variant p_default=null, bool p_complain=true **)** |const|
Doc: Add sphinx project for class documentation
2024-01-12 20:05:50 +00:00
Doc: Update class rst
2024-02-14 19:34:18 +00:00
Returns variable value or ``p_default`` if variable doesn't exist. If ``p_complain`` is ``true``, an error will be printed if variable doesn't exist.
Doc: Add sphinx project for class documentation
2024-01-12 20:05:50 +00:00
.. rst-class:: classref-item-separator
----
.. _class_Blackboard_method_has_var:
.. rst-class:: classref-method
Update class documentation
2024-01-25 13:56:59 +00:00
bool **has_var** **(** String p_name **)** |const|
Doc: Add sphinx project for class documentation
2024-01-12 20:05:50 +00:00
Doc: Update class rst
2024-02-14 19:34:18 +00:00
Returns ``true`` if the Blackboard contains the ``p_name`` variable, including the parent scopes.
Doc: Add sphinx project for class documentation
2024-01-12 20:05:50 +00:00
.. rst-class:: classref-item-separator
----
.. _class_Blackboard_method_prefetch_nodepath_vars:
.. rst-class:: classref-method
void **prefetch_nodepath_vars** **(** Node p_node **)**
If ``true``, any ``NodePath`` variables in the **Blackboard** are replaced with ``Node`` references when the tree is instantiated. References are retrieved by calling :ref:`Node.get_node<class_Node_method_get_node>` on the agent instance.
.. rst-class:: classref-item-separator
----
.. _class_Blackboard_method_set_parent_scope:
.. rst-class:: classref-method
void **set_parent_scope** **(** :ref:`Blackboard<class_Blackboard>` p_blackboard **)**
Assigns the parent scope. If a value isn't in the current Blackboard scope, it will look in the parent scope Blackboard to find it.
.. rst-class:: classref-item-separator
----
.. _class_Blackboard_method_set_var:
.. rst-class:: classref-method
Update class documentation
2024-01-25 13:56:59 +00:00
void **set_var** **(** String p_name, Variant p_value **)**
Doc: Add sphinx project for class documentation
2024-01-12 20:05:50 +00:00
Assigns a value to a Blackboard variable.
.. rst-class:: classref-item-separator
----
.. _class_Blackboard_method_top:
.. rst-class:: classref-method
:ref:`Blackboard<class_Blackboard>` **top** **(** **)** |const|
Returns the topmost **Blackboard** in the scope chain.
Doc: Update class rst
2024-02-14 19:34:18 +00:00
.. rst-class:: classref-item-separator
----
.. _class_Blackboard_method_unbind_var:
.. rst-class:: classref-method
void **unbind_var** **(** String p_name **)**
Remove binding from a variable.
Doc: Add sphinx project for class documentation
2024-01-12 20:05:50 +00:00
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`