Update class documentation
This commit is contained in:
parent
8155c2764a
commit
a251d92aa3
|
@ -60,6 +60,7 @@ def get_doc_classes():
|
||||||
"BehaviorTree",
|
"BehaviorTree",
|
||||||
"BehaviorTreeView",
|
"BehaviorTreeView",
|
||||||
"Blackboard",
|
"Blackboard",
|
||||||
|
"BlackboardPlan",
|
||||||
"BT",
|
"BT",
|
||||||
"BTAction",
|
"BTAction",
|
||||||
"BTAlwaysFail",
|
"BTAlwaysFail",
|
||||||
|
|
|
@ -0,0 +1,23 @@
|
||||||
|
: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/BBFloat32Array.xml.
|
||||||
|
|
||||||
|
.. _class_BBFloat32Array:
|
||||||
|
|
||||||
|
BBFloat32Array
|
||||||
|
==============
|
||||||
|
|
||||||
|
**Inherits:** :ref:`BBParam<class_BBParam>`
|
||||||
|
|
||||||
|
PackedFloat32Array-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :ref:`BBParam<class_BBParam>`.
|
||||||
|
|
||||||
|
.. |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.)`
|
|
@ -0,0 +1,23 @@
|
||||||
|
: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/BBFloat64Array.xml.
|
||||||
|
|
||||||
|
.. _class_BBFloat64Array:
|
||||||
|
|
||||||
|
BBFloat64Array
|
||||||
|
==============
|
||||||
|
|
||||||
|
**Inherits:** :ref:`BBParam<class_BBParam>`
|
||||||
|
|
||||||
|
PackedFloat64Array-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :ref:`BBParam<class_BBParam>`.
|
||||||
|
|
||||||
|
.. |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.)`
|
|
@ -0,0 +1,23 @@
|
||||||
|
: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/BBInt32Array.xml.
|
||||||
|
|
||||||
|
.. _class_BBInt32Array:
|
||||||
|
|
||||||
|
BBInt32Array
|
||||||
|
============
|
||||||
|
|
||||||
|
**Inherits:** :ref:`BBParam<class_BBParam>`
|
||||||
|
|
||||||
|
PackedInt32Array-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :ref:`BBParam<class_BBParam>`.
|
||||||
|
|
||||||
|
.. |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.)`
|
|
@ -0,0 +1,23 @@
|
||||||
|
: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/BBInt64Array.xml.
|
||||||
|
|
||||||
|
.. _class_BBInt64Array:
|
||||||
|
|
||||||
|
BBInt64Array
|
||||||
|
============
|
||||||
|
|
||||||
|
**Inherits:** :ref:`BBParam<class_BBParam>`
|
||||||
|
|
||||||
|
PackedInt64Array-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :ref:`BBParam<class_BBParam>`.
|
||||||
|
|
||||||
|
.. |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.)`
|
|
@ -12,7 +12,7 @@ BBParam
|
||||||
|
|
||||||
**Inherits:**
|
**Inherits:**
|
||||||
|
|
||||||
**Inherited By:** :ref:`BBAabb<class_BBAabb>`, :ref:`BBArray<class_BBArray>`, :ref:`BBBasis<class_BBBasis>`, :ref:`BBBool<class_BBBool>`, :ref:`BBByteArray<class_BBByteArray>`, :ref:`BBColor<class_BBColor>`, :ref:`BBColorArray<class_BBColorArray>`, :ref:`BBDictionary<class_BBDictionary>`, :ref:`BBFloat<class_BBFloat>`, :ref:`BBFloatArray<class_BBFloatArray>`, :ref:`BBInt<class_BBInt>`, :ref:`BBIntArray<class_BBIntArray>`, :ref:`BBNode<class_BBNode>`, :ref:`BBPlane<class_BBPlane>`, :ref:`BBQuaternion<class_BBQuaternion>`, :ref:`BBRect2<class_BBRect2>`, :ref:`BBRect2i<class_BBRect2i>`, :ref:`BBString<class_BBString>`, :ref:`BBStringArray<class_BBStringArray>`, :ref:`BBStringName<class_BBStringName>`, :ref:`BBTransform2D<class_BBTransform2D>`, :ref:`BBTransform3D<class_BBTransform3D>`, :ref:`BBVariant<class_BBVariant>`, :ref:`BBVector2<class_BBVector2>`, :ref:`BBVector2Array<class_BBVector2Array>`, :ref:`BBVector2i<class_BBVector2i>`, :ref:`BBVector3<class_BBVector3>`, :ref:`BBVector3Array<class_BBVector3Array>`, :ref:`BBVector3i<class_BBVector3i>`, :ref:`BBVector4<class_BBVector4>`, :ref:`BBVector4i<class_BBVector4i>`
|
**Inherited By:** :ref:`BBAabb<class_BBAabb>`, :ref:`BBArray<class_BBArray>`, :ref:`BBBasis<class_BBBasis>`, :ref:`BBBool<class_BBBool>`, :ref:`BBByteArray<class_BBByteArray>`, :ref:`BBColor<class_BBColor>`, :ref:`BBColorArray<class_BBColorArray>`, :ref:`BBDictionary<class_BBDictionary>`, :ref:`BBFloat<class_BBFloat>`, :ref:`BBFloat32Array<class_BBFloat32Array>`, :ref:`BBFloat64Array<class_BBFloat64Array>`, :ref:`BBInt<class_BBInt>`, :ref:`BBInt32Array<class_BBInt32Array>`, :ref:`BBInt64Array<class_BBInt64Array>`, :ref:`BBNode<class_BBNode>`, :ref:`BBPlane<class_BBPlane>`, :ref:`BBProjection<class_BBProjection>`, :ref:`BBQuaternion<class_BBQuaternion>`, :ref:`BBRect2<class_BBRect2>`, :ref:`BBRect2i<class_BBRect2i>`, :ref:`BBString<class_BBString>`, :ref:`BBStringArray<class_BBStringArray>`, :ref:`BBStringName<class_BBStringName>`, :ref:`BBTransform2D<class_BBTransform2D>`, :ref:`BBTransform3D<class_BBTransform3D>`, :ref:`BBVariant<class_BBVariant>`, :ref:`BBVector2<class_BBVector2>`, :ref:`BBVector2Array<class_BBVector2Array>`, :ref:`BBVector2i<class_BBVector2i>`, :ref:`BBVector3<class_BBVector3>`, :ref:`BBVector3Array<class_BBVector3Array>`, :ref:`BBVector3i<class_BBVector3i>`, :ref:`BBVector4<class_BBVector4>`, :ref:`BBVector4i<class_BBVector4i>`
|
||||||
|
|
||||||
A base class for LimboAI typed parameters.
|
A base class for LimboAI typed parameters.
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,23 @@
|
||||||
|
: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/BBProjection.xml.
|
||||||
|
|
||||||
|
.. _class_BBProjection:
|
||||||
|
|
||||||
|
BBProjection
|
||||||
|
============
|
||||||
|
|
||||||
|
**Inherits:** :ref:`BBParam<class_BBParam>`
|
||||||
|
|
||||||
|
Projection-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :ref:`BBParam<class_BBParam>`.
|
||||||
|
|
||||||
|
.. |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.)`
|
|
@ -41,9 +41,11 @@ Properties
|
||||||
.. table::
|
.. table::
|
||||||
:widths: auto
|
:widths: auto
|
||||||
|
|
||||||
+--------+-------------------------------------------------------------+--------+
|
+---------------------------------------------+---------------------------------------------------------------------+--------+
|
||||||
|
| :ref:`BlackboardPlan<class_BlackboardPlan>` | :ref:`blackboard_plan<class_BehaviorTree_property_blackboard_plan>` | |
|
||||||
|
+---------------------------------------------+---------------------------------------------------------------------+--------+
|
||||||
| String | :ref:`description<class_BehaviorTree_property_description>` | ``""`` |
|
| String | :ref:`description<class_BehaviorTree_property_description>` | ``""`` |
|
||||||
+--------+-------------------------------------------------------------+--------+
|
+---------------------------------------------+---------------------------------------------------------------------+--------+
|
||||||
|
|
||||||
.. rst-class:: classref-reftable-group
|
.. rst-class:: classref-reftable-group
|
||||||
|
|
||||||
|
@ -74,6 +76,23 @@ Methods
|
||||||
Property Descriptions
|
Property Descriptions
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
|
.. _class_BehaviorTree_property_blackboard_plan:
|
||||||
|
|
||||||
|
.. rst-class:: classref-property
|
||||||
|
|
||||||
|
:ref:`BlackboardPlan<class_BlackboardPlan>` **blackboard_plan**
|
||||||
|
|
||||||
|
.. rst-class:: classref-property-setget
|
||||||
|
|
||||||
|
- void **set_blackboard_plan** **(** :ref:`BlackboardPlan<class_BlackboardPlan>` value **)**
|
||||||
|
- :ref:`BlackboardPlan<class_BlackboardPlan>` **get_blackboard_plan** **(** **)**
|
||||||
|
|
||||||
|
Stores and manages variables that will be used in constructing new :ref:`Blackboard<class_Blackboard>` instances.
|
||||||
|
|
||||||
|
.. rst-class:: classref-item-separator
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
.. _class_BehaviorTree_property_description:
|
.. _class_BehaviorTree_property_description:
|
||||||
|
|
||||||
.. rst-class:: classref-property
|
.. rst-class:: classref-property
|
||||||
|
|
|
@ -34,23 +34,19 @@ Methods
|
||||||
:widths: auto
|
:widths: auto
|
||||||
|
|
||||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`erase_var<class_Blackboard_method_erase_var>` **(** Variant p_key **)** |
|
| void | :ref:`erase_var<class_Blackboard_method_erase_var>` **(** String p_name **)** |
|
||||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| Dictionary | :ref:`get_data<class_Blackboard_method_get_data>` **(** **)** |const| |
|
|
||||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Blackboard<class_Blackboard>` | :ref:`get_parent_scope<class_Blackboard_method_get_parent_scope>` **(** **)** |const| |
|
| :ref:`Blackboard<class_Blackboard>` | :ref:`get_parent_scope<class_Blackboard_method_get_parent_scope>` **(** **)** |const| |
|
||||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Variant | :ref:`get_var<class_Blackboard_method_get_var>` **(** Variant p_key, Variant p_default=null **)** |const| |
|
| Variant | :ref:`get_var<class_Blackboard_method_get_var>` **(** String p_name, Variant p_default=null **)** |const| |
|
||||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| bool | :ref:`has_var<class_Blackboard_method_has_var>` **(** Variant p_key **)** |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:`prefetch_nodepath_vars<class_Blackboard_method_prefetch_nodepath_vars>` **(** Node p_node **)** |
|
||||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_data<class_Blackboard_method_set_data>` **(** Dictionary p_data **)** |
|
|
||||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_parent_scope<class_Blackboard_method_set_parent_scope>` **(** :ref:`Blackboard<class_Blackboard>` p_blackboard **)** |
|
| 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>` **(** Variant p_key, Variant p_value **)** |
|
| 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| |
|
| :ref:`Blackboard<class_Blackboard>` | :ref:`top<class_Blackboard_method_top>` **(** **)** |const| |
|
||||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
@ -68,7 +64,7 @@ Method Descriptions
|
||||||
|
|
||||||
.. rst-class:: classref-method
|
.. rst-class:: classref-method
|
||||||
|
|
||||||
void **erase_var** **(** Variant p_key **)**
|
void **erase_var** **(** String p_name **)**
|
||||||
|
|
||||||
Removes a variable by its name.
|
Removes a variable by its name.
|
||||||
|
|
||||||
|
@ -76,18 +72,6 @@ Removes a variable by its name.
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
.. _class_Blackboard_method_get_data:
|
|
||||||
|
|
||||||
.. rst-class:: classref-method
|
|
||||||
|
|
||||||
Dictionary **get_data** **(** **)** |const|
|
|
||||||
|
|
||||||
Returns Blackboard data as a ``Dictionary``.
|
|
||||||
|
|
||||||
.. rst-class:: classref-item-separator
|
|
||||||
|
|
||||||
----
|
|
||||||
|
|
||||||
.. _class_Blackboard_method_get_parent_scope:
|
.. _class_Blackboard_method_get_parent_scope:
|
||||||
|
|
||||||
.. rst-class:: classref-method
|
.. rst-class:: classref-method
|
||||||
|
@ -104,7 +88,7 @@ Returns a Blackboard that serves as the parent scope for this instance.
|
||||||
|
|
||||||
.. rst-class:: classref-method
|
.. rst-class:: classref-method
|
||||||
|
|
||||||
Variant **get_var** **(** Variant p_key, Variant p_default=null **)** |const|
|
Variant **get_var** **(** String p_name, Variant p_default=null **)** |const|
|
||||||
|
|
||||||
Returns variable value.
|
Returns variable value.
|
||||||
|
|
||||||
|
@ -116,7 +100,7 @@ Returns variable value.
|
||||||
|
|
||||||
.. rst-class:: classref-method
|
.. rst-class:: classref-method
|
||||||
|
|
||||||
bool **has_var** **(** Variant p_key **)** |const|
|
bool **has_var** **(** String p_name **)** |const|
|
||||||
|
|
||||||
Returns ``true`` if the Blackboard contains the ``p_key`` variable, including the parent scopes.
|
Returns ``true`` if the Blackboard contains the ``p_key`` variable, including the parent scopes.
|
||||||
|
|
||||||
|
@ -136,18 +120,6 @@ If ``true``, any ``NodePath`` variables in the **Blackboard** are replaced with
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
.. _class_Blackboard_method_set_data:
|
|
||||||
|
|
||||||
.. rst-class:: classref-method
|
|
||||||
|
|
||||||
void **set_data** **(** Dictionary p_data **)**
|
|
||||||
|
|
||||||
Overwrites Blackboard data, replacing any previously stored variables within current scope. Use with caution.
|
|
||||||
|
|
||||||
.. rst-class:: classref-item-separator
|
|
||||||
|
|
||||||
----
|
|
||||||
|
|
||||||
.. _class_Blackboard_method_set_parent_scope:
|
.. _class_Blackboard_method_set_parent_scope:
|
||||||
|
|
||||||
.. rst-class:: classref-method
|
.. rst-class:: classref-method
|
||||||
|
@ -164,7 +136,7 @@ Assigns the parent scope. If a value isn't in the current Blackboard scope, it w
|
||||||
|
|
||||||
.. rst-class:: classref-method
|
.. rst-class:: classref-method
|
||||||
|
|
||||||
void **set_var** **(** Variant p_key, Variant p_value **)**
|
void **set_var** **(** String p_name, Variant p_value **)**
|
||||||
|
|
||||||
Assigns a value to a Blackboard variable.
|
Assigns a value to a Blackboard variable.
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,23 @@
|
||||||
|
: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/BlackboardPlan.xml.
|
||||||
|
|
||||||
|
.. _class_BlackboardPlan:
|
||||||
|
|
||||||
|
BlackboardPlan
|
||||||
|
==============
|
||||||
|
|
||||||
|
**Inherits:**
|
||||||
|
|
||||||
|
Stores and manages variables that will be used in constructing new :ref:`Blackboard<class_Blackboard>` instances.
|
||||||
|
|
||||||
|
.. |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.)`
|
|
@ -33,9 +33,9 @@ Properties
|
||||||
.. table::
|
.. table::
|
||||||
:widths: auto
|
:widths: auto
|
||||||
|
|
||||||
+------------+---------------------------------------------------------------------+--------+
|
+---------------------------------------------+-------------------------------------------------------------------+
|
||||||
| Dictionary | :ref:`_blackboard_data<class_BTNewScope_property__blackboard_data>` | ``{}`` |
|
| :ref:`BlackboardPlan<class_BlackboardPlan>` | :ref:`blackboard_plan<class_BTNewScope_property_blackboard_plan>` |
|
||||||
+------------+---------------------------------------------------------------------+--------+
|
+---------------------------------------------+-------------------------------------------------------------------+
|
||||||
|
|
||||||
.. rst-class:: classref-section-separator
|
.. rst-class:: classref-section-separator
|
||||||
|
|
||||||
|
@ -46,13 +46,18 @@ Properties
|
||||||
Property Descriptions
|
Property Descriptions
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
.. _class_BTNewScope_property__blackboard_data:
|
.. _class_BTNewScope_property_blackboard_plan:
|
||||||
|
|
||||||
.. rst-class:: classref-property
|
.. rst-class:: classref-property
|
||||||
|
|
||||||
Dictionary **_blackboard_data** = ``{}``
|
:ref:`BlackboardPlan<class_BlackboardPlan>` **blackboard_plan**
|
||||||
|
|
||||||
Data that is used to populate a new scope of the :ref:`Blackboard<class_Blackboard>`.
|
.. rst-class:: classref-property-setget
|
||||||
|
|
||||||
|
- void **set_blackboard_plan** **(** :ref:`BlackboardPlan<class_BlackboardPlan>` value **)**
|
||||||
|
- :ref:`BlackboardPlan<class_BlackboardPlan>` **get_blackboard_plan** **(** **)**
|
||||||
|
|
||||||
|
Stores and manages variables that will be used in constructing new :ref:`Blackboard<class_Blackboard>` instances.
|
||||||
|
|
||||||
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
.. |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.)`
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
||||||
|
|
|
@ -38,6 +38,8 @@ Properties
|
||||||
+---------------------------------------------+-------------------------------------------------------------------------------+-----------+
|
+---------------------------------------------+-------------------------------------------------------------------------------+-----------+
|
||||||
| :ref:`Blackboard<class_Blackboard>` | :ref:`blackboard<class_BTPlayer_property_blackboard>` | |
|
| :ref:`Blackboard<class_Blackboard>` | :ref:`blackboard<class_BTPlayer_property_blackboard>` | |
|
||||||
+---------------------------------------------+-------------------------------------------------------------------------------+-----------+
|
+---------------------------------------------+-------------------------------------------------------------------------------+-----------+
|
||||||
|
| :ref:`BlackboardPlan<class_BlackboardPlan>` | :ref:`blackboard_plan<class_BTPlayer_property_blackboard_plan>` | |
|
||||||
|
+---------------------------------------------+-------------------------------------------------------------------------------+-----------+
|
||||||
| bool | :ref:`monitor_performance<class_BTPlayer_property_monitor_performance>` | ``false`` |
|
| bool | :ref:`monitor_performance<class_BTPlayer_property_monitor_performance>` | ``false`` |
|
||||||
+---------------------------------------------+-------------------------------------------------------------------------------+-----------+
|
+---------------------------------------------+-------------------------------------------------------------------------------+-----------+
|
||||||
| bool | :ref:`prefetch_nodepath_vars<class_BTPlayer_property_prefetch_nodepath_vars>` | ``true`` |
|
| bool | :ref:`prefetch_nodepath_vars<class_BTPlayer_property_prefetch_nodepath_vars>` | ``true`` |
|
||||||
|
@ -193,6 +195,23 @@ Holds data shared by the behavior tree tasks. See :ref:`Blackboard<class_Blackbo
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
|
.. _class_BTPlayer_property_blackboard_plan:
|
||||||
|
|
||||||
|
.. rst-class:: classref-property
|
||||||
|
|
||||||
|
:ref:`BlackboardPlan<class_BlackboardPlan>` **blackboard_plan**
|
||||||
|
|
||||||
|
.. rst-class:: classref-property-setget
|
||||||
|
|
||||||
|
- void **set_blackboard_plan** **(** :ref:`BlackboardPlan<class_BlackboardPlan>` value **)**
|
||||||
|
- :ref:`BlackboardPlan<class_BlackboardPlan>` **get_blackboard_plan** **(** **)**
|
||||||
|
|
||||||
|
Stores and manages variables that will be used in constructing new :ref:`Blackboard<class_Blackboard>` instances.
|
||||||
|
|
||||||
|
.. rst-class:: classref-item-separator
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
.. _class_BTPlayer_property_monitor_performance:
|
.. _class_BTPlayer_property_monitor_performance:
|
||||||
|
|
||||||
.. rst-class:: classref-property
|
.. rst-class:: classref-property
|
||||||
|
|
|
@ -35,13 +35,15 @@ Properties
|
||||||
.. table::
|
.. table::
|
||||||
:widths: auto
|
:widths: auto
|
||||||
|
|
||||||
+-------------------------------------+-----------------------------------------------------------------+
|
+---------------------------------------------+-------------------------------------------------------------------+
|
||||||
| String | :ref:`EVENT_FINISHED<class_LimboState_property_EVENT_FINISHED>` |
|
| String | :ref:`EVENT_FINISHED<class_LimboState_property_EVENT_FINISHED>` |
|
||||||
+-------------------------------------+-----------------------------------------------------------------+
|
+---------------------------------------------+-------------------------------------------------------------------+
|
||||||
| Node | :ref:`agent<class_LimboState_property_agent>` |
|
| Node | :ref:`agent<class_LimboState_property_agent>` |
|
||||||
+-------------------------------------+-----------------------------------------------------------------+
|
+---------------------------------------------+-------------------------------------------------------------------+
|
||||||
| :ref:`Blackboard<class_Blackboard>` | :ref:`blackboard<class_LimboState_property_blackboard>` |
|
| :ref:`Blackboard<class_Blackboard>` | :ref:`blackboard<class_LimboState_property_blackboard>` |
|
||||||
+-------------------------------------+-----------------------------------------------------------------+
|
+---------------------------------------------+-------------------------------------------------------------------+
|
||||||
|
| :ref:`BlackboardPlan<class_BlackboardPlan>` | :ref:`blackboard_plan<class_LimboState_property_blackboard_plan>` |
|
||||||
|
+---------------------------------------------+-------------------------------------------------------------------+
|
||||||
|
|
||||||
.. rst-class:: classref-reftable-group
|
.. rst-class:: classref-reftable-group
|
||||||
|
|
||||||
|
@ -188,6 +190,23 @@ An agent associated with the state, assigned during initialization.
|
||||||
|
|
||||||
A key/value data store shared by states within the state machine to which this state belongs.
|
A key/value data store shared by states within the state machine to which this state belongs.
|
||||||
|
|
||||||
|
.. rst-class:: classref-item-separator
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
.. _class_LimboState_property_blackboard_plan:
|
||||||
|
|
||||||
|
.. rst-class:: classref-property
|
||||||
|
|
||||||
|
:ref:`BlackboardPlan<class_BlackboardPlan>` **blackboard_plan**
|
||||||
|
|
||||||
|
.. rst-class:: classref-property-setget
|
||||||
|
|
||||||
|
- void **set_blackboard_plan** **(** :ref:`BlackboardPlan<class_BlackboardPlan>` value **)**
|
||||||
|
- :ref:`BlackboardPlan<class_BlackboardPlan>` **get_blackboard_plan** **(** **)**
|
||||||
|
|
||||||
|
Stores and manages variables that will be used in constructing new :ref:`Blackboard<class_Blackboard>` instances.
|
||||||
|
|
||||||
.. rst-class:: classref-section-separator
|
.. rst-class:: classref-section-separator
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
|
@ -10,8 +10,8 @@
|
||||||
<tutorials>
|
<tutorials>
|
||||||
</tutorials>
|
</tutorials>
|
||||||
<members>
|
<members>
|
||||||
<member name="_blackboard_data" type="Dictionary" setter="_set_blackboard_data" getter="_get_blackboard_data" default="{}">
|
<member name="blackboard_plan" type="BlackboardPlan" setter="set_blackboard_plan" getter="get_blackboard_plan">
|
||||||
Data that is used to populate a new scope of the [Blackboard].
|
Stores and manages variables that will be used in constructing new [Blackboard] instances.
|
||||||
</member>
|
</member>
|
||||||
</members>
|
</members>
|
||||||
</class>
|
</class>
|
||||||
|
|
|
@ -40,6 +40,9 @@
|
||||||
<member name="blackboard" type="Blackboard" setter="set_blackboard" getter="get_blackboard">
|
<member name="blackboard" type="Blackboard" setter="set_blackboard" getter="get_blackboard">
|
||||||
Holds data shared by the behavior tree tasks. See [Blackboard].
|
Holds data shared by the behavior tree tasks. See [Blackboard].
|
||||||
</member>
|
</member>
|
||||||
|
<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->Monitors" for each instance of this [BTPlayer] node.
|
If [code]true[/code], adds a performance monitor to "Debugger->Monitors" for each instance of this [BTPlayer] node.
|
||||||
</member>
|
</member>
|
||||||
|
|
|
@ -51,6 +51,9 @@
|
||||||
</method>
|
</method>
|
||||||
</methods>
|
</methods>
|
||||||
<members>
|
<members>
|
||||||
|
<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="description" type="String" setter="set_description" getter="get_description" default="""">
|
<member name="description" type="String" setter="set_description" getter="get_description" default="""">
|
||||||
User-provided description of the BehaviorTree.
|
User-provided description of the BehaviorTree.
|
||||||
</member>
|
</member>
|
||||||
|
|
|
@ -13,17 +13,11 @@
|
||||||
<methods>
|
<methods>
|
||||||
<method name="erase_var">
|
<method name="erase_var">
|
||||||
<return type="void" />
|
<return type="void" />
|
||||||
<param index="0" name="p_key" type="Variant" />
|
<param index="0" name="p_name" type="String" />
|
||||||
<description>
|
<description>
|
||||||
Removes a variable by its name.
|
Removes a variable by its name.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_data" qualifiers="const">
|
|
||||||
<return type="Dictionary" />
|
|
||||||
<description>
|
|
||||||
Returns Blackboard data as a [Dictionary].
|
|
||||||
</description>
|
|
||||||
</method>
|
|
||||||
<method name="get_parent_scope" qualifiers="const">
|
<method name="get_parent_scope" qualifiers="const">
|
||||||
<return type="Blackboard" />
|
<return type="Blackboard" />
|
||||||
<description>
|
<description>
|
||||||
|
@ -32,7 +26,7 @@
|
||||||
</method>
|
</method>
|
||||||
<method name="get_var" qualifiers="const">
|
<method name="get_var" qualifiers="const">
|
||||||
<return type="Variant" />
|
<return type="Variant" />
|
||||||
<param index="0" name="p_key" type="Variant" />
|
<param index="0" name="p_name" type="String" />
|
||||||
<param index="1" name="p_default" type="Variant" default="null" />
|
<param index="1" name="p_default" type="Variant" default="null" />
|
||||||
<description>
|
<description>
|
||||||
Returns variable value.
|
Returns variable value.
|
||||||
|
@ -40,7 +34,7 @@
|
||||||
</method>
|
</method>
|
||||||
<method name="has_var" qualifiers="const">
|
<method name="has_var" qualifiers="const">
|
||||||
<return type="bool" />
|
<return type="bool" />
|
||||||
<param index="0" name="p_key" type="Variant" />
|
<param index="0" name="p_name" type="String" />
|
||||||
<description>
|
<description>
|
||||||
Returns [code]true[/code] if the Blackboard contains the [param p_key] variable, including the parent scopes.
|
Returns [code]true[/code] if the Blackboard contains the [param p_key] variable, including the parent scopes.
|
||||||
</description>
|
</description>
|
||||||
|
@ -52,13 +46,6 @@
|
||||||
If [code]true[/code], any [NodePath] variables in the [Blackboard] are replaced with [Node] references when the tree is instantiated. References are retrieved by calling [method Node.get_node] on the agent instance.
|
If [code]true[/code], any [NodePath] variables in the [Blackboard] are replaced with [Node] references when the tree is instantiated. References are retrieved by calling [method Node.get_node] on the agent instance.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="set_data">
|
|
||||||
<return type="void" />
|
|
||||||
<param index="0" name="p_data" type="Dictionary" />
|
|
||||||
<description>
|
|
||||||
Overwrites Blackboard data, replacing any previously stored variables within current scope. Use with caution.
|
|
||||||
</description>
|
|
||||||
</method>
|
|
||||||
<method name="set_parent_scope">
|
<method name="set_parent_scope">
|
||||||
<return type="void" />
|
<return type="void" />
|
||||||
<param index="0" name="p_blackboard" type="Blackboard" />
|
<param index="0" name="p_blackboard" type="Blackboard" />
|
||||||
|
@ -68,7 +55,7 @@
|
||||||
</method>
|
</method>
|
||||||
<method name="set_var">
|
<method name="set_var">
|
||||||
<return type="void" />
|
<return type="void" />
|
||||||
<param index="0" name="p_key" type="Variant" />
|
<param index="0" name="p_name" type="String" />
|
||||||
<param index="1" name="p_value" type="Variant" />
|
<param index="1" name="p_value" type="Variant" />
|
||||||
<description>
|
<description>
|
||||||
Assigns a value to a Blackboard variable.
|
Assigns a value to a Blackboard variable.
|
||||||
|
|
|
@ -0,0 +1,10 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||||||
|
<class name="BlackboardPlan" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
||||||
|
<brief_description>
|
||||||
|
Stores and manages variables that will be used in constructing new [Blackboard] instances.
|
||||||
|
</brief_description>
|
||||||
|
<description>
|
||||||
|
</description>
|
||||||
|
<tutorials>
|
||||||
|
</tutorials>
|
||||||
|
</class>
|
|
@ -117,6 +117,9 @@
|
||||||
<member name="blackboard" type="Blackboard" setter="" getter="get_blackboard">
|
<member name="blackboard" type="Blackboard" setter="" getter="get_blackboard">
|
||||||
A key/value data store shared by states within the state machine to which this state belongs.
|
A key/value data store shared by states within the state machine to which this state belongs.
|
||||||
</member>
|
</member>
|
||||||
|
<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>
|
||||||
</members>
|
</members>
|
||||||
<signals>
|
<signals>
|
||||||
<signal name="entered">
|
<signal name="entered">
|
||||||
|
|
|
@ -195,7 +195,7 @@ void LimboState::_bind_methods() {
|
||||||
ADD_PROPERTY(PropertyInfo(Variant::STRING, "EVENT_FINISHED", PROPERTY_HINT_NONE, "", 0), "", "event_finished");
|
ADD_PROPERTY(PropertyInfo(Variant::STRING, "EVENT_FINISHED", PROPERTY_HINT_NONE, "", 0), "", "event_finished");
|
||||||
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "agent", PROPERTY_HINT_RESOURCE_TYPE, "Node", 0), "set_agent", "get_agent");
|
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "agent", PROPERTY_HINT_RESOURCE_TYPE, "Node", 0), "set_agent", "get_agent");
|
||||||
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "blackboard", PROPERTY_HINT_RESOURCE_TYPE, "Blackboard", 0), "", "get_blackboard");
|
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "blackboard", PROPERTY_HINT_RESOURCE_TYPE, "Blackboard", 0), "", "get_blackboard");
|
||||||
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "blackboard_plan", PROPERTY_HINT_RESOURCE_TYPE, "BlackboardPlan", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_INTERNAL), "set_blackboard_plan", "get_blackboard_plan");
|
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "blackboard_plan", PROPERTY_HINT_RESOURCE_TYPE, "BlackboardPlan", PROPERTY_USAGE_DEFAULT), "set_blackboard_plan", "get_blackboard_plan");
|
||||||
|
|
||||||
ADD_SIGNAL(MethodInfo("setup"));
|
ADD_SIGNAL(MethodInfo("setup"));
|
||||||
ADD_SIGNAL(MethodInfo("entered"));
|
ADD_SIGNAL(MethodInfo("entered"));
|
||||||
|
|
Loading…
Reference in New Issue