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

Update docs

This commit is contained in:
Serhii Snitsaruk 2024-07-20 17:25:24 +02:00
parent 7c57c7dd62
commit ddbfa132a5
No known key found for this signature in database
GPG Key ID: A965EF8799FFEC2D
91 changed files with 1021 additions and 905 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/classes/class_bbaabb.rst
View File

@ -2,8 +2,8 @@
.. 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/BBAabb.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBAabb.xml.
.. _class_BBAabb:
@ -21,3 +21,4 @@ AABB-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :ref:
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbarray.rst
View File

@ -2,8 +2,8 @@
.. 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/BBArray.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBArray.xml.
.. _class_BBArray:
@ -21,3 +21,4 @@ Array-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :ref
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbbasis.rst
View File

@ -2,8 +2,8 @@
.. 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/BBBasis.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBBasis.xml.
.. _class_BBBasis:
@ -21,3 +21,4 @@ Basis-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :ref
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbbool.rst
View File

@ -2,8 +2,8 @@
.. 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/BBBool.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBBool.xml.
.. _class_BBBool:
@ -21,3 +21,4 @@ Bool-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :ref:
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbbytearray.rst
View File

@ -2,8 +2,8 @@
.. 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/BBByteArray.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBByteArray.xml.
.. _class_BBByteArray:
@ -21,3 +21,4 @@ ByteArray-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbcolor.rst
View File

@ -2,8 +2,8 @@
.. 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/BBColor.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBColor.xml.
.. _class_BBColor:
@ -21,3 +21,4 @@ Color-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :ref
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbcolorarray.rst
View File

@ -2,8 +2,8 @@
.. 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/BBColorArray.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBColorArray.xml.
.. _class_BBColorArray:
@ -21,3 +21,4 @@ ColorArray-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbdictionary.rst
View File

@ -2,8 +2,8 @@
.. 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/BBDictionary.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBDictionary.xml.
.. _class_BBDictionary:
@ -21,3 +21,4 @@ Dictionary-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbfloat.rst
View File

@ -2,8 +2,8 @@
.. 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/BBFloat.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBFloat.xml.
.. _class_BBFloat:
@ -21,3 +21,4 @@ Float-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :ref
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbfloat32array.rst
View File

@ -2,8 +2,8 @@
.. 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.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBFloat32Array.xml.
.. _class_BBFloat32Array:
@ -21,3 +21,4 @@ PackedFloat32Array-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` ta
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbfloat64array.rst
View File

@ -2,8 +2,8 @@
.. 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.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBFloat64Array.xml.
.. _class_BBFloat64Array:
@ -21,3 +21,4 @@ PackedFloat64Array-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` ta
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbint.rst
View File

@ -2,8 +2,8 @@
.. 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/BBInt.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBInt.xml.
.. _class_BBInt:
@ -21,3 +21,4 @@ Integer-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :r
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbint32array.rst
View File

@ -2,8 +2,8 @@
.. 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.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBInt32Array.xml.
.. _class_BBInt32Array:
@ -21,3 +21,4 @@ PackedInt32Array-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` task
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbint64array.rst
View File

@ -2,8 +2,8 @@
.. 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.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBInt64Array.xml.
.. _class_BBInt64Array:
@ -21,3 +21,4 @@ PackedInt64Array-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` task
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbnode.rst
View File

@ -2,8 +2,8 @@
.. 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/BBNode.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBNode.xml.
.. _class_BBNode:
@ -30,3 +30,4 @@ If the source is a blackboard variable, it allows any type extended from ``Objec
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

43
doc/source/classes/class_bbparam.rst
View File

@ -2,8 +2,8 @@
.. 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/BBParam.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBParam.xml.
.. _class_BBParam:
@ -34,11 +34,11 @@ Properties
:widths: auto
+----------------------------------------------+----------------------------------------------------------+----------+
| Variant | :ref:`saved_value<class_BBParam_property_saved_value>` | ``null`` |
| ``Variant`` | :ref:`saved_value<class_BBParam_property_saved_value>` | ``null`` |
+----------------------------------------------+----------------------------------------------------------+----------+
| :ref:`ValueSource<enum_BBParam_ValueSource>` | :ref:`value_source<class_BBParam_property_value_source>` | ``0`` |
+----------------------------------------------+----------------------------------------------------------+----------+
| StringName | :ref:`variable<class_BBParam_property_variable>` | |
| ``StringName`` | :ref:`variable<class_BBParam_property_variable>` | |
+----------------------------------------------+----------------------------------------------------------+----------+
.. rst-class:: classref-reftable-group
@ -49,11 +49,11 @@ Methods
.. table::
:widths: auto
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`get_type<class_BBParam_method_get_type>` **(** **)** |const| |
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Variant | :ref:`get_value<class_BBParam_method_get_value>` **(** Node scene_root, :ref:`Blackboard<class_Blackboard>` blackboard, Variant default=null **)** |
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`get_type<class_BBParam_method_get_type>`\ (\ ) |const| |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``Variant`` | :ref:`get_value<class_BBParam_method_get_value>`\ (\ scene_root\: ``Node``, blackboard\: :ref:`Blackboard<class_Blackboard>`, default\: ``Variant`` = null\ ) |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@ -68,7 +68,7 @@ Enumerations
.. rst-class:: classref-enumeration
enum **ValueSource**:
enum **ValueSource**: :ref:`🔗<enum_BBParam_ValueSource>`
.. _class_BBParam_constant_SAVED_VALUE:
@ -99,12 +99,12 @@ Property Descriptions
.. rst-class:: classref-property
Variant **saved_value** = ``null``
``Variant`` **saved_value** = ``null`` :ref:`🔗<class_BBParam_property_saved_value>`
.. rst-class:: classref-property-setget
- void **set_saved_value** **(** Variant value **)**
- Variant **get_saved_value** **(** **)**
- |void| **set_saved_value**\ (\ value\: ``Variant``\ )
- ``Variant`` **get_saved_value**\ (\ )
Stores the parameter value when :ref:`value_source<class_BBParam_property_value_source>` is set to :ref:`SAVED_VALUE<class_BBParam_constant_SAVED_VALUE>`. The data type of the value is determined by :ref:`get_type<class_BBParam_method_get_type>`.
@ -116,12 +116,12 @@ Stores the parameter value when :ref:`value_source<class_BBParam_property_value_
.. rst-class:: classref-property
:ref:`ValueSource<enum_BBParam_ValueSource>` **value_source** = ``0``
:ref:`ValueSource<enum_BBParam_ValueSource>` **value_source** = ``0`` :ref:`🔗<class_BBParam_property_value_source>`
.. rst-class:: classref-property-setget
- void **set_value_source** **(** :ref:`ValueSource<enum_BBParam_ValueSource>` value **)**
- :ref:`ValueSource<enum_BBParam_ValueSource>` **get_value_source** **(** **)**
- |void| **set_value_source**\ (\ value\: :ref:`ValueSource<enum_BBParam_ValueSource>`\ )
- :ref:`ValueSource<enum_BBParam_ValueSource>` **get_value_source**\ (\ )
Specifies the source of the value for BBParam. See :ref:`ValueSource<enum_BBParam_ValueSource>`.
@ -133,12 +133,12 @@ Specifies the source of the value for BBParam. See :ref:`ValueSource<enum_BBPara
.. rst-class:: classref-property
StringName **variable**
``StringName`` **variable** :ref:`🔗<class_BBParam_property_variable>`
.. rst-class:: classref-property-setget
- void **set_variable** **(** StringName value **)**
- StringName **get_variable** **(** **)**
- |void| **set_variable**\ (\ value\: ``StringName``\ )
- ``StringName`` **get_variable**\ (\ )
Stores the name of a :ref:`Blackboard<class_Blackboard>` variable when :ref:`value_source<class_BBParam_property_value_source>` is set to :ref:`BLACKBOARD_VAR<class_BBParam_constant_BLACKBOARD_VAR>`.
@ -155,7 +155,7 @@ Method Descriptions
.. rst-class:: classref-method
:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **get_type** **(** **)** |const|
:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **get_type**\ (\ ) |const| :ref:`🔗<class_BBParam_method_get_type>`
Returns the expected data type of the parameter.
@ -167,7 +167,7 @@ Returns the expected data type of the parameter.
.. rst-class:: classref-method
Variant **get_value** **(** Node scene_root, :ref:`Blackboard<class_Blackboard>` blackboard, Variant default=null **)**
``Variant`` **get_value**\ (\ scene_root\: ``Node``, blackboard\: :ref:`Blackboard<class_Blackboard>`, default\: ``Variant`` = null\ ) :ref:`🔗<class_BBParam_method_get_value>`
Returns the value of the parameter.
@ -178,3 +178,4 @@ Returns the value of the parameter.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbplane.rst
View File

@ -2,8 +2,8 @@
.. 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/BBPlane.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBPlane.xml.
.. _class_BBPlane:
@ -21,3 +21,4 @@ Plane-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :ref
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbprojection.rst
View File

@ -2,8 +2,8 @@
.. 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.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBProjection.xml.
.. _class_BBProjection:
@ -21,3 +21,4 @@ Projection-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbquaternion.rst
View File

@ -2,8 +2,8 @@
.. 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/BBQuaternion.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBQuaternion.xml.
.. _class_BBQuaternion:
@ -21,3 +21,4 @@ Quaternion-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbrect2.rst
View File

@ -2,8 +2,8 @@
.. 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/BBRect2.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBRect2.xml.
.. _class_BBRect2:
@ -21,3 +21,4 @@ Rect2-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :ref
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbrect2i.rst
View File

@ -2,8 +2,8 @@
.. 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/BBRect2i.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBRect2i.xml.
.. _class_BBRect2i:
@ -21,3 +21,4 @@ Rect2i-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :re
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbstring.rst
View File

@ -2,8 +2,8 @@
.. 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/BBString.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBString.xml.
.. _class_BBString:
@ -21,3 +21,4 @@ String-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :re
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbstringarray.rst
View File

@ -2,8 +2,8 @@
.. 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/BBStringArray.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBStringArray.xml.
.. _class_BBStringArray:
@ -21,3 +21,4 @@ StringArray-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. Se
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbstringname.rst
View File

@ -2,8 +2,8 @@
.. 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/BBStringName.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBStringName.xml.
.. _class_BBStringName:
@ -21,3 +21,4 @@ StringName-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbtransform2d.rst
View File

@ -2,8 +2,8 @@
.. 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/BBTransform2D.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBTransform2D.xml.
.. _class_BBTransform2D:
@ -21,3 +21,4 @@ Transform2D-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. Se
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbtransform3d.rst
View File

@ -2,8 +2,8 @@
.. 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/BBTransform3D.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBTransform3D.xml.
.. _class_BBTransform3D:
@ -21,3 +21,4 @@ Transform3D-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. Se
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

11
doc/source/classes/class_bbvariant.rst
View File

@ -2,8 +2,8 @@
.. 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/BBVariant.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBVariant.xml.
.. _class_BBVariant:
@ -48,12 +48,12 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **type** = ``0``
:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **type** = ``0`` :ref:`🔗<class_BBVariant_property_type>`
.. rst-class:: classref-property-setget
- void **set_type** **(** :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` value **)**
- :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **get_type** **(** **)**
- |void| **set_type**\ (\ value\: :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>`\ )
- :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **get_type**\ (\ )
Specified :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` for the parameter value.
@ -64,3 +64,4 @@ Specified :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` for the parameter
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbvector2.rst
View File

@ -2,8 +2,8 @@
.. 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/BBVector2.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBVector2.xml.
.. _class_BBVector2:
@ -21,3 +21,4 @@ Vector2-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :r
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbvector2array.rst
View File

@ -2,8 +2,8 @@
.. 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/BBVector2Array.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBVector2Array.xml.
.. _class_BBVector2Array:
@ -21,3 +21,4 @@ Vector2Array-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. S
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbvector2i.rst
View File

@ -2,8 +2,8 @@
.. 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/BBVector2i.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBVector2i.xml.
.. _class_BBVector2i:
@ -21,3 +21,4 @@ Vector2i-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbvector3.rst
View File

@ -2,8 +2,8 @@
.. 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/BBVector3.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBVector3.xml.
.. _class_BBVector3:
@ -21,3 +21,4 @@ Vector3-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :r
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbvector3array.rst
View File

@ -2,8 +2,8 @@
.. 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/BBVector3Array.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBVector3Array.xml.
.. _class_BBVector3Array:
@ -21,3 +21,4 @@ Vector3Array-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. S
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbvector3i.rst
View File

@ -2,8 +2,8 @@
.. 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/BBVector3i.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBVector3i.xml.
.. _class_BBVector3i:
@ -21,3 +21,4 @@ Vector3i-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbvector4.rst
View File

@ -2,8 +2,8 @@
.. 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/BBVector4.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBVector4.xml.
.. _class_BBVector4:
@ -21,3 +21,4 @@ Vector4-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :r
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_bbvector4i.rst
View File

@ -2,8 +2,8 @@
.. 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/BBVector4i.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBVector4i.xml.
.. _class_BBVector4i:
@ -21,3 +21,4 @@ Vector4i-type parameter for :ref:`BehaviorTree<class_BehaviorTree>` tasks. See :
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

53
doc/source/classes/class_behaviortree.rst
View File

@ -2,8 +2,8 @@
.. 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/BehaviorTree.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BehaviorTree.xml.
.. _class_BehaviorTree:
@ -44,7 +44,7 @@ Properties
+---------------------------------------------+---------------------------------------------------------------------+--------+
| :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
@ -55,17 +55,17 @@ Methods
.. table::
:widths: auto
+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BehaviorTree<class_BehaviorTree>` | :ref:`clone<class_BehaviorTree_method_clone>` **(** **)** |const| |
+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`copy_other<class_BehaviorTree_method_copy_other>` **(** :ref:`BehaviorTree<class_BehaviorTree>` other **)** |
+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BTTask<class_BTTask>` | :ref:`get_root_task<class_BehaviorTree_method_get_root_task>` **(** **)** |const| |
+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BTTask<class_BTTask>` | :ref:`instantiate<class_BehaviorTree_method_instantiate>` **(** Node agent, :ref:`Blackboard<class_Blackboard>` blackboard, Node scene_root **)** |const| |
+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_root_task<class_BehaviorTree_method_set_root_task>` **(** :ref:`BTTask<class_BTTask>` task **)** |
+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BehaviorTree<class_BehaviorTree>` | :ref:`clone<class_BehaviorTree_method_clone>`\ (\ ) |const| |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`copy_other<class_BehaviorTree_method_copy_other>`\ (\ other\: :ref:`BehaviorTree<class_BehaviorTree>`\ ) |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BTTask<class_BTTask>` | :ref:`get_root_task<class_BehaviorTree_method_get_root_task>`\ (\ ) |const| |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BTTask<class_BTTask>` | :ref:`instantiate<class_BehaviorTree_method_instantiate>`\ (\ agent\: ``Node``, blackboard\: :ref:`Blackboard<class_Blackboard>`, scene_root\: ``Node``\ ) |const| |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_root_task<class_BehaviorTree_method_set_root_task>`\ (\ task\: :ref:`BTTask<class_BTTask>`\ ) |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@ -80,7 +80,7 @@ Signals
.. rst-class:: classref-signal
**plan_changed** **(** **)**
**plan_changed**\ (\ ) :ref:`🔗<class_BehaviorTree_signal_plan_changed>`
Emitted when the :ref:`BlackboardPlan<class_BlackboardPlan>` changes.
@ -97,12 +97,12 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`BlackboardPlan<class_BlackboardPlan>` **blackboard_plan**
:ref:`BlackboardPlan<class_BlackboardPlan>` **blackboard_plan** :ref:`🔗<class_BehaviorTree_property_blackboard_plan>`
.. rst-class:: classref-property-setget
- void **set_blackboard_plan** **(** :ref:`BlackboardPlan<class_BlackboardPlan>` value **)**
- :ref:`BlackboardPlan<class_BlackboardPlan>` **get_blackboard_plan** **(** **)**
- |void| **set_blackboard_plan**\ (\ value\: :ref:`BlackboardPlan<class_BlackboardPlan>`\ )
- :ref:`BlackboardPlan<class_BlackboardPlan>` **get_blackboard_plan**\ (\ )
Stores and manages variables that will be used in constructing new :ref:`Blackboard<class_Blackboard>` instances.
@ -114,12 +114,12 @@ Stores and manages variables that will be used in constructing new :ref:`Blackbo
.. rst-class:: classref-property
String **description** = ``""``
``String`` **description** = ``""`` :ref:`🔗<class_BehaviorTree_property_description>`
.. rst-class:: classref-property-setget
- void **set_description** **(** String value **)**
- String **get_description** **(** **)**
- |void| **set_description**\ (\ value\: ``String``\ )
- ``String`` **get_description**\ (\ )
User-provided description of the BehaviorTree.
@ -136,7 +136,7 @@ Method Descriptions
.. rst-class:: classref-method
:ref:`BehaviorTree<class_BehaviorTree>` **clone** **(** **)** |const|
:ref:`BehaviorTree<class_BehaviorTree>` **clone**\ (\ ) |const| :ref:`🔗<class_BehaviorTree_method_clone>`
Makes a copy of the BehaviorTree resource.
@ -148,7 +148,7 @@ Makes a copy of the BehaviorTree resource.
.. rst-class:: classref-method
void **copy_other** **(** :ref:`BehaviorTree<class_BehaviorTree>` other **)**
|void| **copy_other**\ (\ other\: :ref:`BehaviorTree<class_BehaviorTree>`\ ) :ref:`🔗<class_BehaviorTree_method_copy_other>`
Become a copy of another behavior tree.
@ -160,7 +160,7 @@ Become a copy of another behavior tree.
.. rst-class:: classref-method
:ref:`BTTask<class_BTTask>` **get_root_task** **(** **)** |const|
:ref:`BTTask<class_BTTask>` **get_root_task**\ (\ ) |const| :ref:`🔗<class_BehaviorTree_method_get_root_task>`
Returns the root task of the BehaviorTree resource.
@ -172,7 +172,7 @@ Returns the root task of the BehaviorTree resource.
.. rst-class:: classref-method
:ref:`BTTask<class_BTTask>` **instantiate** **(** Node agent, :ref:`Blackboard<class_Blackboard>` blackboard, Node scene_root **)** |const|
:ref:`BTTask<class_BTTask>` **instantiate**\ (\ agent\: ``Node``, blackboard\: :ref:`Blackboard<class_Blackboard>`, scene_root\: ``Node``\ ) |const| :ref:`🔗<class_BehaviorTree_method_instantiate>`
Instantiates the behavior tree and returns the root :ref:`BTTask<class_BTTask>`. ``scene_root`` should be the root node of the scene that the Behavior Tree will be used in (e.g., the owner of the node that contains the behavior tree).
@ -184,7 +184,7 @@ Instantiates the behavior tree and returns the root :ref:`BTTask<class_BTTask>`.
.. rst-class:: classref-method
void **set_root_task** **(** :ref:`BTTask<class_BTTask>` task **)**
|void| **set_root_task**\ (\ task\: :ref:`BTTask<class_BTTask>`\ ) :ref:`🔗<class_BehaviorTree_method_set_root_task>`
Assigns a new root task to the **BehaviorTree** resource.
@ -195,3 +195,4 @@ Assigns a new root task to the **BehaviorTree** resource.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

13
doc/source/classes/class_behaviortreedata.rst
View File

@ -2,8 +2,8 @@
.. 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/BehaviorTreeData.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BehaviorTreeData.xml.
.. _class_BehaviorTreeData:
@ -31,9 +31,9 @@ Methods
.. table::
:widths: auto
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BehaviorTreeData<class_BehaviorTreeData>` | :ref:`create_from_tree_instance<class_BehaviorTreeData_method_create_from_tree_instance>` **(** :ref:`BTTask<class_BTTask>` tree_instance **)** |static| |
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BehaviorTreeData<class_BehaviorTreeData>` | :ref:`create_from_tree_instance<class_BehaviorTreeData_method_create_from_tree_instance>`\ (\ tree_instance\: :ref:`BTTask<class_BTTask>`\ ) |static| |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@ -48,7 +48,7 @@ Method Descriptions
.. rst-class:: classref-method
:ref:`BehaviorTreeData<class_BehaviorTreeData>` **create_from_tree_instance** **(** :ref:`BTTask<class_BTTask>` tree_instance **)** |static|
:ref:`BehaviorTreeData<class_BehaviorTreeData>` **create_from_tree_instance**\ (\ tree_instance\: :ref:`BTTask<class_BTTask>`\ ) |static| :ref:`🔗<class_BehaviorTreeData_method_create_from_tree_instance>`
Returns current state of the ``tree_instance`` encoded as a **BehaviorTreeData**, suitable for use with :ref:`BehaviorTreeView<class_BehaviorTreeView>`.
@ -61,3 +61,4 @@ Behavior tree instance can be acquired with :ref:`BTPlayer.get_tree_instance<cla
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

33
doc/source/classes/class_behaviortreeview.rst
View File

@ -2,8 +2,8 @@
.. 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/BehaviorTreeView.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BehaviorTreeView.xml.
.. _class_BehaviorTreeView:
@ -29,9 +29,9 @@ Properties
.. table::
:widths: auto
+-----+-----------------------------------------------------------------------------------+-------+
| int | :ref:`update_interval_msec<class_BehaviorTreeView_property_update_interval_msec>` | ``0`` |
+-----+-----------------------------------------------------------------------------------+-------+
+---------+-----------------------------------------------------------------------------------+-------+
| ``int`` | :ref:`update_interval_msec<class_BehaviorTreeView_property_update_interval_msec>` | ``0`` |
+---------+-----------------------------------------------------------------------------------+-------+
.. rst-class:: classref-reftable-group
@ -41,11 +41,11 @@ Methods
.. table::
:widths: auto
+------+----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_BehaviorTreeView_method_clear>` **(** **)** |
+------+----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update_tree<class_BehaviorTreeView_method_update_tree>` **(** :ref:`BehaviorTreeData<class_BehaviorTreeData>` behavior_tree_data **)** |
+------+----------------------------------------------------------------------------------------------------------------------------------------------+
+--------+-------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`clear<class_BehaviorTreeView_method_clear>`\ (\ ) |
+--------+-------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`update_tree<class_BehaviorTreeView_method_update_tree>`\ (\ behavior_tree_data\: :ref:`BehaviorTreeData<class_BehaviorTreeData>`\ ) |
+--------+-------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@ -60,7 +60,7 @@ Signals
.. rst-class:: classref-signal
**task_selected** **(** String type_name, String script_path **)**
**task_selected**\ (\ type_name\: ``String``, script_path\: ``String``\ ) :ref:`🔗<class_BehaviorTreeView_signal_task_selected>`
Emitted when a task item is selected in **BehaviorTreeView**.
@ -77,12 +77,12 @@ Property Descriptions
.. rst-class:: classref-property
int **update_interval_msec** = ``0``
``int`` **update_interval_msec** = ``0`` :ref:`🔗<class_BehaviorTreeView_property_update_interval_msec>`
.. rst-class:: classref-property-setget
- void **set_update_interval_msec** **(** int value **)**
- int **get_update_interval_msec** **(** **)**
- |void| **set_update_interval_msec**\ (\ value\: ``int``\ )
- ``int`` **get_update_interval_msec**\ (\ )
Minimum delay between two updates (in milliseconds). Set to higher values for a lower CPU load.
@ -99,7 +99,7 @@ Method Descriptions
.. rst-class:: classref-method
void **clear** **(** **)**
|void| **clear**\ (\ ) :ref:`🔗<class_BehaviorTreeView_method_clear>`
Clears the tree view.
@ -111,7 +111,7 @@ Clears the tree view.
.. rst-class:: classref-method
void **update_tree** **(** :ref:`BehaviorTreeData<class_BehaviorTreeData>` behavior_tree_data **)**
|void| **update_tree**\ (\ behavior_tree_data\: :ref:`BehaviorTreeData<class_BehaviorTreeData>`\ ) :ref:`🔗<class_BehaviorTreeView_method_update_tree>`
Updates the representation of a :ref:`BehaviorTree<class_BehaviorTree>` instance. See also :ref:`BehaviorTreeData<class_BehaviorTreeData>`.
@ -122,3 +122,4 @@ Updates the representation of a :ref:`BehaviorTree<class_BehaviorTree>` instance
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

91
doc/source/classes/class_blackboard.rst
View File

@ -2,8 +2,8 @@
.. 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.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/Blackboard.xml.
.. _class_Blackboard:
@ -33,35 +33,35 @@ Methods
.. table::
:widths: auto
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`bind_var_to_property<class_Blackboard_method_bind_var_to_property>` **(** StringName var_name, Object object, StringName property, bool create=false **)** |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_Blackboard_method_clear>` **(** **)** |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_var<class_Blackboard_method_erase_var>` **(** StringName var_name **)** |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Blackboard<class_Blackboard>` | :ref:`get_parent<class_Blackboard_method_get_parent>` **(** **)** |const| |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Variant | :ref:`get_var<class_Blackboard_method_get_var>` **(** StringName var_name, Variant default=null, bool complain=true **)** |const| |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dictionary | :ref:`get_vars_as_dict<class_Blackboard_method_get_vars_as_dict>` **(** **)** |const| |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| bool | :ref:`has_var<class_Blackboard_method_has_var>` **(** StringName var_name **)** |const| |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`link_var<class_Blackboard_method_link_var>` **(** StringName var_name, :ref:`Blackboard<class_Blackboard>` target_blackboard, StringName target_var, bool create=false **)** |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| StringName[] | :ref:`list_vars<class_Blackboard_method_list_vars>` **(** **)** |const| |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`populate_from_dict<class_Blackboard_method_populate_from_dict>` **(** Dictionary dictionary **)** |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_parent<class_Blackboard_method_set_parent>` **(** :ref:`Blackboard<class_Blackboard>` blackboard **)** |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_var<class_Blackboard_method_set_var>` **(** StringName var_name, Variant value **)** |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Blackboard<class_Blackboard>` | :ref:`top<class_Blackboard_method_top>` **(** **)** |const| |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unbind_var<class_Blackboard_method_unbind_var>` **(** StringName var_name **)** |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`bind_var_to_property<class_Blackboard_method_bind_var_to_property>`\ (\ var_name\: ``StringName``, object\: ``Object``, property\: ``StringName``, create\: ``bool`` = false\ ) |
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`clear<class_Blackboard_method_clear>`\ (\ ) |
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`erase_var<class_Blackboard_method_erase_var>`\ (\ var_name\: ``StringName``\ ) |
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Blackboard<class_Blackboard>` | :ref:`get_parent<class_Blackboard_method_get_parent>`\ (\ ) |const| |
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``Variant`` | :ref:`get_var<class_Blackboard_method_get_var>`\ (\ var_name\: ``StringName``, default\: ``Variant`` = null, complain\: ``bool`` = true\ ) |const| |
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``Dictionary`` | :ref:`get_vars_as_dict<class_Blackboard_method_get_vars_as_dict>`\ (\ ) |const| |
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``bool`` | :ref:`has_var<class_Blackboard_method_has_var>`\ (\ var_name\: ``StringName``\ ) |const| |
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`link_var<class_Blackboard_method_link_var>`\ (\ var_name\: ``StringName``, target_blackboard\: :ref:`Blackboard<class_Blackboard>`, target_var\: ``StringName``, create\: ``bool`` = false\ ) |
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>`\[``StringName``\] | :ref:`list_vars<class_Blackboard_method_list_vars>`\ (\ ) |const| |
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`populate_from_dict<class_Blackboard_method_populate_from_dict>`\ (\ dictionary\: ``Dictionary``\ ) |
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_parent<class_Blackboard_method_set_parent>`\ (\ blackboard\: :ref:`Blackboard<class_Blackboard>`\ ) |
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_var<class_Blackboard_method_set_var>`\ (\ var_name\: ``StringName``, value\: ``Variant``\ ) |
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Blackboard<class_Blackboard>` | :ref:`top<class_Blackboard_method_top>`\ (\ ) |const| |
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`unbind_var<class_Blackboard_method_unbind_var>`\ (\ var_name\: ``StringName``\ ) |
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@ -76,7 +76,7 @@ Method Descriptions
.. rst-class:: classref-method
void **bind_var_to_property** **(** StringName var_name, Object object, StringName property, bool create=false **)**
|void| **bind_var_to_property**\ (\ var_name\: ``StringName``, object\: ``Object``, property\: ``StringName``, create\: ``bool`` = false\ ) :ref:`🔗<class_Blackboard_method_bind_var_to_property>`
Establish a binding between a variable and the object's property specified by ``property`` and ``object``. Changes to the variable update the property, and vice versa. If ``create`` is ``true``, the variable will be created if it doesn't exist.
@ -88,7 +88,7 @@ Establish a binding between a variable and the object's property specified by ``
.. rst-class:: classref-method
void **clear** **(** **)**
|void| **clear**\ (\ ) :ref:`🔗<class_Blackboard_method_clear>`
Removes all variables from the Blackboard. Parent scopes are not affected.
@ -100,7 +100,7 @@ Removes all variables from the Blackboard. Parent scopes are not affected.
.. rst-class:: classref-method
void **erase_var** **(** StringName var_name **)**
|void| **erase_var**\ (\ var_name\: ``StringName``\ ) :ref:`🔗<class_Blackboard_method_erase_var>`
Removes a variable by its name.
@ -112,7 +112,7 @@ Removes a variable by its name.
.. rst-class:: classref-method
:ref:`Blackboard<class_Blackboard>` **get_parent** **(** **)** |const|
:ref:`Blackboard<class_Blackboard>` **get_parent**\ (\ ) |const| :ref:`🔗<class_Blackboard_method_get_parent>`
Returns a Blackboard that serves as the parent scope for this instance.
@ -124,7 +124,7 @@ Returns a Blackboard that serves as the parent scope for this instance.
.. rst-class:: classref-method
Variant **get_var** **(** StringName var_name, Variant default=null, bool complain=true **)** |const|
``Variant`` **get_var**\ (\ var_name\: ``StringName``, default\: ``Variant`` = null, complain\: ``bool`` = true\ ) |const| :ref:`🔗<class_Blackboard_method_get_var>`
Returns variable value or ``default`` if variable doesn't exist. If ``complain`` is ``true``, an error will be printed if variable doesn't exist.
@ -136,7 +136,7 @@ Returns variable value or ``default`` if variable doesn't exist. If ``complain``
.. rst-class:: classref-method
Dictionary **get_vars_as_dict** **(** **)** |const|
``Dictionary`` **get_vars_as_dict**\ (\ ) |const| :ref:`🔗<class_Blackboard_method_get_vars_as_dict>`
Returns all variables in the Blackboard as a dictionary. Keys are the variable names, values are the variable values. Parent scopes are not included.
@ -148,7 +148,7 @@ Returns all variables in the Blackboard as a dictionary. Keys are the variable n
.. rst-class:: classref-method
bool **has_var** **(** StringName var_name **)** |const|
``bool`` **has_var**\ (\ var_name\: ``StringName``\ ) |const| :ref:`🔗<class_Blackboard_method_has_var>`
Returns ``true`` if the Blackboard contains the ``var_name`` variable, including the parent scopes.
@ -160,7 +160,7 @@ Returns ``true`` if the Blackboard contains the ``var_name`` variable, including
.. rst-class:: classref-method
void **link_var** **(** StringName var_name, :ref:`Blackboard<class_Blackboard>` target_blackboard, StringName target_var, bool create=false **)**
|void| **link_var**\ (\ var_name\: ``StringName``, target_blackboard\: :ref:`Blackboard<class_Blackboard>`, target_var\: ``StringName``, create\: ``bool`` = false\ ) :ref:`🔗<class_Blackboard_method_link_var>`
Links a variable to another Blackboard variable. If a variable is linked to another variable, their state will always be identical, and any change to one will be reflected in the other. If ``create`` is ``true``, the variable will be created if it doesn't exist.
@ -174,7 +174,7 @@ You can use this method to link a variable in the current scope to a variable in
.. rst-class:: classref-method
StringName[] **list_vars** **(** **)** |const|
:ref:`Array<class_Array>`\[``StringName``\] **list_vars**\ (\ ) |const| :ref:`🔗<class_Blackboard_method_list_vars>`
Returns all variable names in the Blackboard. Parent scopes are not included.
@ -186,7 +186,7 @@ Returns all variable names in the Blackboard. Parent scopes are not included.
.. rst-class:: classref-method
void **populate_from_dict** **(** Dictionary dictionary **)**
|void| **populate_from_dict**\ (\ dictionary\: ``Dictionary``\ ) :ref:`🔗<class_Blackboard_method_populate_from_dict>`
Fills the Blackboard with multiple variables from a dictionary. The dictionary keys must be variable names and the dictionary values must be variable values. Keys must be StringName or String.
@ -198,7 +198,7 @@ Fills the Blackboard with multiple variables from a dictionary. The dictionary k
.. rst-class:: classref-method
void **set_parent** **(** :ref:`Blackboard<class_Blackboard>` blackboard **)**
|void| **set_parent**\ (\ blackboard\: :ref:`Blackboard<class_Blackboard>`\ ) :ref:`🔗<class_Blackboard_method_set_parent>`
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.
@ -210,7 +210,7 @@ Assigns the parent scope. If a value isn't in the current Blackboard scope, it w
.. rst-class:: classref-method
void **set_var** **(** StringName var_name, Variant value **)**
|void| **set_var**\ (\ var_name\: ``StringName``, value\: ``Variant``\ ) :ref:`🔗<class_Blackboard_method_set_var>`
Assigns a value to a Blackboard variable.
@ -222,7 +222,7 @@ Assigns a value to a Blackboard variable.
.. rst-class:: classref-method
:ref:`Blackboard<class_Blackboard>` **top** **(** **)** |const|
:ref:`Blackboard<class_Blackboard>` **top**\ (\ ) |const| :ref:`🔗<class_Blackboard_method_top>`
Returns the topmost **Blackboard** in the scope chain.
@ -234,7 +234,7 @@ Returns the topmost **Blackboard** in the scope chain.
.. rst-class:: classref-method
void **unbind_var** **(** StringName var_name **)**
|void| **unbind_var**\ (\ var_name\: ``StringName``\ ) :ref:`🔗<class_Blackboard_method_unbind_var>`
Remove binding from a variable.
@ -245,3 +245,4 @@ Remove binding from a variable.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

67
doc/source/classes/class_blackboardplan.rst
View File

@ -2,8 +2,8 @@
.. 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.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BlackboardPlan.xml.
.. _class_BlackboardPlan:
@ -22,9 +22,9 @@ Properties
.. table::
:widths: auto
+------+-------------------------------------------------------------------------------------+----------+
| bool | :ref:`prefetch_nodepath_vars<class_BlackboardPlan_property_prefetch_nodepath_vars>` | ``true`` |
+------+-------------------------------------------------------------------------------------+----------+
+----------+-------------------------------------------------------------------------------------+----------+
| ``bool`` | :ref:`prefetch_nodepath_vars<class_BlackboardPlan_property_prefetch_nodepath_vars>` | ``true`` |
+----------+-------------------------------------------------------------------------------------+----------+
.. rst-class:: classref-reftable-group
@ -34,23 +34,23 @@ Methods
.. table::
:widths: auto
+---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Blackboard<class_Blackboard>` | :ref:`create_blackboard<class_BlackboardPlan_method_create_blackboard>` **(** Node node, :ref:`Blackboard<class_Blackboard>` parent_scope=null **)** |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BlackboardPlan<class_BlackboardPlan>` | :ref:`get_base_plan<class_BlackboardPlan_method_get_base_plan>` **(** **)** |const| |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Callable | :ref:`get_parent_scope_plan_provider<class_BlackboardPlan_method_get_parent_scope_plan_provider>` **(** **)** |const| |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| bool | :ref:`is_derived<class_BlackboardPlan_method_is_derived>` **(** **)** |const| |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`populate_blackboard<class_BlackboardPlan_method_populate_blackboard>` **(** :ref:`Blackboard<class_Blackboard>` blackboard, bool overwrite, Node node **)** |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_base_plan<class_BlackboardPlan_method_set_base_plan>` **(** :ref:`BlackboardPlan<class_BlackboardPlan>` blackboard_plan **)** |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_parent_scope_plan_provider<class_BlackboardPlan_method_set_parent_scope_plan_provider>` **(** Callable callable **)** |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sync_with_base_plan<class_BlackboardPlan_method_sync_with_base_plan>` **(** **)** |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Blackboard<class_Blackboard>` | :ref:`create_blackboard<class_BlackboardPlan_method_create_blackboard>`\ (\ node\: ``Node``, parent_scope\: :ref:`Blackboard<class_Blackboard>` = null\ ) |
+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BlackboardPlan<class_BlackboardPlan>` | :ref:`get_base_plan<class_BlackboardPlan_method_get_base_plan>`\ (\ ) |const| |
+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``Callable`` | :ref:`get_parent_scope_plan_provider<class_BlackboardPlan_method_get_parent_scope_plan_provider>`\ (\ ) |const| |
+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``bool`` | :ref:`is_derived<class_BlackboardPlan_method_is_derived>`\ (\ ) |const| |
+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`populate_blackboard<class_BlackboardPlan_method_populate_blackboard>`\ (\ blackboard\: :ref:`Blackboard<class_Blackboard>`, overwrite\: ``bool``, node\: ``Node``\ ) |
+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_base_plan<class_BlackboardPlan_method_set_base_plan>`\ (\ blackboard_plan\: :ref:`BlackboardPlan<class_BlackboardPlan>`\ ) |
+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_parent_scope_plan_provider<class_BlackboardPlan_method_set_parent_scope_plan_provider>`\ (\ callable\: ``Callable``\ ) |
+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`sync_with_base_plan<class_BlackboardPlan_method_sync_with_base_plan>`\ (\ ) |
+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@ -65,12 +65,12 @@ Property Descriptions
.. rst-class:: classref-property
bool **prefetch_nodepath_vars** = ``true``
``bool`` **prefetch_nodepath_vars** = ``true`` :ref:`🔗<class_BlackboardPlan_property_prefetch_nodepath_vars>`
.. rst-class:: classref-property-setget
- void **set_prefetch_nodepath_vars** **(** bool value **)**
- bool **is_prefetching_nodepath_vars** **(** **)**
- |void| **set_prefetch_nodepath_vars**\ (\ value\: ``bool``\ )
- ``bool`` **is_prefetching_nodepath_vars**\ (\ )
Enables or disables ``NodePath`` variable prefetching. If ``true``, ``NodePath`` values will be replaced with node instances when the :ref:`Blackboard<class_Blackboard>` is created.
@ -87,7 +87,7 @@ Method Descriptions
.. rst-class:: classref-method
:ref:`Blackboard<class_Blackboard>` **create_blackboard** **(** Node node, :ref:`Blackboard<class_Blackboard>` parent_scope=null **)**
:ref:`Blackboard<class_Blackboard>` **create_blackboard**\ (\ node\: ``Node``, parent_scope\: :ref:`Blackboard<class_Blackboard>` = null\ ) :ref:`🔗<class_BlackboardPlan_method_create_blackboard>`
Constructs a new instance of a :ref:`Blackboard<class_Blackboard>` using this plan. If ``NodePath`` prefetching is enabled, ``node`` will be used to retrieve node instances for ``NodePath`` variables and substitute their values.
@ -99,7 +99,7 @@ Constructs a new instance of a :ref:`Blackboard<class_Blackboard>` using this pl
.. rst-class:: classref-method
:ref:`BlackboardPlan<class_BlackboardPlan>` **get_base_plan** **(** **)** |const|
:ref:`BlackboardPlan<class_BlackboardPlan>` **get_base_plan**\ (\ ) |const| :ref:`🔗<class_BlackboardPlan_method_get_base_plan>`
Returns the base plan. See :ref:`is_derived<class_BlackboardPlan_method_is_derived>`.
@ -111,7 +111,7 @@ Returns the base plan. See :ref:`is_derived<class_BlackboardPlan_method_is_deriv
.. rst-class:: classref-method
Callable **get_parent_scope_plan_provider** **(** **)** |const|
``Callable`` **get_parent_scope_plan_provider**\ (\ ) |const| :ref:`🔗<class_BlackboardPlan_method_get_parent_scope_plan_provider>`
Returns the parent scope plan provider - a callable that returns a **BlackboardPlan**.
@ -123,7 +123,7 @@ Returns the parent scope plan provider - a callable that returns a **BlackboardP
.. rst-class:: classref-method
bool **is_derived** **(** **)** |const|
``bool`` **is_derived**\ (\ ) |const| :ref:`🔗<class_BlackboardPlan_method_is_derived>`
Returns ``true`` if this plan is derived from another, i.e., the base plan is not ``null``. A derived plan can only contain variables that are present in the base plan, and only variable values can be different.
@ -135,7 +135,7 @@ Returns ``true`` if this plan is derived from another, i.e., the base plan is no
.. rst-class:: classref-method
void **populate_blackboard** **(** :ref:`Blackboard<class_Blackboard>` blackboard, bool overwrite, Node node **)**
|void| **populate_blackboard**\ (\ blackboard\: :ref:`Blackboard<class_Blackboard>`, overwrite\: ``bool``, node\: ``Node``\ ) :ref:`🔗<class_BlackboardPlan_method_populate_blackboard>`
Populates ``blackboard`` with the variables from this plan. If ``overwrite`` is ``true``, existing variables with the same names will be overwritten. If ``NodePath`` prefetching is enabled, ``node`` will be used to retrieve node instances for ``NodePath`` variables and substitute their values.
@ -147,7 +147,7 @@ Populates ``blackboard`` with the variables from this plan. If ``overwrite`` is
.. rst-class:: classref-method
void **set_base_plan** **(** :ref:`BlackboardPlan<class_BlackboardPlan>` blackboard_plan **)**
|void| **set_base_plan**\ (\ blackboard_plan\: :ref:`BlackboardPlan<class_BlackboardPlan>`\ ) :ref:`🔗<class_BlackboardPlan_method_set_base_plan>`
Sets the base plan. If assigned, this plan will be derived from the base plan.
@ -161,7 +161,7 @@ Use with caution, as it will remove variables not present in the base plan. Only
.. rst-class:: classref-method
void **set_parent_scope_plan_provider** **(** Callable callable **)**
|void| **set_parent_scope_plan_provider**\ (\ callable\: ``Callable``\ ) :ref:`🔗<class_BlackboardPlan_method_set_parent_scope_plan_provider>`
Sets the parent scope plan provider - a callable that returns a **BlackboardPlan**. Used to provide hints in the inspector. When set, mapping feature becomes available.
@ -173,7 +173,7 @@ Sets the parent scope plan provider - a callable that returns a **BlackboardPlan
.. rst-class:: classref-method
void **sync_with_base_plan** **(** **)**
|void| **sync_with_base_plan**\ (\ ) :ref:`🔗<class_BlackboardPlan_method_sync_with_base_plan>`
Synchronizes this plan with the base plan: removes variables not present in the base plan, and updates type information. Only use this for custom tooling.
@ -184,3 +184,4 @@ Synchronizes this plan with the base plan: removes variables not present in the
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

7
doc/source/classes/class_bt.rst
View File

@ -2,8 +2,8 @@
.. 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/BT.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BT.xml.
.. _class_BT:
@ -29,7 +29,7 @@ Enumerations
.. rst-class:: classref-enumeration
enum **Status**:
enum **Status**: :ref:`🔗<enum_BT_Status>`
.. _class_BT_constant_FRESH:
@ -70,3 +70,4 @@ Task has finished with success.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_btaction.rst
View File

@ -2,8 +2,8 @@
.. 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/BTAction.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTAction.xml.
.. _class_BTAction:
@ -34,3 +34,4 @@ A single action can perform a task within one or multiple ticks. If it takes mor
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_btalwaysfail.rst
View File

@ -2,8 +2,8 @@
.. 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/BTAlwaysFail.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTAlwaysFail.xml.
.. _class_BTAlwaysFail:
@ -21,3 +21,4 @@ BT decorator that converts ``SUCCESS`` into ``FAILURE``.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_btalwayssucceed.rst
View File

@ -2,8 +2,8 @@
.. 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/BTAlwaysSucceed.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTAlwaysSucceed.xml.
.. _class_BTAlwaysSucceed:
@ -21,3 +21,4 @@ BT decorator that converts ``FAILURE`` into ``SUCCESS``.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

27
doc/source/classes/class_btawaitanimation.rst
View File

@ -2,8 +2,8 @@
.. 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/BTAwaitAnimation.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTAwaitAnimation.xml.
.. _class_BTAwaitAnimation:
@ -34,11 +34,11 @@ Properties
:widths: auto
+-----------------------------+---------------------------------------------------------------------------+---------+
| StringName | :ref:`animation_name<class_BTAwaitAnimation_property_animation_name>` | ``&""`` |
| ``StringName`` | :ref:`animation_name<class_BTAwaitAnimation_property_animation_name>` | ``&""`` |
+-----------------------------+---------------------------------------------------------------------------+---------+
| :ref:`BBNode<class_BBNode>` | :ref:`animation_player<class_BTAwaitAnimation_property_animation_player>` | |
+-----------------------------+---------------------------------------------------------------------------+---------+
| float | :ref:`max_time<class_BTAwaitAnimation_property_max_time>` | ``1.0`` |
| ``float`` | :ref:`max_time<class_BTAwaitAnimation_property_max_time>` | ``1.0`` |
+-----------------------------+---------------------------------------------------------------------------+---------+
.. rst-class:: classref-section-separator
@ -54,12 +54,12 @@ Property Descriptions
.. rst-class:: classref-property
StringName **animation_name** = ``&""``
``StringName`` **animation_name** = ``&""`` :ref:`🔗<class_BTAwaitAnimation_property_animation_name>`
.. rst-class:: classref-property-setget
- void **set_animation_name** **(** StringName value **)**
- StringName **get_animation_name** **(** **)**
- |void| **set_animation_name**\ (\ value\: ``StringName``\ )
- ``StringName`` **get_animation_name**\ (\ )
Animation's key within the ``AnimationPlayer`` node.
@ -71,12 +71,12 @@ Animation's key within the ``AnimationPlayer`` node.
.. rst-class:: classref-property
:ref:`BBNode<class_BBNode>` **animation_player**
:ref:`BBNode<class_BBNode>` **animation_player** :ref:`🔗<class_BTAwaitAnimation_property_animation_player>`
.. rst-class:: classref-property-setget
- void **set_animation_player** **(** :ref:`BBNode<class_BBNode>` value **)**
- :ref:`BBNode<class_BBNode>` **get_animation_player** **(** **)**
- |void| **set_animation_player**\ (\ value\: :ref:`BBNode<class_BBNode>`\ )
- :ref:`BBNode<class_BBNode>` **get_animation_player**\ (\ )
Parameter that specifies the ``AnimationPlayer`` node.
@ -88,12 +88,12 @@ Parameter that specifies the ``AnimationPlayer`` node.
.. rst-class:: classref-property
float **max_time** = ``1.0``
``float`` **max_time** = ``1.0`` :ref:`🔗<class_BTAwaitAnimation_property_max_time>`
.. rst-class:: classref-property-setget
- void **set_max_time** **(** float value **)**
- float **get_max_time** **(** **)**
- |void| **set_max_time**\ (\ value\: ``float``\ )
- ``float`` **get_max_time**\ (\ )
The maximum duration to wait for the animation to complete (in seconds). If the animation doesn't finish within this time, BTAwaitAnimation will return ``FAILURE``.
@ -104,3 +104,4 @@ The maximum duration to wait for the animation to complete (in seconds). If the
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

57
doc/source/classes/class_btcallmethod.rst
View File

@ -2,8 +2,8 @@
.. 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/BTCallMethod.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTCallMethod.xml.
.. _class_BTCallMethod:
@ -31,17 +31,17 @@ Properties
.. table::
:widths: auto
+-------------------------------------+---------------------------------------------------------------------------+-----------+
| :ref:`BBVariant[]<class_BBVariant>` | :ref:`args<class_BTCallMethod_property_args>` | ``[]`` |
+-------------------------------------+---------------------------------------------------------------------------+-----------+
| bool | :ref:`args_include_delta<class_BTCallMethod_property_args_include_delta>` | ``false`` |
+-------------------------------------+---------------------------------------------------------------------------+-----------+
| StringName | :ref:`method<class_BTCallMethod_property_method>` | ``&""`` |
+-------------------------------------+---------------------------------------------------------------------------+-----------+
| :ref:`BBNode<class_BBNode>` | :ref:`node<class_BTCallMethod_property_node>` | |
+-------------------------------------+---------------------------------------------------------------------------+-----------+
| StringName | :ref:`result_var<class_BTCallMethod_property_result_var>` | ``&""`` |
+-------------------------------------+---------------------------------------------------------------------------+-----------+
+----------------------------------------------------------------+---------------------------------------------------------------------------+-----------+
| :ref:`Array<class_Array>`\[:ref:`BBVariant<class_BBVariant>`\] | :ref:`args<class_BTCallMethod_property_args>` | ``[]`` |
+----------------------------------------------------------------+---------------------------------------------------------------------------+-----------+
| ``bool`` | :ref:`args_include_delta<class_BTCallMethod_property_args_include_delta>` | ``false`` |
+----------------------------------------------------------------+---------------------------------------------------------------------------+-----------+
| ``StringName`` | :ref:`method<class_BTCallMethod_property_method>` | ``&""`` |
+----------------------------------------------------------------+---------------------------------------------------------------------------+-----------+
| :ref:`BBNode<class_BBNode>` | :ref:`node<class_BTCallMethod_property_node>` | |
+----------------------------------------------------------------+---------------------------------------------------------------------------+-----------+
| ``StringName`` | :ref:`result_var<class_BTCallMethod_property_result_var>` | ``&""`` |
+----------------------------------------------------------------+---------------------------------------------------------------------------+-----------+
.. rst-class:: classref-section-separator
@ -56,12 +56,12 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`BBVariant[]<class_BBVariant>` **args** = ``[]``
:ref:`Array<class_Array>`\[:ref:`BBVariant<class_BBVariant>`\] **args** = ``[]`` :ref:`🔗<class_BTCallMethod_property_args>`
.. rst-class:: classref-property-setget
- void **set_args** **(** :ref:`BBVariant[]<class_BBVariant>` value **)**
- :ref:`BBVariant[]<class_BBVariant>` **get_args** **(** **)**
- |void| **set_args**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`BBVariant<class_BBVariant>`\]\ )
- :ref:`Array<class_Array>`\[:ref:`BBVariant<class_BBVariant>`\] **get_args**\ (\ )
The arguments to be passed when calling the method.
@ -73,12 +73,12 @@ The arguments to be passed when calling the method.
.. rst-class:: classref-property
bool **args_include_delta** = ``false``
``bool`` **args_include_delta** = ``false`` :ref:`🔗<class_BTCallMethod_property_args_include_delta>`
.. rst-class:: classref-property-setget
- void **set_include_delta** **(** bool value **)**
- bool **is_delta_included** **(** **)**
- |void| **set_include_delta**\ (\ value\: ``bool``\ )
- ``bool`` **is_delta_included**\ (\ )
Include delta as a first parameter and shift the position of the rest of the arguments if any.
@ -90,12 +90,12 @@ Include delta as a first parameter and shift the position of the rest of the arg
.. rst-class:: classref-property
StringName **method** = ``&""``
``StringName`` **method** = ``&""`` :ref:`🔗<class_BTCallMethod_property_method>`
.. rst-class:: classref-property-setget
- void **set_method** **(** StringName value **)**
- StringName **get_method** **(** **)**
- |void| **set_method**\ (\ value\: ``StringName``\ )
- ``StringName`` **get_method**\ (\ )
The name of the method to be called.
@ -107,12 +107,12 @@ The name of the method to be called.
.. rst-class:: classref-property
:ref:`BBNode<class_BBNode>` **node**
:ref:`BBNode<class_BBNode>` **node** :ref:`🔗<class_BTCallMethod_property_node>`
.. rst-class:: classref-property-setget
- void **set_node_param** **(** :ref:`BBNode<class_BBNode>` value **)**
- :ref:`BBNode<class_BBNode>` **get_node_param** **(** **)**
- |void| **set_node_param**\ (\ value\: :ref:`BBNode<class_BBNode>`\ )
- :ref:`BBNode<class_BBNode>` **get_node_param**\ (\ )
Specifies the ``Node`` or ``Object`` instance containing the method to be called.
@ -124,12 +124,12 @@ Specifies the ``Node`` or ``Object`` instance containing the method to be called
.. rst-class:: classref-property
StringName **result_var** = ``&""``
``StringName`` **result_var** = ``&""`` :ref:`🔗<class_BTCallMethod_property_result_var>`
.. rst-class:: classref-property-setget
- void **set_result_var** **(** StringName value **)**
- StringName **get_result_var** **(** **)**
- |void| **set_result_var**\ (\ value\: ``StringName``\ )
- ``StringName`` **get_result_var**\ (\ )
if non-empty, assign the result of the method call to the blackboard variable specified by this property.
@ -140,3 +140,4 @@ if non-empty, assign the result of the method call to the blackboard variable sp
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

25
doc/source/classes/class_btcheckagentproperty.rst
View File

@ -2,8 +2,8 @@
.. 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/BTCheckAgentProperty.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTCheckAgentProperty.xml.
.. _class_BTCheckAgentProperty:
@ -34,7 +34,7 @@ Properties
+-----------------------------------------------+-------------------------------------------------------------------+---------+
| :ref:`CheckType<enum_LimboUtility_CheckType>` | :ref:`check_type<class_BTCheckAgentProperty_property_check_type>` | ``0`` |
+-----------------------------------------------+-------------------------------------------------------------------+---------+
| StringName | :ref:`property<class_BTCheckAgentProperty_property_property>` | ``&""`` |
| ``StringName`` | :ref:`property<class_BTCheckAgentProperty_property_property>` | ``&""`` |
+-----------------------------------------------+-------------------------------------------------------------------+---------+
| :ref:`BBVariant<class_BBVariant>` | :ref:`value<class_BTCheckAgentProperty_property_value>` | |
+-----------------------------------------------+-------------------------------------------------------------------+---------+
@ -52,12 +52,12 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`CheckType<enum_LimboUtility_CheckType>` **check_type** = ``0``
:ref:`CheckType<enum_LimboUtility_CheckType>` **check_type** = ``0`` :ref:`🔗<class_BTCheckAgentProperty_property_check_type>`
.. rst-class:: classref-property-setget
- void **set_check_type** **(** :ref:`CheckType<enum_LimboUtility_CheckType>` value **)**
- :ref:`CheckType<enum_LimboUtility_CheckType>` **get_check_type** **(** **)**
- |void| **set_check_type**\ (\ value\: :ref:`CheckType<enum_LimboUtility_CheckType>`\ )
- :ref:`CheckType<enum_LimboUtility_CheckType>` **get_check_type**\ (\ )
The type of check to be performed.
@ -69,12 +69,12 @@ The type of check to be performed.
.. rst-class:: classref-property
StringName **property** = ``&""``
``StringName`` **property** = ``&""`` :ref:`🔗<class_BTCheckAgentProperty_property_property>`
.. rst-class:: classref-property-setget
- void **set_property** **(** StringName value **)**
- StringName **get_property** **(** **)**
- |void| **set_property**\ (\ value\: ``StringName``\ )
- ``StringName`` **get_property**\ (\ )
Parameter that specifies the agent's property to be compared.
@ -86,12 +86,12 @@ Parameter that specifies the agent's property to be compared.
.. rst-class:: classref-property
:ref:`BBVariant<class_BBVariant>` **value**
:ref:`BBVariant<class_BBVariant>` **value** :ref:`🔗<class_BTCheckAgentProperty_property_value>`
.. rst-class:: classref-property-setget
- void **set_value** **(** :ref:`BBVariant<class_BBVariant>` value **)**
- :ref:`BBVariant<class_BBVariant>` **get_value** **(** **)**
- |void| **set_value**\ (\ value\: :ref:`BBVariant<class_BBVariant>`\ )
- :ref:`BBVariant<class_BBVariant>` **get_value**\ (\ )
Parameter that specifies the value against which an agent's property will be compared.
@ -102,3 +102,4 @@ Parameter that specifies the value against which an agent's property will be com
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

17
doc/source/classes/class_btchecktrigger.rst
View File

@ -2,8 +2,8 @@
.. 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/BTCheckTrigger.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTCheckTrigger.xml.
.. _class_BTCheckTrigger:
@ -31,9 +31,9 @@ Properties
.. table::
:widths: auto
+------------+---------------------------------------------------------+---------+
| StringName | :ref:`variable<class_BTCheckTrigger_property_variable>` | ``&""`` |
+------------+---------------------------------------------------------+---------+
+----------------+---------------------------------------------------------+---------+
| ``StringName`` | :ref:`variable<class_BTCheckTrigger_property_variable>` | ``&""`` |
+----------------+---------------------------------------------------------+---------+
.. rst-class:: classref-section-separator
@ -48,12 +48,12 @@ Property Descriptions
.. rst-class:: classref-property
StringName **variable** = ``&""``
``StringName`` **variable** = ``&""`` :ref:`🔗<class_BTCheckTrigger_property_variable>`
.. rst-class:: classref-property-setget
- void **set_variable** **(** StringName value **)**
- StringName **get_variable** **(** **)**
- |void| **set_variable**\ (\ value\: ``StringName``\ )
- ``StringName`` **get_variable**\ (\ )
A boolean variable on the blackboard used as a trigger. See also :ref:`BTTask.blackboard<class_BTTask_property_blackboard>`.
@ -68,3 +68,4 @@ If variable's value is ``false``, **BTCheckTrigger** will return ``FAILURE``.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

25
doc/source/classes/class_btcheckvar.rst
View File

@ -2,8 +2,8 @@
.. 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/BTCheckVar.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTCheckVar.xml.
.. _class_BTCheckVar:
@ -34,7 +34,7 @@ Properties
+-----------------------------------------------+---------------------------------------------------------+---------+
| :ref:`BBVariant<class_BBVariant>` | :ref:`value<class_BTCheckVar_property_value>` | |
+-----------------------------------------------+---------------------------------------------------------+---------+
| StringName | :ref:`variable<class_BTCheckVar_property_variable>` | ``&""`` |
| ``StringName`` | :ref:`variable<class_BTCheckVar_property_variable>` | ``&""`` |
+-----------------------------------------------+---------------------------------------------------------+---------+
.. rst-class:: classref-section-separator
@ -50,12 +50,12 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`CheckType<enum_LimboUtility_CheckType>` **check_type** = ``0``
:ref:`CheckType<enum_LimboUtility_CheckType>` **check_type** = ``0`` :ref:`🔗<class_BTCheckVar_property_check_type>`
.. rst-class:: classref-property-setget
- void **set_check_type** **(** :ref:`CheckType<enum_LimboUtility_CheckType>` value **)**
- :ref:`CheckType<enum_LimboUtility_CheckType>` **get_check_type** **(** **)**
- |void| **set_check_type**\ (\ value\: :ref:`CheckType<enum_LimboUtility_CheckType>`\ )
- :ref:`CheckType<enum_LimboUtility_CheckType>` **get_check_type**\ (\ )
The type of check to be performed.
@ -67,12 +67,12 @@ The type of check to be performed.
.. rst-class:: classref-property
:ref:`BBVariant<class_BBVariant>` **value**
:ref:`BBVariant<class_BBVariant>` **value** :ref:`🔗<class_BTCheckVar_property_value>`
.. rst-class:: classref-property-setget
- void **set_value** **(** :ref:`BBVariant<class_BBVariant>` value **)**
- :ref:`BBVariant<class_BBVariant>` **get_value** **(** **)**
- |void| **set_value**\ (\ value\: :ref:`BBVariant<class_BBVariant>`\ )
- :ref:`BBVariant<class_BBVariant>` **get_value**\ (\ )
A parameter that specifies the value against which the :ref:`variable<class_BTCheckVar_property_variable>` will be compared.
@ -84,12 +84,12 @@ A parameter that specifies the value against which the :ref:`variable<class_BTCh
.. rst-class:: classref-property
StringName **variable** = ``&""``
``StringName`` **variable** = ``&""`` :ref:`🔗<class_BTCheckVar_property_variable>`
.. rst-class:: classref-property-setget
- void **set_variable** **(** StringName value **)**
- StringName **get_variable** **(** **)**
- |void| **set_variable**\ (\ value\: ``StringName``\ )
- ``StringName`` **get_variable**\ (\ )
The name of the variable to check its value.
@ -100,3 +100,4 @@ The name of the variable to check its value.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_btcomment.rst
View File

@ -2,8 +2,8 @@
.. 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/BTComment.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTComment.xml.
.. _class_BTComment:
@ -30,3 +30,4 @@ Comments are not executed as part of the tree and are removed from runtime insta
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_btcomposite.rst
View File

@ -2,8 +2,8 @@
.. 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/BTComposite.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTComposite.xml.
.. _class_BTComposite:
@ -32,3 +32,4 @@ Composite is a control task within a :ref:`BehaviorTree<class_BehaviorTree>` tha
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_btcondition.rst
View File

@ -2,8 +2,8 @@
.. 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/BTCondition.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTCondition.xml.
.. _class_BTCondition:
@ -34,3 +34,4 @@ Conditions typically don't take multiple ticks to finish and return either ``SUC
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

29
doc/source/classes/class_btconsoleprint.rst
View File

@ -2,8 +2,8 @@
.. 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/BTConsolePrint.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTConsolePrint.xml.
.. _class_BTConsolePrint:
@ -29,11 +29,11 @@ Properties
.. table::
:widths: auto
+-------------------+---------------------------------------------------------------------------------+-------------------------+
| PackedStringArray | :ref:`bb_format_parameters<class_BTConsolePrint_property_bb_format_parameters>` | ``PackedStringArray()`` |
+-------------------+---------------------------------------------------------------------------------+-------------------------+
| String | :ref:`text<class_BTConsolePrint_property_text>` | ``""`` |
+-------------------+---------------------------------------------------------------------------------+-------------------------+
+-----------------------+---------------------------------------------------------------------------------+-------------------------+
| ``PackedStringArray`` | :ref:`bb_format_parameters<class_BTConsolePrint_property_bb_format_parameters>` | ``PackedStringArray()`` |
+-----------------------+---------------------------------------------------------------------------------+-------------------------+
| ``String`` | :ref:`text<class_BTConsolePrint_property_text>` | ``""`` |
+-----------------------+---------------------------------------------------------------------------------+-------------------------+
.. rst-class:: classref-section-separator
@ -48,15 +48,17 @@ Property Descriptions
.. rst-class:: classref-property
PackedStringArray **bb_format_parameters** = ``PackedStringArray()``
``PackedStringArray`` **bb_format_parameters** = ``PackedStringArray()`` :ref:`🔗<class_BTConsolePrint_property_bb_format_parameters>`
.. rst-class:: classref-property-setget
- void **set_bb_format_parameters** **(** PackedStringArray value **)**
- PackedStringArray **get_bb_format_parameters** **(** **)**
- |void| **set_bb_format_parameters**\ (\ value\: ``PackedStringArray``\ )
- ``PackedStringArray`` **get_bb_format_parameters**\ (\ )
The values of format parameters are used as format arguments for the text that will be printed.
**Note:** The returned array is *copied* and any changes to it will not update the original property value. See ``PackedStringArray`` for more details.
.. rst-class:: classref-item-separator
----
@ -65,12 +67,12 @@ The values of format parameters are used as format arguments for the text that w
.. rst-class:: classref-property
String **text** = ``""``
``String`` **text** = ``""`` :ref:`🔗<class_BTConsolePrint_property_text>`
.. rst-class:: classref-property-setget
- void **set_text** **(** String value **)**
- String **get_text** **(** **)**
- |void| **set_text**\ (\ value\: ``String``\ )
- ``String`` **get_text**\ (\ )
The text to be printed, which can include multiple placeholders to be substituted with format arguments. These placeholders follow the same format as GDScript's % operator and typically start with '%' followed by a format specifier. For instance: %s for string, %d for integer, %f for real.
@ -81,3 +83,4 @@ The text to be printed, which can include multiple placeholders to be substitute
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

57
doc/source/classes/class_btcooldown.rst
View File

@ -2,8 +2,8 @@
.. 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/BTCooldown.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTCooldown.xml.
.. _class_BTCooldown:
@ -35,17 +35,17 @@ Properties
.. table::
:widths: auto
+------------+-------------------------------------------------------------------------+-----------+
| StringName | :ref:`cooldown_state_var<class_BTCooldown_property_cooldown_state_var>` | ``&""`` |
+------------+-------------------------------------------------------------------------+-----------+
| float | :ref:`duration<class_BTCooldown_property_duration>` | ``10.0`` |
+------------+-------------------------------------------------------------------------+-----------+
| bool | :ref:`process_pause<class_BTCooldown_property_process_pause>` | ``false`` |
+------------+-------------------------------------------------------------------------+-----------+
| bool | :ref:`start_cooled<class_BTCooldown_property_start_cooled>` | ``false`` |
+------------+-------------------------------------------------------------------------+-----------+
| bool | :ref:`trigger_on_failure<class_BTCooldown_property_trigger_on_failure>` | ``false`` |
+------------+-------------------------------------------------------------------------+-----------+
+----------------+-------------------------------------------------------------------------+-----------+
| ``StringName`` | :ref:`cooldown_state_var<class_BTCooldown_property_cooldown_state_var>` | ``&""`` |
+----------------+-------------------------------------------------------------------------+-----------+
| ``float`` | :ref:`duration<class_BTCooldown_property_duration>` | ``10.0`` |
+----------------+-------------------------------------------------------------------------+-----------+
| ``bool`` | :ref:`process_pause<class_BTCooldown_property_process_pause>` | ``false`` |
+----------------+-------------------------------------------------------------------------+-----------+
| ``bool`` | :ref:`start_cooled<class_BTCooldown_property_start_cooled>` | ``false`` |
+----------------+-------------------------------------------------------------------------+-----------+
| ``bool`` | :ref:`trigger_on_failure<class_BTCooldown_property_trigger_on_failure>` | ``false`` |
+----------------+-------------------------------------------------------------------------+-----------+
.. rst-class:: classref-section-separator
@ -60,12 +60,12 @@ Property Descriptions
.. rst-class:: classref-property
StringName **cooldown_state_var** = ``&""``
``StringName`` **cooldown_state_var** = ``&""`` :ref:`🔗<class_BTCooldown_property_cooldown_state_var>`
.. rst-class:: classref-property-setget
- void **set_cooldown_state_var** **(** StringName value **)**
- StringName **get_cooldown_state_var** **(** **)**
- |void| **set_cooldown_state_var**\ (\ value\: ``StringName``\ )
- ``StringName`` **get_cooldown_state_var**\ (\ )
A boolean variable used to store the cooldown state in the :ref:`Blackboard<class_Blackboard>`. If left empty, the variable will be automatically generated and assigned.
@ -79,12 +79,12 @@ If the variable's value is set to ``true``, it indicates that the cooldown is ac
.. rst-class:: classref-property
float **duration** = ``10.0``
``float`` **duration** = ``10.0`` :ref:`🔗<class_BTCooldown_property_duration>`
.. rst-class:: classref-property-setget
- void **set_duration** **(** float value **)**
- float **get_duration** **(** **)**
- |void| **set_duration**\ (\ value\: ``float``\ )
- ``float`` **get_duration**\ (\ )
Time to wait before permitting another child's execution.
@ -96,12 +96,12 @@ Time to wait before permitting another child's execution.
.. rst-class:: classref-property
bool **process_pause** = ``false``
``bool`` **process_pause** = ``false`` :ref:`🔗<class_BTCooldown_property_process_pause>`
.. rst-class:: classref-property-setget
- void **set_process_pause** **(** bool value **)**
- bool **get_process_pause** **(** **)**
- |void| **set_process_pause**\ (\ value\: ``bool``\ )
- ``bool`` **get_process_pause**\ (\ )
If ``true``, process cooldown when the ``SceneTree`` is paused.
@ -113,12 +113,12 @@ If ``true``, process cooldown when the ``SceneTree`` is paused.
.. rst-class:: classref-property
bool **start_cooled** = ``false``
``bool`` **start_cooled** = ``false`` :ref:`🔗<class_BTCooldown_property_start_cooled>`
.. rst-class:: classref-property-setget
- void **set_start_cooled** **(** bool value **)**
- bool **get_start_cooled** **(** **)**
- |void| **set_start_cooled**\ (\ value\: ``bool``\ )
- ``bool`` **get_start_cooled**\ (\ )
If ``true``, initiate a cooldown as if the child had been executed before the first BT tick.
@ -130,12 +130,12 @@ If ``true``, initiate a cooldown as if the child had been executed before the fi
.. rst-class:: classref-property
bool **trigger_on_failure** = ``false``
``bool`` **trigger_on_failure** = ``false`` :ref:`🔗<class_BTCooldown_property_trigger_on_failure>`
.. rst-class:: classref-property-setget
- void **set_trigger_on_failure** **(** bool value **)**
- bool **get_trigger_on_failure** **(** **)**
- |void| **set_trigger_on_failure**\ (\ value\: ``bool``\ )
- ``bool`` **get_trigger_on_failure**\ (\ )
If ``true``, the cooldown will be activated if the child task also returns ``FAILURE``. Otherwise, the cooldown will only be triggered when the child task returns ``SUCCESS``.
@ -146,3 +146,4 @@ If ``true``, the cooldown will be activated if the child task also returns ``FAI
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_btdecorator.rst
View File

@ -2,8 +2,8 @@
.. 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/BTDecorator.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTDecorator.xml.
.. _class_BTDecorator:
@ -34,3 +34,4 @@ Decorators can be used to add conditions, limits, or other constraints to the ex
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

17
doc/source/classes/class_btdelay.rst
View File

@ -2,8 +2,8 @@
.. 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/BTDelay.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTDelay.xml.
.. _class_BTDelay:
@ -29,9 +29,9 @@ Properties
.. table::
:widths: auto
+-------+------------------------------------------------+---------+
| float | :ref:`seconds<class_BTDelay_property_seconds>` | ``1.0`` |
+-------+------------------------------------------------+---------+
+-----------+------------------------------------------------+---------+
| ``float`` | :ref:`seconds<class_BTDelay_property_seconds>` | ``1.0`` |
+-----------+------------------------------------------------+---------+
.. rst-class:: classref-section-separator
@ -46,12 +46,12 @@ Property Descriptions
.. rst-class:: classref-property
float **seconds** = ``1.0``
``float`` **seconds** = ``1.0`` :ref:`🔗<class_BTDelay_property_seconds>`
.. rst-class:: classref-property-setget
- void **set_seconds** **(** float value **)**
- float **get_seconds** **(** **)**
- |void| **set_seconds**\ (\ value\: ``float``\ )
- ``float`` **get_seconds**\ (\ )
Delay duration in seconds.
@ -62,3 +62,4 @@ Delay duration in seconds.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_btdynamicselector.rst
View File

@ -2,8 +2,8 @@
.. 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/BTDynamicSelector.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTDynamicSelector.xml.
.. _class_BTDynamicSelector:
@ -34,3 +34,4 @@ Returns ``SUCCESS`` if a child task results in ``SUCCESS``.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_btdynamicsequence.rst
View File

@ -2,8 +2,8 @@
.. 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/BTDynamicSequence.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTDynamicSequence.xml.
.. _class_BTDynamicSequence:
@ -34,3 +34,4 @@ Returns ``SUCCESS`` if all child tasks result in ``SUCCESS``.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

77
doc/source/classes/class_btevaluateexpression.rst
View File

@ -2,8 +2,8 @@
.. 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/BTEvaluateExpression.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTEvaluateExpression.xml.
.. _class_BTEvaluateExpression:
@ -31,19 +31,19 @@ Properties
.. table::
:widths: auto
+-------------------------------------+-------------------------------------------------------------------------------------+-------------------------+
| String | :ref:`expression_string<class_BTEvaluateExpression_property_expression_string>` | ``""`` |
+-------------------------------------+-------------------------------------------------------------------------------------+-------------------------+
| bool | :ref:`input_include_delta<class_BTEvaluateExpression_property_input_include_delta>` | ``false`` |
+-------------------------------------+-------------------------------------------------------------------------------------+-------------------------+
| PackedStringArray | :ref:`input_names<class_BTEvaluateExpression_property_input_names>` | ``PackedStringArray()`` |
+-------------------------------------+-------------------------------------------------------------------------------------+-------------------------+
| :ref:`BBVariant[]<class_BBVariant>` | :ref:`input_values<class_BTEvaluateExpression_property_input_values>` | ``[]`` |
+-------------------------------------+-------------------------------------------------------------------------------------+-------------------------+
| :ref:`BBNode<class_BBNode>` | :ref:`node<class_BTEvaluateExpression_property_node>` | |
+-------------------------------------+-------------------------------------------------------------------------------------+-------------------------+
| StringName | :ref:`result_var<class_BTEvaluateExpression_property_result_var>` | ``&""`` |
+-------------------------------------+-------------------------------------------------------------------------------------+-------------------------+
+----------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------+
| ``String`` | :ref:`expression_string<class_BTEvaluateExpression_property_expression_string>` | ``""`` |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------+
| ``bool`` | :ref:`input_include_delta<class_BTEvaluateExpression_property_input_include_delta>` | ``false`` |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------+
| ``PackedStringArray`` | :ref:`input_names<class_BTEvaluateExpression_property_input_names>` | ``PackedStringArray()`` |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------+
| :ref:`Array<class_Array>`\[:ref:`BBVariant<class_BBVariant>`\] | :ref:`input_values<class_BTEvaluateExpression_property_input_values>` | ``[]`` |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------+
| :ref:`BBNode<class_BBNode>` | :ref:`node<class_BTEvaluateExpression_property_node>` | |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------+
| ``StringName`` | :ref:`result_var<class_BTEvaluateExpression_property_result_var>` | ``&""`` |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------+
.. rst-class:: classref-reftable-group
@ -53,9 +53,9 @@ Methods
.. table::
:widths: auto
+---------------------------------------+-------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`parse<class_BTEvaluateExpression_method_parse>` **(** **)** |
+---------------------------------------+-------------------------------------------------------------------+
+---------------------------------------+-------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`parse<class_BTEvaluateExpression_method_parse>`\ (\ ) |
+---------------------------------------+-------------------------------------------------------------+
.. rst-class:: classref-section-separator
@ -70,12 +70,12 @@ Property Descriptions
.. rst-class:: classref-property
String **expression_string** = ``""``
``String`` **expression_string** = ``""`` :ref:`🔗<class_BTEvaluateExpression_property_expression_string>`
.. rst-class:: classref-property-setget
- void **set_expression_string** **(** String value **)**
- String **get_expression_string** **(** **)**
- |void| **set_expression_string**\ (\ value\: ``String``\ )
- ``String`` **get_expression_string**\ (\ )
The expression string to be parsed and executed.
@ -89,12 +89,12 @@ The expression string to be parsed and executed.
.. rst-class:: classref-property
bool **input_include_delta** = ``false``
``bool`` **input_include_delta** = ``false`` :ref:`🔗<class_BTEvaluateExpression_property_input_include_delta>`
.. rst-class:: classref-property-setget
- void **set_input_include_delta** **(** bool value **)**
- bool **is_input_delta_included** **(** **)**
- |void| **set_input_include_delta**\ (\ value\: ``bool``\ )
- ``bool`` **is_input_delta_included**\ (\ )
If enabled, the input variable ``delta`` will be added to :ref:`input_names<class_BTEvaluateExpression_property_input_names>` and :ref:`input_values<class_BTEvaluateExpression_property_input_values>`.
@ -108,17 +108,19 @@ If enabled, the input variable ``delta`` will be added to :ref:`input_names<clas
.. rst-class:: classref-property
PackedStringArray **input_names** = ``PackedStringArray()``
``PackedStringArray`` **input_names** = ``PackedStringArray()`` :ref:`🔗<class_BTEvaluateExpression_property_input_names>`
.. rst-class:: classref-property-setget
- void **set_input_names** **(** PackedStringArray value **)**
- PackedStringArray **get_input_names** **(** **)**
- |void| **set_input_names**\ (\ value\: ``PackedStringArray``\ )
- ``PackedStringArray`` **get_input_names**\ (\ )
List of variable names within :ref:`expression_string<class_BTEvaluateExpression_property_expression_string>` for which the user will provide values for through :ref:`input_values<class_BTEvaluateExpression_property_input_values>`.
\ **Warning:** Call :ref:`parse<class_BTEvaluateExpression_method_parse>` after updating :ref:`input_names<class_BTEvaluateExpression_property_input_names>` to update the internal ``Expression`` as it won't be updated automatically.
**Note:** The returned array is *copied* and any changes to it will not update the original property value. See ``PackedStringArray`` for more details.
.. rst-class:: classref-item-separator
----
@ -127,12 +129,12 @@ List of variable names within :ref:`expression_string<class_BTEvaluateExpression
.. rst-class:: classref-property
:ref:`BBVariant[]<class_BBVariant>` **input_values** = ``[]``
:ref:`Array<class_Array>`\[:ref:`BBVariant<class_BBVariant>`\] **input_values** = ``[]`` :ref:`🔗<class_BTEvaluateExpression_property_input_values>`
.. rst-class:: classref-property-setget
- void **set_input_values** **(** :ref:`BBVariant[]<class_BBVariant>` value **)**
- :ref:`BBVariant[]<class_BBVariant>` **get_input_values** **(** **)**
- |void| **set_input_values**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`BBVariant<class_BBVariant>`\]\ )
- :ref:`Array<class_Array>`\[:ref:`BBVariant<class_BBVariant>`\] **get_input_values**\ (\ )
List of values for variables specified in :ref:`input_names<class_BTEvaluateExpression_property_input_names>`. The values are mapped to the variables by their array index.
@ -144,12 +146,12 @@ List of values for variables specified in :ref:`input_names<class_BTEvaluateExpr
.. rst-class:: classref-property
:ref:`BBNode<class_BBNode>` **node**
:ref:`BBNode<class_BBNode>` **node** :ref:`🔗<class_BTEvaluateExpression_property_node>`
.. rst-class:: classref-property-setget
- void **set_node_param** **(** :ref:`BBNode<class_BBNode>` value **)**
- :ref:`BBNode<class_BBNode>` **get_node_param** **(** **)**
- |void| **set_node_param**\ (\ value\: :ref:`BBNode<class_BBNode>`\ )
- :ref:`BBNode<class_BBNode>` **get_node_param**\ (\ )
Specifies the ``Node`` or ``Object`` instance containing the method to be called.
@ -161,12 +163,12 @@ Specifies the ``Node`` or ``Object`` instance containing the method to be called
.. rst-class:: classref-property
StringName **result_var** = ``&""``
``StringName`` **result_var** = ``&""`` :ref:`🔗<class_BTEvaluateExpression_property_result_var>`
.. rst-class:: classref-property-setget
- void **set_result_var** **(** StringName value **)**
- StringName **get_result_var** **(** **)**
- |void| **set_result_var**\ (\ value\: ``StringName``\ )
- ``StringName`` **get_result_var**\ (\ )
if non-empty, assign the result of the method call to the blackboard variable specified by this property.
@ -183,7 +185,7 @@ Method Descriptions
.. rst-class:: classref-method
:ref:`Error<enum_@GlobalScope_Error>` **parse** **(** **)**
:ref:`Error<enum_@GlobalScope_Error>` **parse**\ (\ ) :ref:`🔗<class_BTEvaluateExpression_method_parse>`
Calls :ref:`Expression.parse<class_Expression_method_parse>` considering :ref:`input_include_delta<class_BTEvaluateExpression_property_input_include_delta>` and :ref:`input_names<class_BTEvaluateExpression_property_input_names>` and returns its error code.
@ -194,3 +196,4 @@ Calls :ref:`Expression.parse<class_Expression_method_parse>` considering :ref:`i
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_btfail.rst
View File

@ -2,8 +2,8 @@
.. 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/BTFail.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTFail.xml.
.. _class_BTFail:
@ -21,3 +21,4 @@ BT action that always returns ``FAILURE``.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

27
doc/source/classes/class_btforeach.rst
View File

@ -2,8 +2,8 @@
.. 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/BTForEach.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTForEach.xml.
.. _class_BTForEach:
@ -35,11 +35,11 @@ Properties
.. table::
:widths: auto
+------------+------------------------------------------------------+---------+
| StringName | :ref:`array_var<class_BTForEach_property_array_var>` | ``&""`` |
+------------+------------------------------------------------------+---------+
| StringName | :ref:`save_var<class_BTForEach_property_save_var>` | ``&""`` |
+------------+------------------------------------------------------+---------+
+----------------+------------------------------------------------------+---------+
| ``StringName`` | :ref:`array_var<class_BTForEach_property_array_var>` | ``&""`` |
+----------------+------------------------------------------------------+---------+
| ``StringName`` | :ref:`save_var<class_BTForEach_property_save_var>` | ``&""`` |
+----------------+------------------------------------------------------+---------+
.. rst-class:: classref-section-separator
@ -54,12 +54,12 @@ Property Descriptions
.. rst-class:: classref-property
StringName **array_var** = ``&""``
``StringName`` **array_var** = ``&""`` :ref:`🔗<class_BTForEach_property_array_var>`
.. rst-class:: classref-property-setget
- void **set_array_var** **(** StringName value **)**
- StringName **get_array_var** **(** **)**
- |void| **set_array_var**\ (\ value\: ``StringName``\ )
- ``StringName`` **get_array_var**\ (\ )
A variable within the :ref:`Blackboard<class_Blackboard>` that holds an ``Array``, which is used for the iteration process.
@ -71,12 +71,12 @@ A variable within the :ref:`Blackboard<class_Blackboard>` that holds an ``Array`
.. rst-class:: classref-property
StringName **save_var** = ``&""``
``StringName`` **save_var** = ``&""`` :ref:`🔗<class_BTForEach_property_save_var>`
.. rst-class:: classref-property-setget
- void **set_save_var** **(** StringName value **)**
- StringName **get_save_var** **(** **)**
- |void| **set_save_var**\ (\ value\: ``StringName``\ )
- ``StringName`` **get_save_var**\ (\ )
A :ref:`Blackboard<class_Blackboard>` variable used to store an element of the array referenced by :ref:`array_var<class_BTForEach_property_array_var>`.
@ -87,3 +87,4 @@ A :ref:`Blackboard<class_Blackboard>` variable used to store an element of the a
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_btinvert.rst
View File

@ -2,8 +2,8 @@
.. 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/BTInvert.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTInvert.xml.
.. _class_BTInvert:
@ -28,3 +28,4 @@ BTInvert transforms ``FAILURE`` into ``SUCCESS`` and ``SUCCESS`` into ``FAILURE`
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

11
doc/source/classes/class_btnewscope.rst
View File

@ -2,8 +2,8 @@
.. 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/BTNewScope.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTNewScope.xml.
.. _class_BTNewScope:
@ -50,12 +50,12 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`BlackboardPlan<class_BlackboardPlan>` **blackboard_plan**
:ref:`BlackboardPlan<class_BlackboardPlan>` **blackboard_plan** :ref:`🔗<class_BTNewScope_property_blackboard_plan>`
.. rst-class:: classref-property-setget
- void **set_blackboard_plan** **(** :ref:`BlackboardPlan<class_BlackboardPlan>` value **)**
- :ref:`BlackboardPlan<class_BlackboardPlan>` **get_blackboard_plan** **(** **)**
- |void| **set_blackboard_plan**\ (\ value\: :ref:`BlackboardPlan<class_BlackboardPlan>`\ )
- :ref:`BlackboardPlan<class_BlackboardPlan>` **get_blackboard_plan**\ (\ )
Stores and manages variables that will be used in constructing new :ref:`Blackboard<class_Blackboard>` instances.
@ -66,3 +66,4 @@ Stores and manages variables that will be used in constructing new :ref:`Blackbo
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

37
doc/source/classes/class_btparallel.rst
View File

@ -2,8 +2,8 @@
.. 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/BTParallel.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTParallel.xml.
.. _class_BTParallel:
@ -37,13 +37,13 @@ Properties
.. table::
:widths: auto
+------+---------------------------------------------------------------------------------+-----------+
| int | :ref:`num_failures_required<class_BTParallel_property_num_failures_required>` | ``1`` |
+------+---------------------------------------------------------------------------------+-----------+
| int | :ref:`num_successes_required<class_BTParallel_property_num_successes_required>` | ``1`` |
+------+---------------------------------------------------------------------------------+-----------+
| bool | :ref:`repeat<class_BTParallel_property_repeat>` | ``false`` |
+------+---------------------------------------------------------------------------------+-----------+
+----------+---------------------------------------------------------------------------------+-----------+
| ``int`` | :ref:`num_failures_required<class_BTParallel_property_num_failures_required>` | ``1`` |
+----------+---------------------------------------------------------------------------------+-----------+
| ``int`` | :ref:`num_successes_required<class_BTParallel_property_num_successes_required>` | ``1`` |
+----------+---------------------------------------------------------------------------------+-----------+
| ``bool`` | :ref:`repeat<class_BTParallel_property_repeat>` | ``false`` |
+----------+---------------------------------------------------------------------------------+-----------+
.. rst-class:: classref-section-separator
@ -58,12 +58,12 @@ Property Descriptions
.. rst-class:: classref-property
int **num_failures_required** = ``1``
``int`` **num_failures_required** = ``1`` :ref:`🔗<class_BTParallel_property_num_failures_required>`
.. rst-class:: classref-property-setget
- void **set_num_failures_required** **(** int value **)**
- int **get_num_failures_required** **(** **)**
- |void| **set_num_failures_required**\ (\ value\: ``int``\ )
- ``int`` **get_num_failures_required**\ (\ )
If the specified number of child tasks return ``SUCCESS``, BTParallel will also return ``SUCCESS``.
@ -75,12 +75,12 @@ If the specified number of child tasks return ``SUCCESS``, BTParallel will also
.. rst-class:: classref-property
int **num_successes_required** = ``1``
``int`` **num_successes_required** = ``1`` :ref:`🔗<class_BTParallel_property_num_successes_required>`
.. rst-class:: classref-property-setget
- void **set_num_successes_required** **(** int value **)**
- int **get_num_successes_required** **(** **)**
- |void| **set_num_successes_required**\ (\ value\: ``int``\ )
- ``int`` **get_num_successes_required**\ (\ )
If the specified number of child tasks return ``FAILURE``, BTParallel will also return ``FAILURE``.
@ -92,12 +92,12 @@ If the specified number of child tasks return ``FAILURE``, BTParallel will also
.. rst-class:: classref-property
bool **repeat** = ``false``
``bool`` **repeat** = ``false`` :ref:`🔗<class_BTParallel_property_repeat>`
.. rst-class:: classref-property-setget
- void **set_repeat** **(** bool value **)**
- bool **get_repeat** **(** **)**
- |void| **set_repeat**\ (\ value\: ``bool``\ )
- ``bool`` **get_repeat**\ (\ )
When ``true``, the child tasks will be executed again, regardless of whether they previously resulted in a ``SUCCESS`` or ``FAILURE``.
@ -110,3 +110,4 @@ When ``false``, if none of the criteria were met, and all child tasks resulted i
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

11
doc/source/classes/class_btpauseanimation.rst
View File

@ -2,8 +2,8 @@
.. 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/BTPauseAnimation.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTPauseAnimation.xml.
.. _class_BTPauseAnimation:
@ -48,12 +48,12 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`BBNode<class_BBNode>` **animation_player**
:ref:`BBNode<class_BBNode>` **animation_player** :ref:`🔗<class_BTPauseAnimation_property_animation_player>`
.. rst-class:: classref-property-setget
- void **set_animation_player** **(** :ref:`BBNode<class_BBNode>` value **)**
- :ref:`BBNode<class_BBNode>` **get_animation_player** **(** **)**
- |void| **set_animation_player**\ (\ value\: :ref:`BBNode<class_BBNode>`\ )
- :ref:`BBNode<class_BBNode>` **get_animation_player**\ (\ )
Parameter that specifies the ``AnimationPlayer`` node.
@ -64,3 +64,4 @@ Parameter that specifies the ``AnimationPlayer`` node.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

51
doc/source/classes/class_btplayanimation.rst
View File

@ -2,8 +2,8 @@
.. 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/BTPlayAnimation.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTPlayAnimation.xml.
.. _class_BTPlayAnimation:
@ -36,17 +36,17 @@ Properties
:widths: auto
+-----------------------------+--------------------------------------------------------------------------+-----------+
| StringName | :ref:`animation_name<class_BTPlayAnimation_property_animation_name>` | ``&""`` |
| ``StringName`` | :ref:`animation_name<class_BTPlayAnimation_property_animation_name>` | ``&""`` |
+-----------------------------+--------------------------------------------------------------------------+-----------+
| :ref:`BBNode<class_BBNode>` | :ref:`animation_player<class_BTPlayAnimation_property_animation_player>` | |
+-----------------------------+--------------------------------------------------------------------------+-----------+
| float | :ref:`await_completion<class_BTPlayAnimation_property_await_completion>` | ``0.0`` |
| ``float`` | :ref:`await_completion<class_BTPlayAnimation_property_await_completion>` | ``0.0`` |
+-----------------------------+--------------------------------------------------------------------------+-----------+
| float | :ref:`blend<class_BTPlayAnimation_property_blend>` | ``-1.0`` |
| ``float`` | :ref:`blend<class_BTPlayAnimation_property_blend>` | ``-1.0`` |
+-----------------------------+--------------------------------------------------------------------------+-----------+
| bool | :ref:`from_end<class_BTPlayAnimation_property_from_end>` | ``false`` |
| ``bool`` | :ref:`from_end<class_BTPlayAnimation_property_from_end>` | ``false`` |
+-----------------------------+--------------------------------------------------------------------------+-----------+
| float | :ref:`speed<class_BTPlayAnimation_property_speed>` | ``1.0`` |
| ``float`` | :ref:`speed<class_BTPlayAnimation_property_speed>` | ``1.0`` |
+-----------------------------+--------------------------------------------------------------------------+-----------+
.. rst-class:: classref-section-separator
@ -62,12 +62,12 @@ Property Descriptions
.. rst-class:: classref-property
StringName **animation_name** = ``&""``
``StringName`` **animation_name** = ``&""`` :ref:`🔗<class_BTPlayAnimation_property_animation_name>`
.. rst-class:: classref-property-setget
- void **set_animation_name** **(** StringName value **)**
- StringName **get_animation_name** **(** **)**
- |void| **set_animation_name**\ (\ value\: ``StringName``\ )
- ``StringName`` **get_animation_name**\ (\ )
Animation's key within the ``AnimationPlayer`` node. If empty, BTPlayAnimation will resume the last played animation if the ``AnimationPlayer`` was previously paused.
@ -79,12 +79,12 @@ Animation's key within the ``AnimationPlayer`` node. If empty, BTPlayAnimation w
.. rst-class:: classref-property
:ref:`BBNode<class_BBNode>` **animation_player**
:ref:`BBNode<class_BBNode>` **animation_player** :ref:`🔗<class_BTPlayAnimation_property_animation_player>`
.. rst-class:: classref-property-setget
- void **set_animation_player** **(** :ref:`BBNode<class_BBNode>` value **)**
- :ref:`BBNode<class_BBNode>` **get_animation_player** **(** **)**
- |void| **set_animation_player**\ (\ value\: :ref:`BBNode<class_BBNode>`\ )
- :ref:`BBNode<class_BBNode>` **get_animation_player**\ (\ )
Parameter that specifies the ``AnimationPlayer`` node.
@ -96,12 +96,12 @@ Parameter that specifies the ``AnimationPlayer`` node.
.. rst-class:: classref-property
float **await_completion** = ``0.0``
``float`` **await_completion** = ``0.0`` :ref:`🔗<class_BTPlayAnimation_property_await_completion>`
.. rst-class:: classref-property-setget
- void **set_await_completion** **(** float value **)**
- float **get_await_completion** **(** **)**
- |void| **set_await_completion**\ (\ value\: ``float``\ )
- ``float`` **get_await_completion**\ (\ )
The maximum duration to wait for the animation to complete (in seconds). If the animation doesn't finish within this time, BTAwaitAnimation will return ``FAILURE``. If set to ``0``, BTPlayAnimation doesn't wait for the animation to finish and immediately returns ``SUCCESS``.
@ -113,12 +113,12 @@ The maximum duration to wait for the animation to complete (in seconds). If the
.. rst-class:: classref-property
float **blend** = ``-1.0``
``float`` **blend** = ``-1.0`` :ref:`🔗<class_BTPlayAnimation_property_blend>`
.. rst-class:: classref-property-setget
- void **set_blend** **(** float value **)**
- float **get_blend** **(** **)**
- |void| **set_blend**\ (\ value\: ``float``\ )
- ``float`` **get_blend**\ (\ )
Custom blend time (in seconds). See :ref:`AnimationPlayer.play<class_AnimationPlayer_method_play>`.
@ -130,12 +130,12 @@ Custom blend time (in seconds). See :ref:`AnimationPlayer.play<class_AnimationPl
.. rst-class:: classref-property
bool **from_end** = ``false``
``bool`` **from_end** = ``false`` :ref:`🔗<class_BTPlayAnimation_property_from_end>`
.. rst-class:: classref-property-setget
- void **set_from_end** **(** bool value **)**
- bool **get_from_end** **(** **)**
- |void| **set_from_end**\ (\ value\: ``bool``\ )
- ``bool`` **get_from_end**\ (\ )
Play animation from the end. Used in combination with negative :ref:`speed<class_BTPlayAnimation_property_speed>` to play animation in reverse. See :ref:`AnimationPlayer.play<class_AnimationPlayer_method_play>`.
@ -147,12 +147,12 @@ Play animation from the end. Used in combination with negative :ref:`speed<class
.. rst-class:: classref-property
float **speed** = ``1.0``
``float`` **speed** = ``1.0`` :ref:`🔗<class_BTPlayAnimation_property_speed>`
.. rst-class:: classref-property-setget
- void **set_speed** **(** float value **)**
- float **get_speed** **(** **)**
- |void| **set_speed**\ (\ value\: ``float``\ )
- ``float`` **get_speed**\ (\ )
Custom playback speed scaling ratio. See :ref:`AnimationPlayer.play<class_AnimationPlayer_method_play>`.
@ -163,3 +163,4 @@ Custom playback speed scaling ratio. See :ref:`AnimationPlayer.play<class_Animat
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

81
doc/source/classes/class_btplayer.rst
View File

@ -2,8 +2,8 @@
.. 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/BTPlayer.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTPlayer.xml.
.. _class_BTPlayer:
@ -32,9 +32,9 @@ Properties
:widths: auto
+---------------------------------------------+-------------------------------------------------------------------------+--------------------+
| bool | :ref:`active<class_BTPlayer_property_active>` | ``true`` |
| ``bool`` | :ref:`active<class_BTPlayer_property_active>` | ``true`` |
+---------------------------------------------+-------------------------------------------------------------------------+--------------------+
| NodePath | :ref:`agent_node<class_BTPlayer_property_agent_node>` | ``NodePath("..")`` |
| ``NodePath`` | :ref:`agent_node<class_BTPlayer_property_agent_node>` | ``NodePath("..")`` |
+---------------------------------------------+-------------------------------------------------------------------------+--------------------+
| :ref:`BehaviorTree<class_BehaviorTree>` | :ref:`behavior_tree<class_BTPlayer_property_behavior_tree>` | |
+---------------------------------------------+-------------------------------------------------------------------------+--------------------+
@ -42,7 +42,7 @@ Properties
+---------------------------------------------+-------------------------------------------------------------------------+--------------------+
| :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`` |
+---------------------------------------------+-------------------------------------------------------------------------+--------------------+
| :ref:`UpdateMode<enum_BTPlayer_UpdateMode>` | :ref:`update_mode<class_BTPlayer_property_update_mode>` | ``1`` |
+---------------------------------------------+-------------------------------------------------------------------------+--------------------+
@ -55,15 +55,15 @@ Methods
.. table::
:widths: auto
+-----------------------------+-----------------------------------------------------------------------------------+
| int | :ref:`get_last_status<class_BTPlayer_method_get_last_status>` **(** **)** |const| |
+-----------------------------+-----------------------------------------------------------------------------------+
| :ref:`BTTask<class_BTTask>` | :ref:`get_tree_instance<class_BTPlayer_method_get_tree_instance>` **(** **)** |
+-----------------------------+-----------------------------------------------------------------------------------+
| void | :ref:`restart<class_BTPlayer_method_restart>` **(** **)** |
+-----------------------------+-----------------------------------------------------------------------------------+
| void | :ref:`update<class_BTPlayer_method_update>` **(** float delta **)** |
+-----------------------------+-----------------------------------------------------------------------------------+
+-----------------------------+-----------------------------------------------------------------------------+
| ``int`` | :ref:`get_last_status<class_BTPlayer_method_get_last_status>`\ (\ ) |const| |
+-----------------------------+-----------------------------------------------------------------------------+
| :ref:`BTTask<class_BTTask>` | :ref:`get_tree_instance<class_BTPlayer_method_get_tree_instance>`\ (\ ) |
+-----------------------------+-----------------------------------------------------------------------------+
| |void| | :ref:`restart<class_BTPlayer_method_restart>`\ (\ ) |
+-----------------------------+-----------------------------------------------------------------------------+
| |void| | :ref:`update<class_BTPlayer_method_update>`\ (\ delta\: ``float``\ ) |
+-----------------------------+-----------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@ -78,7 +78,7 @@ Signals
.. rst-class:: classref-signal
**behavior_tree_finished** **(** int status **)**
**behavior_tree_finished**\ (\ status\: ``int``\ ) :ref:`🔗<class_BTPlayer_signal_behavior_tree_finished>`
Emitted when the behavior tree has finished executing and returned ``SUCCESS`` or ``FAILURE``.
@ -92,7 +92,7 @@ Argument ``status`` holds the status returned by the behavior tree. See :ref:`St
.. rst-class:: classref-signal
**updated** **(** int status **)**
**updated**\ (\ status\: ``int``\ ) :ref:`🔗<class_BTPlayer_signal_updated>`
Emitted when BTPlayer has finished the behavior tree update.
@ -111,7 +111,7 @@ Enumerations
.. rst-class:: classref-enumeration
enum **UpdateMode**:
enum **UpdateMode**: :ref:`🔗<enum_BTPlayer_UpdateMode>`
.. _class_BTPlayer_constant_IDLE:
@ -150,12 +150,12 @@ Property Descriptions
.. rst-class:: classref-property
bool **active** = ``true``
``bool`` **active** = ``true`` :ref:`🔗<class_BTPlayer_property_active>`
.. rst-class:: classref-property-setget
- void **set_active** **(** bool value **)**
- bool **get_active** **(** **)**
- |void| **set_active**\ (\ value\: ``bool``\ )
- ``bool`` **get_active**\ (\ )
If ``true``, the behavior tree will be executed during update.
@ -167,12 +167,12 @@ If ``true``, the behavior tree will be executed during update.
.. rst-class:: classref-property
NodePath **agent_node** = ``NodePath("..")``
``NodePath`` **agent_node** = ``NodePath("..")`` :ref:`🔗<class_BTPlayer_property_agent_node>`
.. rst-class:: classref-property-setget
- void **set_agent_node** **(** NodePath value **)**
- NodePath **get_agent_node** **(** **)**
- |void| **set_agent_node**\ (\ value\: ``NodePath``\ )
- ``NodePath`` **get_agent_node**\ (\ )
Path to the node that will be used as the agent. Setting it after instantiation will have no effect.
@ -184,12 +184,12 @@ Path to the node that will be used as the agent. Setting it after instantiation
.. rst-class:: classref-property
:ref:`BehaviorTree<class_BehaviorTree>` **behavior_tree**
:ref:`BehaviorTree<class_BehaviorTree>` **behavior_tree** :ref:`🔗<class_BTPlayer_property_behavior_tree>`
.. rst-class:: classref-property-setget
- void **set_behavior_tree** **(** :ref:`BehaviorTree<class_BehaviorTree>` value **)**
- :ref:`BehaviorTree<class_BehaviorTree>` **get_behavior_tree** **(** **)**
- |void| **set_behavior_tree**\ (\ value\: :ref:`BehaviorTree<class_BehaviorTree>`\ )
- :ref:`BehaviorTree<class_BehaviorTree>` **get_behavior_tree**\ (\ )
:ref:`BehaviorTree<class_BehaviorTree>` resource to instantiate and execute at runtime.
@ -201,12 +201,12 @@ Path to the node that will be used as the agent. Setting it after instantiation
.. rst-class:: classref-property
:ref:`Blackboard<class_Blackboard>` **blackboard**
:ref:`Blackboard<class_Blackboard>` **blackboard** :ref:`🔗<class_BTPlayer_property_blackboard>`
.. rst-class:: classref-property-setget
- void **set_blackboard** **(** :ref:`Blackboard<class_Blackboard>` value **)**
- :ref:`Blackboard<class_Blackboard>` **get_blackboard** **(** **)**
- |void| **set_blackboard**\ (\ value\: :ref:`Blackboard<class_Blackboard>`\ )
- :ref:`Blackboard<class_Blackboard>` **get_blackboard**\ (\ )
Holds data shared by the behavior tree tasks. See :ref:`Blackboard<class_Blackboard>`.
@ -218,12 +218,12 @@ Holds data shared by the behavior tree tasks. See :ref:`Blackboard<class_Blackbo
.. rst-class:: classref-property
:ref:`BlackboardPlan<class_BlackboardPlan>` **blackboard_plan**
:ref:`BlackboardPlan<class_BlackboardPlan>` **blackboard_plan** :ref:`🔗<class_BTPlayer_property_blackboard_plan>`
.. rst-class:: classref-property-setget
- void **set_blackboard_plan** **(** :ref:`BlackboardPlan<class_BlackboardPlan>` value **)**
- :ref:`BlackboardPlan<class_BlackboardPlan>` **get_blackboard_plan** **(** **)**
- |void| **set_blackboard_plan**\ (\ value\: :ref:`BlackboardPlan<class_BlackboardPlan>`\ )
- :ref:`BlackboardPlan<class_BlackboardPlan>` **get_blackboard_plan**\ (\ )
Stores and manages variables that will be used in constructing new :ref:`Blackboard<class_Blackboard>` instances.
@ -235,7 +235,7 @@ Stores and manages variables that will be used in constructing new :ref:`Blackbo
.. rst-class:: classref-property
bool **monitor_performance** = ``false``
``bool`` **monitor_performance** = ``false`` :ref:`🔗<class_BTPlayer_property_monitor_performance>`
If ``true``, adds a performance monitor to "Debugger->Monitors" for each instance of this **BTPlayer** node.
@ -247,12 +247,12 @@ If ``true``, adds a performance monitor to "Debugger->Monitors" for each instanc
.. rst-class:: classref-property
:ref:`UpdateMode<enum_BTPlayer_UpdateMode>` **update_mode** = ``1``
:ref:`UpdateMode<enum_BTPlayer_UpdateMode>` **update_mode** = ``1`` :ref:`🔗<class_BTPlayer_property_update_mode>`
.. rst-class:: classref-property-setget
- void **set_update_mode** **(** :ref:`UpdateMode<enum_BTPlayer_UpdateMode>` value **)**
- :ref:`UpdateMode<enum_BTPlayer_UpdateMode>` **get_update_mode** **(** **)**
- |void| **set_update_mode**\ (\ value\: :ref:`UpdateMode<enum_BTPlayer_UpdateMode>`\ )
- :ref:`UpdateMode<enum_BTPlayer_UpdateMode>` **get_update_mode**\ (\ )
Determines when the behavior tree is executed. See :ref:`UpdateMode<enum_BTPlayer_UpdateMode>`.
@ -269,7 +269,7 @@ Method Descriptions
.. rst-class:: classref-method
int **get_last_status** **(** **)** |const|
``int`` **get_last_status**\ (\ ) |const| :ref:`🔗<class_BTPlayer_method_get_last_status>`
Returns the behavior tree's last execution status. See :ref:`Status<enum_BT_Status>`.
@ -281,7 +281,7 @@ Returns the behavior tree's last execution status. See :ref:`Status<enum_BT_Stat
.. rst-class:: classref-method
:ref:`BTTask<class_BTTask>` **get_tree_instance** **(** **)**
:ref:`BTTask<class_BTTask>` **get_tree_instance**\ (\ ) :ref:`🔗<class_BTPlayer_method_get_tree_instance>`
Returns the root task of the instantiated behavior tree.
@ -293,7 +293,7 @@ Returns the root task of the instantiated behavior tree.
.. rst-class:: classref-method
void **restart** **(** **)**
|void| **restart**\ (\ ) :ref:`🔗<class_BTPlayer_method_restart>`
Resets the behavior tree's execution. Each running task will be aborted and the next tree execution will start anew. This method does not reset :ref:`Blackboard<class_Blackboard>`.
@ -305,7 +305,7 @@ Resets the behavior tree's execution. Each running task will be aborted and the
.. rst-class:: classref-method
void **update** **(** float delta **)**
|void| **update**\ (\ delta\: ``float``\ ) :ref:`🔗<class_BTPlayer_method_update>`
Executes the root task of the behavior tree instance if :ref:`active<class_BTPlayer_property_active>` is ``true``. Call this method when :ref:`update_mode<class_BTPlayer_property_update_mode>` is set to :ref:`MANUAL<class_BTPlayer_constant_MANUAL>`. When :ref:`update_mode<class_BTPlayer_property_update_mode>` is not :ref:`MANUAL<class_BTPlayer_constant_MANUAL>`, the :ref:`update<class_BTPlayer_method_update>` will be called automatically. See :ref:`UpdateMode<enum_BTPlayer_UpdateMode>`.
@ -316,3 +316,4 @@ Executes the root task of the behavior tree instance if :ref:`active<class_BTPla
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

17
doc/source/classes/class_btprobability.rst
View File

@ -2,8 +2,8 @@
.. 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/BTProbability.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTProbability.xml.
.. _class_BTProbability:
@ -31,9 +31,9 @@ Properties
.. table::
:widths: auto
+-------+------------------------------------------------------------+---------+
| float | :ref:`run_chance<class_BTProbability_property_run_chance>` | ``0.5`` |
+-------+------------------------------------------------------------+---------+
+-----------+------------------------------------------------------------+---------+
| ``float`` | :ref:`run_chance<class_BTProbability_property_run_chance>` | ``0.5`` |
+-----------+------------------------------------------------------------+---------+
.. rst-class:: classref-section-separator
@ -48,12 +48,12 @@ Property Descriptions
.. rst-class:: classref-property
float **run_chance** = ``0.5``
``float`` **run_chance** = ``0.5`` :ref:`🔗<class_BTProbability_property_run_chance>`
.. rst-class:: classref-property-setget
- void **set_run_chance** **(** float value **)**
- float **get_run_chance** **(** **)**
- |void| **set_run_chance**\ (\ value\: ``float``\ )
- ``float`` **get_run_chance**\ (\ )
Probability that defines how likely the child task will be executed.
@ -64,3 +64,4 @@ Probability that defines how likely the child task will be executed.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

55
doc/source/classes/class_btprobabilityselector.rst
View File

@ -2,8 +2,8 @@
.. 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/BTProbabilitySelector.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTProbabilitySelector.xml.
.. _class_BTProbabilitySelector:
@ -39,9 +39,9 @@ Properties
.. table::
:widths: auto
+------+--------------------------------------------------------------------------------+-----------+
| bool | :ref:`abort_on_failure<class_BTProbabilitySelector_property_abort_on_failure>` | ``false`` |
+------+--------------------------------------------------------------------------------+-----------+
+----------+--------------------------------------------------------------------------------+-----------+
| ``bool`` | :ref:`abort_on_failure<class_BTProbabilitySelector_property_abort_on_failure>` | ``false`` |
+----------+--------------------------------------------------------------------------------+-----------+
.. rst-class:: classref-reftable-group
@ -51,19 +51,19 @@ Methods
.. table::
:widths: auto
+-------+-------------------------------------------------------------------------------------------------------------------------+
| float | :ref:`get_probability<class_BTProbabilitySelector_method_get_probability>` **(** int child_idx **)** |const| |
+-------+-------------------------------------------------------------------------------------------------------------------------+
| float | :ref:`get_total_weight<class_BTProbabilitySelector_method_get_total_weight>` **(** **)** |const| |
+-------+-------------------------------------------------------------------------------------------------------------------------+
| float | :ref:`get_weight<class_BTProbabilitySelector_method_get_weight>` **(** int child_idx **)** |const| |
+-------+-------------------------------------------------------------------------------------------------------------------------+
| bool | :ref:`has_probability<class_BTProbabilitySelector_method_has_probability>` **(** int child_idx **)** |const| |
+-------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_probability<class_BTProbabilitySelector_method_set_probability>` **(** int child_idx, float probability **)** |
+-------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_weight<class_BTProbabilitySelector_method_set_weight>` **(** int child_idx, float weight **)** |
+-------+-------------------------------------------------------------------------------------------------------------------------+
+-----------+--------------------------------------------------------------------------------------------------------------------------------+
| ``float`` | :ref:`get_probability<class_BTProbabilitySelector_method_get_probability>`\ (\ child_idx\: ``int``\ ) |const| |
+-----------+--------------------------------------------------------------------------------------------------------------------------------+
| ``float`` | :ref:`get_total_weight<class_BTProbabilitySelector_method_get_total_weight>`\ (\ ) |const| |
+-----------+--------------------------------------------------------------------------------------------------------------------------------+
| ``float`` | :ref:`get_weight<class_BTProbabilitySelector_method_get_weight>`\ (\ child_idx\: ``int``\ ) |const| |
+-----------+--------------------------------------------------------------------------------------------------------------------------------+
| ``bool`` | :ref:`has_probability<class_BTProbabilitySelector_method_has_probability>`\ (\ child_idx\: ``int``\ ) |const| |
+-----------+--------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_probability<class_BTProbabilitySelector_method_set_probability>`\ (\ child_idx\: ``int``, probability\: ``float``\ ) |
+-----------+--------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_weight<class_BTProbabilitySelector_method_set_weight>`\ (\ child_idx\: ``int``, weight\: ``float``\ ) |
+-----------+--------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@ -78,12 +78,12 @@ Property Descriptions
.. rst-class:: classref-property
bool **abort_on_failure** = ``false``
``bool`` **abort_on_failure** = ``false`` :ref:`🔗<class_BTProbabilitySelector_property_abort_on_failure>`
.. rst-class:: classref-property-setget
- void **set_abort_on_failure** **(** bool value **)**
- bool **get_abort_on_failure** **(** **)**
- |void| **set_abort_on_failure**\ (\ value\: ``bool``\ )
- ``bool`` **get_abort_on_failure**\ (\ )
If ``true``, BTProbabilitySelector will not choose another child to execute and will return ``FAILURE`` when a child task results in ``FAILURE``.
@ -100,7 +100,7 @@ Method Descriptions
.. rst-class:: classref-method
float **get_probability** **(** int child_idx **)** |const|
``float`` **get_probability**\ (\ child_idx\: ``int``\ ) |const| :ref:`🔗<class_BTProbabilitySelector_method_get_probability>`
Returns the child task's selection probability.
@ -112,7 +112,7 @@ Returns the child task's selection probability.
.. rst-class:: classref-method
float **get_total_weight** **(** **)** |const|
``float`` **get_total_weight**\ (\ ) |const| :ref:`🔗<class_BTProbabilitySelector_method_get_total_weight>`
Returns the total weight of all child tasks.
@ -124,7 +124,7 @@ Returns the total weight of all child tasks.
.. rst-class:: classref-method
float **get_weight** **(** int child_idx **)** |const|
``float`` **get_weight**\ (\ child_idx\: ``int``\ ) |const| :ref:`🔗<class_BTProbabilitySelector_method_get_weight>`
Returns the child task's weight within the weighted probability selection algorithm.
@ -136,7 +136,7 @@ Returns the child task's weight within the weighted probability selection algori
.. rst-class:: classref-method
bool **has_probability** **(** int child_idx **)** |const|
``bool`` **has_probability**\ (\ child_idx\: ``int``\ ) |const| :ref:`🔗<class_BTProbabilitySelector_method_has_probability>`
Returns whether the child task at index ``child_idx`` participates within the weighted probability selection algorithm and has a probability assigned to it. Returns ``false`` for :ref:`BTComment<class_BTComment>` tasks.
@ -148,7 +148,7 @@ Returns whether the child task at index ``child_idx`` participates within the we
.. rst-class:: classref-method
void **set_probability** **(** int child_idx, float probability **)**
|void| **set_probability**\ (\ child_idx\: ``int``, probability\: ``float``\ ) :ref:`🔗<class_BTProbabilitySelector_method_set_probability>`
Sets the child task's weight calculated based on the desired probability.
@ -160,7 +160,7 @@ Sets the child task's weight calculated based on the desired probability.
.. rst-class:: classref-method
void **set_weight** **(** int child_idx, float weight **)**
|void| **set_weight**\ (\ child_idx\: ``int``, weight\: ``float``\ ) :ref:`🔗<class_BTProbabilitySelector_method_set_weight>`
Sets the child task's weight for the weighted probability selection algorithm.
@ -171,3 +171,4 @@ Sets the child task's weight for the weighted probability selection algorithm.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_btrandomselector.rst
View File

@ -2,8 +2,8 @@
.. 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/BTRandomSelector.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTRandomSelector.xml.
.. _class_BTRandomSelector:
@ -34,3 +34,4 @@ Returns ``SUCCESS`` if a child task results in ``SUCCESS``.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_btrandomsequence.rst
View File

@ -2,8 +2,8 @@
.. 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/BTRandomSequence.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTRandomSequence.xml.
.. _class_BTRandomSequence:
@ -34,3 +34,4 @@ Returns ``SUCCESS`` if all child tasks result in ``SUCCESS``.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

27
doc/source/classes/class_btrandomwait.rst
View File

@ -2,8 +2,8 @@
.. 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/BTRandomWait.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTRandomWait.xml.
.. _class_BTRandomWait:
@ -29,11 +29,11 @@ Properties
.. table::
:widths: auto
+-------+---------------------------------------------------------------+---------+
| float | :ref:`max_duration<class_BTRandomWait_property_max_duration>` | ``2.0`` |
+-------+---------------------------------------------------------------+---------+
| float | :ref:`min_duration<class_BTRandomWait_property_min_duration>` | ``1.0`` |
+-------+---------------------------------------------------------------+---------+
+-----------+---------------------------------------------------------------+---------+
| ``float`` | :ref:`max_duration<class_BTRandomWait_property_max_duration>` | ``2.0`` |
+-----------+---------------------------------------------------------------+---------+
| ``float`` | :ref:`min_duration<class_BTRandomWait_property_min_duration>` | ``1.0`` |
+-----------+---------------------------------------------------------------+---------+
.. rst-class:: classref-section-separator
@ -48,12 +48,12 @@ Property Descriptions
.. rst-class:: classref-property
float **max_duration** = ``2.0``
``float`` **max_duration** = ``2.0`` :ref:`🔗<class_BTRandomWait_property_max_duration>`
.. rst-class:: classref-property-setget
- void **set_max_duration** **(** float value **)**
- float **get_max_duration** **(** **)**
- |void| **set_max_duration**\ (\ value\: ``float``\ )
- ``float`` **get_max_duration**\ (\ )
Maximum duration for the wait.
@ -65,12 +65,12 @@ Maximum duration for the wait.
.. rst-class:: classref-property
float **min_duration** = ``1.0``
``float`` **min_duration** = ``1.0`` :ref:`🔗<class_BTRandomWait_property_min_duration>`
.. rst-class:: classref-property-setget
- void **set_min_duration** **(** float value **)**
- float **get_min_duration** **(** **)**
- |void| **set_min_duration**\ (\ value\: ``float``\ )
- ``float`` **get_min_duration**\ (\ )
Minimum duration for the wait.
@ -81,3 +81,4 @@ Minimum duration for the wait.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

37
doc/source/classes/class_btrepeat.rst
View File

@ -2,8 +2,8 @@
.. 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/BTRepeat.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTRepeat.xml.
.. _class_BTRepeat:
@ -35,13 +35,13 @@ Properties
.. table::
:widths: auto
+------+-------------------------------------------------------------------+-----------+
| bool | :ref:`abort_on_failure<class_BTRepeat_property_abort_on_failure>` | ``false`` |
+------+-------------------------------------------------------------------+-----------+
| bool | :ref:`forever<class_BTRepeat_property_forever>` | ``false`` |
+------+-------------------------------------------------------------------+-----------+
| int | :ref:`times<class_BTRepeat_property_times>` | ``1`` |
+------+-------------------------------------------------------------------+-----------+
+----------+-------------------------------------------------------------------+-----------+
| ``bool`` | :ref:`abort_on_failure<class_BTRepeat_property_abort_on_failure>` | ``false`` |
+----------+-------------------------------------------------------------------+-----------+
| ``bool`` | :ref:`forever<class_BTRepeat_property_forever>` | ``false`` |
+----------+-------------------------------------------------------------------+-----------+
| ``int`` | :ref:`times<class_BTRepeat_property_times>` | ``1`` |
+----------+-------------------------------------------------------------------+-----------+
.. rst-class:: classref-section-separator
@ -56,12 +56,12 @@ Property Descriptions
.. rst-class:: classref-property
bool **abort_on_failure** = ``false``
``bool`` **abort_on_failure** = ``false`` :ref:`🔗<class_BTRepeat_property_abort_on_failure>`
.. rst-class:: classref-property-setget
- void **set_abort_on_failure** **(** bool value **)**
- bool **get_abort_on_failure** **(** **)**
- |void| **set_abort_on_failure**\ (\ value\: ``bool``\ )
- ``bool`` **get_abort_on_failure**\ (\ )
If ``false``, ``FAILURE`` status returned by the child task is also considered as a successful execution.
@ -73,12 +73,12 @@ If ``false``, ``FAILURE`` status returned by the child task is also considered a
.. rst-class:: classref-property
bool **forever** = ``false``
``bool`` **forever** = ``false`` :ref:`🔗<class_BTRepeat_property_forever>`
.. rst-class:: classref-property-setget
- void **set_forever** **(** bool value **)**
- bool **get_forever** **(** **)**
- |void| **set_forever**\ (\ value\: ``bool``\ )
- ``bool`` **get_forever**\ (\ )
If ``true``, the child's execution will be repeated indefinitely, always returning ``RUNNING``.
@ -90,12 +90,12 @@ If ``true``, the child's execution will be repeated indefinitely, always returni
.. rst-class:: classref-property
int **times** = ``1``
``int`` **times** = ``1`` :ref:`🔗<class_BTRepeat_property_times>`
.. rst-class:: classref-property-setget
- void **set_times** **(** int value **)**
- int **get_times** **(** **)**
- |void| **set_times**\ (\ value\: ``int``\ )
- ``int`` **get_times**\ (\ )
The number of times to repeat execution of the child task.
@ -106,3 +106,4 @@ The number of times to repeat execution of the child task.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_btrepeatuntilfailure.rst
View File

@ -2,8 +2,8 @@
.. 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/BTRepeatUntilFailure.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTRepeatUntilFailure.xml.
.. _class_BTRepeatUntilFailure:
@ -32,3 +32,4 @@ Returns ``SUCCESS`` if the child task results in ``FAILURE``.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_btrepeatuntilsuccess.rst
View File

@ -2,8 +2,8 @@
.. 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/BTRepeatUntilSuccess.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTRepeatUntilSuccess.xml.
.. _class_BTRepeatUntilSuccess:
@ -32,3 +32,4 @@ Returns ``SUCCESS`` if the child task results in ``SUCCESS``.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

21
doc/source/classes/class_btrunlimit.rst
View File

@ -2,8 +2,8 @@
.. 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/BTRunLimit.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTRunLimit.xml.
.. _class_BTRunLimit:
@ -34,7 +34,7 @@ Properties
+-------------------------------------------------+-------------------------------------------------------------+-------+
| :ref:`CountPolicy<enum_BTRunLimit_CountPolicy>` | :ref:`count_policy<class_BTRunLimit_property_count_policy>` | ``0`` |
+-------------------------------------------------+-------------------------------------------------------------+-------+
| int | :ref:`run_limit<class_BTRunLimit_property_run_limit>` | ``1`` |
| ``int`` | :ref:`run_limit<class_BTRunLimit_property_run_limit>` | ``1`` |
+-------------------------------------------------+-------------------------------------------------------------+-------+
.. rst-class:: classref-section-separator
@ -50,7 +50,7 @@ Enumerations
.. rst-class:: classref-enumeration
enum **CountPolicy**:
enum **CountPolicy**: :ref:`🔗<enum_BTRunLimit_CountPolicy>`
.. _class_BTRunLimit_constant_COUNT_SUCCESSFUL:
@ -89,12 +89,12 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`CountPolicy<enum_BTRunLimit_CountPolicy>` **count_policy** = ``0``
:ref:`CountPolicy<enum_BTRunLimit_CountPolicy>` **count_policy** = ``0`` :ref:`🔗<class_BTRunLimit_property_count_policy>`
.. rst-class:: classref-property-setget
- void **set_count_policy** **(** :ref:`CountPolicy<enum_BTRunLimit_CountPolicy>` value **)**
- :ref:`CountPolicy<enum_BTRunLimit_CountPolicy>` **get_count_policy** **(** **)**
- |void| **set_count_policy**\ (\ value\: :ref:`CountPolicy<enum_BTRunLimit_CountPolicy>`\ )
- :ref:`CountPolicy<enum_BTRunLimit_CountPolicy>` **get_count_policy**\ (\ )
Which runs should be counted towards the limit: successful, failed, or all?
@ -106,12 +106,12 @@ Which runs should be counted towards the limit: successful, failed, or all?
.. rst-class:: classref-property
int **run_limit** = ``1``
``int`` **run_limit** = ``1`` :ref:`🔗<class_BTRunLimit_property_run_limit>`
.. rst-class:: classref-property-setget
- void **set_run_limit** **(** int value **)**
- int **get_run_limit** **(** **)**
- |void| **set_run_limit**\ (\ value\: ``int``\ )
- ``int`` **get_run_limit**\ (\ )
The maximum number of times the child is permitted to be executed.
@ -122,3 +122,4 @@ The maximum number of times the child is permitted to be executed.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_btselector.rst
View File

@ -2,8 +2,8 @@
.. 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/BTSelector.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTSelector.xml.
.. _class_BTSelector:
@ -34,3 +34,4 @@ Returns ``FAILURE`` if all child tasks result in ``FAILURE``.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

5
doc/source/classes/class_btsequence.rst
View File

@ -2,8 +2,8 @@
.. 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/BTSequence.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTSequence.xml.
.. _class_BTSequence:
@ -34,3 +34,4 @@ Returns ``FAILURE`` if a child task results in ``FAILURE``.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

25
doc/source/classes/class_btsetagentproperty.rst
View File

@ -2,8 +2,8 @@
.. 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/BTSetAgentProperty.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTSetAgentProperty.xml.
.. _class_BTSetAgentProperty:
@ -34,7 +34,7 @@ Properties
+-----------------------------------------------+---------------------------------------------------------------+---------+
| :ref:`Operation<enum_LimboUtility_Operation>` | :ref:`operation<class_BTSetAgentProperty_property_operation>` | ``0`` |
+-----------------------------------------------+---------------------------------------------------------------+---------+
| StringName | :ref:`property<class_BTSetAgentProperty_property_property>` | ``&""`` |
| ``StringName`` | :ref:`property<class_BTSetAgentProperty_property_property>` | ``&""`` |
+-----------------------------------------------+---------------------------------------------------------------+---------+
| :ref:`BBVariant<class_BBVariant>` | :ref:`value<class_BTSetAgentProperty_property_value>` | |
+-----------------------------------------------+---------------------------------------------------------------+---------+
@ -52,12 +52,12 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`Operation<enum_LimboUtility_Operation>` **operation** = ``0``
:ref:`Operation<enum_LimboUtility_Operation>` **operation** = ``0`` :ref:`🔗<class_BTSetAgentProperty_property_operation>`
.. rst-class:: classref-property-setget
- void **set_operation** **(** :ref:`Operation<enum_LimboUtility_Operation>` value **)**
- :ref:`Operation<enum_LimboUtility_Operation>` **get_operation** **(** **)**
- |void| **set_operation**\ (\ value\: :ref:`Operation<enum_LimboUtility_Operation>`\ )
- :ref:`Operation<enum_LimboUtility_Operation>` **get_operation**\ (\ )
Specifies the operation to be performed before assignment. Operation is executed as follows:
@ -71,12 +71,12 @@ Specifies the operation to be performed before assignment. Operation is executed
.. rst-class:: classref-property
StringName **property** = ``&""``
``StringName`` **property** = ``&""`` :ref:`🔗<class_BTSetAgentProperty_property_property>`
.. rst-class:: classref-property-setget
- void **set_property** **(** StringName value **)**
- StringName **get_property** **(** **)**
- |void| **set_property**\ (\ value\: ``StringName``\ )
- ``StringName`` **get_property**\ (\ )
Parameter that specifies the agent's property name.
@ -88,12 +88,12 @@ Parameter that specifies the agent's property name.
.. rst-class:: classref-property
:ref:`BBVariant<class_BBVariant>` **value**
:ref:`BBVariant<class_BBVariant>` **value** :ref:`🔗<class_BTSetAgentProperty_property_value>`
.. rst-class:: classref-property-setget
- void **set_value** **(** :ref:`BBVariant<class_BBVariant>` value **)**
- :ref:`BBVariant<class_BBVariant>` **get_value** **(** **)**
- |void| **set_value**\ (\ value\: :ref:`BBVariant<class_BBVariant>`\ )
- :ref:`BBVariant<class_BBVariant>` **get_value**\ (\ )
Parameter that specifies the value that will be assigned to agent's property.
@ -104,3 +104,4 @@ Parameter that specifies the value that will be assigned to agent's property.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

25
doc/source/classes/class_btsetvar.rst
View File

@ -2,8 +2,8 @@
.. 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/BTSetVar.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTSetVar.xml.
.. _class_BTSetVar:
@ -36,7 +36,7 @@ Properties
+-----------------------------------------------+-----------------------------------------------------+---------+
| :ref:`BBVariant<class_BBVariant>` | :ref:`value<class_BTSetVar_property_value>` | |
+-----------------------------------------------+-----------------------------------------------------+---------+
| StringName | :ref:`variable<class_BTSetVar_property_variable>` | ``&""`` |
| ``StringName`` | :ref:`variable<class_BTSetVar_property_variable>` | ``&""`` |
+-----------------------------------------------+-----------------------------------------------------+---------+
.. rst-class:: classref-section-separator
@ -52,12 +52,12 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`Operation<enum_LimboUtility_Operation>` **operation** = ``0``
:ref:`Operation<enum_LimboUtility_Operation>` **operation** = ``0`` :ref:`🔗<class_BTSetVar_property_operation>`
.. rst-class:: classref-property-setget
- void **set_operation** **(** :ref:`Operation<enum_LimboUtility_Operation>` value **)**
- :ref:`Operation<enum_LimboUtility_Operation>` **get_operation** **(** **)**
- |void| **set_operation**\ (\ value\: :ref:`Operation<enum_LimboUtility_Operation>`\ )
- :ref:`Operation<enum_LimboUtility_Operation>` **get_operation**\ (\ )
Specifies the operation to be performed before assignment. Operation is executed as follows:
@ -71,12 +71,12 @@ Specifies the operation to be performed before assignment. Operation is executed
.. rst-class:: classref-property
:ref:`BBVariant<class_BBVariant>` **value**
:ref:`BBVariant<class_BBVariant>` **value** :ref:`🔗<class_BTSetVar_property_value>`
.. rst-class:: classref-property-setget
- void **set_value** **(** :ref:`BBVariant<class_BBVariant>` value **)**
- :ref:`BBVariant<class_BBVariant>` **get_value** **(** **)**
- |void| **set_value**\ (\ value\: :ref:`BBVariant<class_BBVariant>`\ )
- :ref:`BBVariant<class_BBVariant>` **get_value**\ (\ )
Parameter that specifies the value to be assigned to the variable.
@ -88,12 +88,12 @@ Parameter that specifies the value to be assigned to the variable.
.. rst-class:: classref-property
StringName **variable** = ``&""``
``StringName`` **variable** = ``&""`` :ref:`🔗<class_BTSetVar_property_variable>`
.. rst-class:: classref-property-setget
- void **set_variable** **(** StringName value **)**
- StringName **get_variable** **(** **)**
- |void| **set_variable**\ (\ value\: ``StringName``\ )
- ``StringName`` **get_variable**\ (\ )
Name of the variable to which the value will be assigned.
@ -104,3 +104,4 @@ Name of the variable to which the value will be assigned.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

35
doc/source/classes/class_btstate.rst
View File

@ -2,8 +2,8 @@
.. 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/BTState.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTState.xml.
.. _class_BTState:
@ -32,9 +32,9 @@ Properties
+-----------------------------------------+------------------------------------------------------------+----------------+
| :ref:`BehaviorTree<class_BehaviorTree>` | :ref:`behavior_tree<class_BTState_property_behavior_tree>` | |
+-----------------------------------------+------------------------------------------------------------+----------------+
| StringName | :ref:`failure_event<class_BTState_property_failure_event>` | ``&"failure"`` |
| ``StringName`` | :ref:`failure_event<class_BTState_property_failure_event>` | ``&"failure"`` |
+-----------------------------------------+------------------------------------------------------------+----------------+
| StringName | :ref:`success_event<class_BTState_property_success_event>` | ``&"success"`` |
| ``StringName`` | :ref:`success_event<class_BTState_property_success_event>` | ``&"success"`` |
+-----------------------------------------+------------------------------------------------------------+----------------+
.. rst-class:: classref-reftable-group
@ -45,9 +45,9 @@ Methods
.. table::
:widths: auto
+-----------------------------+--------------------------------------------------------------------------------------+
| :ref:`BTTask<class_BTTask>` | :ref:`get_tree_instance<class_BTState_method_get_tree_instance>` **(** **)** |const| |
+-----------------------------+--------------------------------------------------------------------------------------+
+-----------------------------+--------------------------------------------------------------------------------+
| :ref:`BTTask<class_BTTask>` | :ref:`get_tree_instance<class_BTState_method_get_tree_instance>`\ (\ ) |const| |
+-----------------------------+--------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@ -62,12 +62,12 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`BehaviorTree<class_BehaviorTree>` **behavior_tree**
:ref:`BehaviorTree<class_BehaviorTree>` **behavior_tree** :ref:`🔗<class_BTState_property_behavior_tree>`
.. rst-class:: classref-property-setget
- void **set_behavior_tree** **(** :ref:`BehaviorTree<class_BehaviorTree>` value **)**
- :ref:`BehaviorTree<class_BehaviorTree>` **get_behavior_tree** **(** **)**
- |void| **set_behavior_tree**\ (\ value\: :ref:`BehaviorTree<class_BehaviorTree>`\ )
- :ref:`BehaviorTree<class_BehaviorTree>` **get_behavior_tree**\ (\ )
A :ref:`BehaviorTree<class_BehaviorTree>` resource that defines state behavior.
@ -79,12 +79,12 @@ A :ref:`BehaviorTree<class_BehaviorTree>` resource that defines state behavior.
.. rst-class:: classref-property
StringName **failure_event** = ``&"failure"``
``StringName`` **failure_event** = ``&"failure"`` :ref:`🔗<class_BTState_property_failure_event>`
.. rst-class:: classref-property-setget
- void **set_failure_event** **(** StringName value **)**
- StringName **get_failure_event** **(** **)**
- |void| **set_failure_event**\ (\ value\: ``StringName``\ )
- ``StringName`` **get_failure_event**\ (\ )
HSM event that will be dispatched when the behavior tree results in ``FAILURE``. See :ref:`LimboState.dispatch<class_LimboState_method_dispatch>`.
@ -96,12 +96,12 @@ HSM event that will be dispatched when the behavior tree results in ``FAILURE``.
.. rst-class:: classref-property
StringName **success_event** = ``&"success"``
``StringName`` **success_event** = ``&"success"`` :ref:`🔗<class_BTState_property_success_event>`
.. rst-class:: classref-property-setget
- void **set_success_event** **(** StringName value **)**
- StringName **get_success_event** **(** **)**
- |void| **set_success_event**\ (\ value\: ``StringName``\ )
- ``StringName`` **get_success_event**\ (\ )
HSM event that will be dispatched when the behavior tree results in ``SUCCESS``. See :ref:`LimboState.dispatch<class_LimboState_method_dispatch>`.
@ -118,7 +118,7 @@ Method Descriptions
.. rst-class:: classref-method
:ref:`BTTask<class_BTTask>` **get_tree_instance** **(** **)** |const|
:ref:`BTTask<class_BTTask>` **get_tree_instance**\ (\ ) |const| :ref:`🔗<class_BTState_method_get_tree_instance>`
Returns the root task of the instantiated behavior tree.
@ -129,3 +129,4 @@ Returns the root task of the instantiated behavior tree.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

27
doc/source/classes/class_btstopanimation.rst
View File

@ -2,8 +2,8 @@
.. 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/BTStopAnimation.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTStopAnimation.xml.
.. _class_BTStopAnimation:
@ -32,11 +32,11 @@ Properties
:widths: auto
+-----------------------------+--------------------------------------------------------------------------+-----------+
| StringName | :ref:`animation_name<class_BTStopAnimation_property_animation_name>` | ``&""`` |
| ``StringName`` | :ref:`animation_name<class_BTStopAnimation_property_animation_name>` | ``&""`` |
+-----------------------------+--------------------------------------------------------------------------+-----------+
| :ref:`BBNode<class_BBNode>` | :ref:`animation_player<class_BTStopAnimation_property_animation_player>` | |
+-----------------------------+--------------------------------------------------------------------------+-----------+
| bool | :ref:`keep_state<class_BTStopAnimation_property_keep_state>` | ``false`` |
| ``bool`` | :ref:`keep_state<class_BTStopAnimation_property_keep_state>` | ``false`` |
+-----------------------------+--------------------------------------------------------------------------+-----------+
.. rst-class:: classref-section-separator
@ -52,12 +52,12 @@ Property Descriptions
.. rst-class:: classref-property
StringName **animation_name** = ``&""``
``StringName`` **animation_name** = ``&""`` :ref:`🔗<class_BTStopAnimation_property_animation_name>`
.. rst-class:: classref-property-setget
- void **set_animation_name** **(** StringName value **)**
- StringName **get_animation_name** **(** **)**
- |void| **set_animation_name**\ (\ value\: ``StringName``\ )
- ``StringName`` **get_animation_name**\ (\ )
Animation's key within the ``AnimationPlayer`` node. If not empty, BTStopAnimation will only stop the playback if the specified animation is currently playing.
@ -69,12 +69,12 @@ Animation's key within the ``AnimationPlayer`` node. If not empty, BTStopAnimati
.. rst-class:: classref-property
:ref:`BBNode<class_BBNode>` **animation_player**
:ref:`BBNode<class_BBNode>` **animation_player** :ref:`🔗<class_BTStopAnimation_property_animation_player>`
.. rst-class:: classref-property-setget
- void **set_animation_player** **(** :ref:`BBNode<class_BBNode>` value **)**
- :ref:`BBNode<class_BBNode>` **get_animation_player** **(** **)**
- |void| **set_animation_player**\ (\ value\: :ref:`BBNode<class_BBNode>`\ )
- :ref:`BBNode<class_BBNode>` **get_animation_player**\ (\ )
Parameter that specifies the ``AnimationPlayer`` node.
@ -86,12 +86,12 @@ Parameter that specifies the ``AnimationPlayer`` node.
.. rst-class:: classref-property
bool **keep_state** = ``false``
``bool`` **keep_state** = ``false`` :ref:`🔗<class_BTStopAnimation_property_keep_state>`
.. rst-class:: classref-property-setget
- void **set_keep_state** **(** bool value **)**
- bool **get_keep_state** **(** **)**
- |void| **set_keep_state**\ (\ value\: ``bool``\ )
- ``bool`` **get_keep_state**\ (\ )
If ``true``, the animation state is not updated visually.
@ -102,3 +102,4 @@ If ``true``, the animation state is not updated visually.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

11
doc/source/classes/class_btsubtree.rst
View File

@ -2,8 +2,8 @@
.. 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/BTSubtree.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTSubtree.xml.
.. _class_BTSubtree:
@ -52,12 +52,12 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`BehaviorTree<class_BehaviorTree>` **subtree**
:ref:`BehaviorTree<class_BehaviorTree>` **subtree** :ref:`🔗<class_BTSubtree_property_subtree>`
.. rst-class:: classref-property-setget
- void **set_subtree** **(** :ref:`BehaviorTree<class_BehaviorTree>` value **)**
- :ref:`BehaviorTree<class_BehaviorTree>` **get_subtree** **(** **)**
- |void| **set_subtree**\ (\ value\: :ref:`BehaviorTree<class_BehaviorTree>`\ )
- :ref:`BehaviorTree<class_BehaviorTree>` **get_subtree**\ (\ )
A :ref:`BehaviorTree<class_BehaviorTree>` resource that will be instantiated as a subtree.
@ -68,3 +68,4 @@ A :ref:`BehaviorTree<class_BehaviorTree>` resource that will be instantiated as
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

205
doc/source/classes/class_bttask.rst
View File

@ -2,8 +2,8 @@
.. 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/BTTask.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTTask.xml.
.. _class_BTTask:
@ -38,15 +38,15 @@ Properties
:widths: auto
+-------------------------------------+---------------------------------------------------------+--------+
| Node | :ref:`agent<class_BTTask_property_agent>` | |
| ``Node`` | :ref:`agent<class_BTTask_property_agent>` | |
+-------------------------------------+---------------------------------------------------------+--------+
| :ref:`Blackboard<class_Blackboard>` | :ref:`blackboard<class_BTTask_property_blackboard>` | |
+-------------------------------------+---------------------------------------------------------+--------+
| String | :ref:`custom_name<class_BTTask_property_custom_name>` | ``""`` |
| ``String`` | :ref:`custom_name<class_BTTask_property_custom_name>` | ``""`` |
+-------------------------------------+---------------------------------------------------------+--------+
| float | :ref:`elapsed_time<class_BTTask_property_elapsed_time>` | |
| ``float`` | :ref:`elapsed_time<class_BTTask_property_elapsed_time>` | |
+-------------------------------------+---------------------------------------------------------+--------+
| Node | :ref:`scene_root<class_BTTask_property_scene_root>` | |
| ``Node`` | :ref:`scene_root<class_BTTask_property_scene_root>` | |
+-------------------------------------+---------------------------------------------------------+--------+
| :ref:`Status<enum_BT_Status>` | :ref:`status<class_BTTask_property_status>` | |
+-------------------------------------+---------------------------------------------------------+--------+
@ -59,61 +59,61 @@ Methods
.. table::
:widths: auto
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_enter<class_BTTask_private_method__enter>` **(** **)** |virtual| |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_exit<class_BTTask_private_method__exit>` **(** **)** |virtual| |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| String | :ref:`_generate_name<class_BTTask_private_method__generate_name>` **(** **)** |virtual| |const| |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| PackedStringArray | :ref:`_get_configuration_warnings<class_BTTask_private_method__get_configuration_warnings>` **(** **)** |virtual| |const| |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_setup<class_BTTask_private_method__setup>` **(** **)** |virtual| |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Status<enum_BT_Status>` | :ref:`_tick<class_BTTask_private_method__tick>` **(** float delta **)** |virtual| |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`abort<class_BTTask_method_abort>` **(** **)** |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_child<class_BTTask_method_add_child>` **(** :ref:`BTTask<class_BTTask>` task **)** |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_child_at_index<class_BTTask_method_add_child_at_index>` **(** :ref:`BTTask<class_BTTask>` task, int idx **)** |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BTTask<class_BTTask>` | :ref:`clone<class_BTTask_method_clone>` **(** **)** |const| |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BehaviorTree<class_BehaviorTree>` | :ref:`editor_get_behavior_tree<class_BTTask_method_editor_get_behavior_tree>` **(** **)** |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Status<enum_BT_Status>` | :ref:`execute<class_BTTask_method_execute>` **(** float delta **)** |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BTTask<class_BTTask>` | :ref:`get_child<class_BTTask_method_get_child>` **(** int idx **)** |const| |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| int | :ref:`get_child_count<class_BTTask_method_get_child_count>` **(** **)** |const| |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| int | :ref:`get_child_count_excluding_comments<class_BTTask_method_get_child_count_excluding_comments>` **(** **)** |const| |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| int | :ref:`get_index<class_BTTask_method_get_index>` **(** **)** |const| |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BTTask<class_BTTask>` | :ref:`get_parent<class_BTTask_method_get_parent>` **(** **)** |const| |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BTTask<class_BTTask>` | :ref:`get_root<class_BTTask_method_get_root>` **(** **)** |const| |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| String | :ref:`get_task_name<class_BTTask_method_get_task_name>` **(** **)** |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| bool | :ref:`has_child<class_BTTask_method_has_child>` **(** :ref:`BTTask<class_BTTask>` task **)** |const| |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`initialize<class_BTTask_method_initialize>` **(** Node agent, :ref:`Blackboard<class_Blackboard>` blackboard, Node scene_root **)** |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| bool | :ref:`is_descendant_of<class_BTTask_method_is_descendant_of>` **(** :ref:`BTTask<class_BTTask>` task **)** |const| |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| bool | :ref:`is_root<class_BTTask_method_is_root>` **(** **)** |const| |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BTTask<class_BTTask>` | :ref:`next_sibling<class_BTTask_method_next_sibling>` **(** **)** |const| |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`print_tree<class_BTTask_method_print_tree>` **(** int initial_tabs=0 **)** |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_child<class_BTTask_method_remove_child>` **(** :ref:`BTTask<class_BTTask>` task **)** |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_child_at_index<class_BTTask_method_remove_child_at_index>` **(** int idx **)** |
+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_enter<class_BTTask_private_method__enter>`\ (\ ) |virtual| |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_exit<class_BTTask_private_method__exit>`\ (\ ) |virtual| |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| ``String`` | :ref:`_generate_name<class_BTTask_private_method__generate_name>`\ (\ ) |virtual| |const| |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| ``PackedStringArray`` | :ref:`_get_configuration_warnings<class_BTTask_private_method__get_configuration_warnings>`\ (\ ) |virtual| |const| |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_setup<class_BTTask_private_method__setup>`\ (\ ) |virtual| |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Status<enum_BT_Status>` | :ref:`_tick<class_BTTask_private_method__tick>`\ (\ delta\: ``float``\ ) |virtual| |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`abort<class_BTTask_method_abort>`\ (\ ) |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_child<class_BTTask_method_add_child>`\ (\ task\: :ref:`BTTask<class_BTTask>`\ ) |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_child_at_index<class_BTTask_method_add_child_at_index>`\ (\ task\: :ref:`BTTask<class_BTTask>`, idx\: ``int``\ ) |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BTTask<class_BTTask>` | :ref:`clone<class_BTTask_method_clone>`\ (\ ) |const| |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BehaviorTree<class_BehaviorTree>` | :ref:`editor_get_behavior_tree<class_BTTask_method_editor_get_behavior_tree>`\ (\ ) |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Status<enum_BT_Status>` | :ref:`execute<class_BTTask_method_execute>`\ (\ delta\: ``float``\ ) |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BTTask<class_BTTask>` | :ref:`get_child<class_BTTask_method_get_child>`\ (\ idx\: ``int``\ ) |const| |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| ``int`` | :ref:`get_child_count<class_BTTask_method_get_child_count>`\ (\ ) |const| |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| ``int`` | :ref:`get_child_count_excluding_comments<class_BTTask_method_get_child_count_excluding_comments>`\ (\ ) |const| |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| ``int`` | :ref:`get_index<class_BTTask_method_get_index>`\ (\ ) |const| |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BTTask<class_BTTask>` | :ref:`get_parent<class_BTTask_method_get_parent>`\ (\ ) |const| |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BTTask<class_BTTask>` | :ref:`get_root<class_BTTask_method_get_root>`\ (\ ) |const| |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| ``String`` | :ref:`get_task_name<class_BTTask_method_get_task_name>`\ (\ ) |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| ``bool`` | :ref:`has_child<class_BTTask_method_has_child>`\ (\ task\: :ref:`BTTask<class_BTTask>`\ ) |const| |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`initialize<class_BTTask_method_initialize>`\ (\ agent\: ``Node``, blackboard\: :ref:`Blackboard<class_Blackboard>`, scene_root\: ``Node``\ ) |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| ``bool`` | :ref:`is_descendant_of<class_BTTask_method_is_descendant_of>`\ (\ task\: :ref:`BTTask<class_BTTask>`\ ) |const| |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| ``bool`` | :ref:`is_root<class_BTTask_method_is_root>`\ (\ ) |const| |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BTTask<class_BTTask>` | :ref:`next_sibling<class_BTTask_method_next_sibling>`\ (\ ) |const| |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`print_tree<class_BTTask_method_print_tree>`\ (\ initial_tabs\: ``int`` = 0\ ) |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`remove_child<class_BTTask_method_remove_child>`\ (\ task\: :ref:`BTTask<class_BTTask>`\ ) |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`remove_child_at_index<class_BTTask_method_remove_child_at_index>`\ (\ idx\: ``int``\ ) |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@ -128,12 +128,12 @@ Property Descriptions
.. rst-class:: classref-property
Node **agent**
``Node`` **agent** :ref:`🔗<class_BTTask_property_agent>`
.. rst-class:: classref-property-setget
- void **set_agent** **(** Node value **)**
- Node **get_agent** **(** **)**
- |void| **set_agent**\ (\ value\: ``Node``\ )
- ``Node`` **get_agent**\ (\ )
The agent is the contextual object for the :ref:`BehaviorTree<class_BehaviorTree>` instance. This is usually the parent of the :ref:`BTPlayer<class_BTPlayer>` node that utilizes the :ref:`BehaviorTree<class_BehaviorTree>` resource.
@ -145,11 +145,11 @@ The agent is the contextual object for the :ref:`BehaviorTree<class_BehaviorTree
.. rst-class:: classref-property
:ref:`Blackboard<class_Blackboard>` **blackboard**
:ref:`Blackboard<class_Blackboard>` **blackboard** :ref:`🔗<class_BTTask_property_blackboard>`
.. rst-class:: classref-property-setget
- :ref:`Blackboard<class_Blackboard>` **get_blackboard** **(** **)**
- :ref:`Blackboard<class_Blackboard>` **get_blackboard**\ (\ )
Provides access to the :ref:`Blackboard<class_Blackboard>`. Blackboard is used to share data among tasks of the associated :ref:`BehaviorTree<class_BehaviorTree>`.
@ -163,12 +163,12 @@ See :ref:`Blackboard<class_Blackboard>` for additional info.
.. rst-class:: classref-property
String **custom_name** = ``""``
``String`` **custom_name** = ``""`` :ref:`🔗<class_BTTask_property_custom_name>`
.. rst-class:: classref-property-setget
- void **set_custom_name** **(** String value **)**
- String **get_custom_name** **(** **)**
- |void| **set_custom_name**\ (\ value\: ``String``\ )
- ``String`` **get_custom_name**\ (\ )
User-provided name for the task. If not empty, it is used by the editor to represent the task. See :ref:`get_task_name<class_BTTask_method_get_task_name>`.
@ -180,11 +180,11 @@ User-provided name for the task. If not empty, it is used by the editor to repre
.. rst-class:: classref-property
float **elapsed_time**
``float`` **elapsed_time** :ref:`🔗<class_BTTask_property_elapsed_time>`
.. rst-class:: classref-property-setget
- float **get_elapsed_time** **(** **)**
- ``float`` **get_elapsed_time**\ (\ )
Elapsed time since the task was "entered". See :ref:`_enter<class_BTTask_private_method__enter>`.
@ -198,11 +198,11 @@ Returns ``0`` when task is not ``RUNNING``.
.. rst-class:: classref-property
Node **scene_root**
``Node`` **scene_root** :ref:`🔗<class_BTTask_property_scene_root>`
.. rst-class:: classref-property-setget
- Node **get_scene_root** **(** **)**
- ``Node`` **get_scene_root**\ (\ )
Root node of the scene the behavior tree is used in (e.g., the owner of the :ref:`BTPlayer<class_BTPlayer>` node). Can be uses to retrieve ``NodePath`` references.
@ -225,11 +225,11 @@ Root node of the scene the behavior tree is used in (e.g., the owner of the :ref
.. rst-class:: classref-property
:ref:`Status<enum_BT_Status>` **status**
:ref:`Status<enum_BT_Status>` **status** :ref:`🔗<class_BTTask_property_status>`
.. rst-class:: classref-property-setget
- :ref:`Status<enum_BT_Status>` **get_status** **(** **)**
- :ref:`Status<enum_BT_Status>` **get_status**\ (\ )
Last execution :ref:`Status<enum_BT_Status>` returned by :ref:`_tick<class_BTTask_private_method__tick>`.
@ -246,7 +246,7 @@ Method Descriptions
.. rst-class:: classref-method
void **_enter** **(** **)** |virtual|
|void| **_enter**\ (\ ) |virtual| :ref:`🔗<class_BTTask_private_method__enter>`
Called when task is "entered", i.e. when task is executed while not having a ``RUNNING`` :ref:`status<class_BTTask_property_status>`.
@ -260,7 +260,7 @@ It is called before :ref:`_tick<class_BTTask_private_method__tick>` in the execu
.. rst-class:: classref-method
void **_exit** **(** **)** |virtual|
|void| **_exit**\ (\ ) |virtual| :ref:`🔗<class_BTTask_private_method__exit>`
Called when task is "exited", i.e. after :ref:`_tick<class_BTTask_private_method__tick>` returns ``SUCCESS`` or ``FAILURE`` status. See also :ref:`execute<class_BTTask_method_execute>`.
@ -272,7 +272,7 @@ Called when task is "exited", i.e. after :ref:`_tick<class_BTTask_private_method
.. rst-class:: classref-method
String **_generate_name** **(** **)** |virtual| |const|
``String`` **_generate_name**\ (\ ) |virtual| |const| :ref:`🔗<class_BTTask_private_method__generate_name>`
Called to generate a display name for the task unless :ref:`custom_name<class_BTTask_property_custom_name>` is set. See :ref:`get_task_name<class_BTTask_method_get_task_name>`.
@ -284,7 +284,7 @@ Called to generate a display name for the task unless :ref:`custom_name<class_BT
.. rst-class:: classref-method
PackedStringArray **_get_configuration_warnings** **(** **)** |virtual| |const|
``PackedStringArray`` **_get_configuration_warnings**\ (\ ) |virtual| |const| :ref:`🔗<class_BTTask_private_method__get_configuration_warnings>`
The string returned by this method is shown as a warning message in the behavior tree editor. Any task script that overrides this method must include ``@tool`` annotation at the top of the file.
@ -296,7 +296,7 @@ The string returned by this method is shown as a warning message in the behavior
.. rst-class:: classref-method
void **_setup** **(** **)** |virtual|
|void| **_setup**\ (\ ) |virtual| :ref:`🔗<class_BTTask_private_method__setup>`
Called to initialize a task during initialization step. It is called only once before the task's first execution tick. This method allows you to set up any necessary state or configurations for the task before it begins executing.
@ -308,7 +308,7 @@ Called to initialize a task during initialization step. It is called only once b
.. rst-class:: classref-method
:ref:`Status<enum_BT_Status>` **_tick** **(** float delta **)** |virtual|
:ref:`Status<enum_BT_Status>` **_tick**\ (\ delta\: ``float``\ ) |virtual| :ref:`🔗<class_BTTask_private_method__tick>`
Called when task is "ticked", i.e. executed by :ref:`BTPlayer<class_BTPlayer>` or :ref:`BTState<class_BTState>` during an update.
@ -324,7 +324,7 @@ Returns execution status as defined in :ref:`Status<enum_BT_Status>`.
.. rst-class:: classref-method
void **abort** **(** **)**
|void| **abort**\ (\ ) :ref:`🔗<class_BTTask_method_abort>`
Resets the task and its children recursively. If a task is in the ``RUNNING`` state, it is exited and its status is reset to ``FRESH``.
@ -336,7 +336,7 @@ Resets the task and its children recursively. If a task is in the ``RUNNING`` st
.. rst-class:: classref-method
void **add_child** **(** :ref:`BTTask<class_BTTask>` task **)**
|void| **add_child**\ (\ task\: :ref:`BTTask<class_BTTask>`\ ) :ref:`🔗<class_BTTask_method_add_child>`
Adds a child task. The ``task`` is placed at the end of the children list.
@ -348,7 +348,7 @@ Adds a child task. The ``task`` is placed at the end of the children list.
.. rst-class:: classref-method
void **add_child_at_index** **(** :ref:`BTTask<class_BTTask>` task, int idx **)**
|void| **add_child_at_index**\ (\ task\: :ref:`BTTask<class_BTTask>`, idx\: ``int``\ ) :ref:`🔗<class_BTTask_method_add_child_at_index>`
Adds a child task. The ``task`` is placed at ``idx`` position in the children list.
@ -360,7 +360,7 @@ Adds a child task. The ``task`` is placed at ``idx`` position in the children li
.. rst-class:: classref-method
:ref:`BTTask<class_BTTask>` **clone** **(** **)** |const|
:ref:`BTTask<class_BTTask>` **clone**\ (\ ) |const| :ref:`🔗<class_BTTask_method_clone>`
Duplicates the task and its children, copying the exported members. Sub-resources are shared for efficiency, except for :ref:`BBParam<class_BBParam>` subtypes, which are always copied. Used by the editor to instantiate :ref:`BehaviorTree<class_BehaviorTree>` and copy-paste tasks.
@ -372,7 +372,7 @@ Duplicates the task and its children, copying the exported members. Sub-resource
.. rst-class:: classref-method
:ref:`BehaviorTree<class_BehaviorTree>` **editor_get_behavior_tree** **(** **)**
:ref:`BehaviorTree<class_BehaviorTree>` **editor_get_behavior_tree**\ (\ ) :ref:`🔗<class_BTTask_method_editor_get_behavior_tree>`
Returns the behavior tree that owns this task. This is only available in the editor.
@ -384,7 +384,7 @@ Returns the behavior tree that owns this task. This is only available in the edi
.. rst-class:: classref-method
:ref:`Status<enum_BT_Status>` **execute** **(** float delta **)**
:ref:`Status<enum_BT_Status>` **execute**\ (\ delta\: ``float``\ ) :ref:`🔗<class_BTTask_method_execute>`
Performs task's execution. The execution follows a specific sequence:
@ -402,7 +402,7 @@ Performs task's execution. The execution follows a specific sequence:
.. rst-class:: classref-method
:ref:`BTTask<class_BTTask>` **get_child** **(** int idx **)** |const|
:ref:`BTTask<class_BTTask>` **get_child**\ (\ idx\: ``int``\ ) |const| :ref:`🔗<class_BTTask_method_get_child>`
Returns a child task by specifying its index.
@ -414,7 +414,7 @@ Returns a child task by specifying its index.
.. rst-class:: classref-method
int **get_child_count** **(** **)** |const|
``int`` **get_child_count**\ (\ ) |const| :ref:`🔗<class_BTTask_method_get_child_count>`
Returns the number of child tasks.
@ -426,7 +426,7 @@ Returns the number of child tasks.
.. rst-class:: classref-method
int **get_child_count_excluding_comments** **(** **)** |const|
``int`` **get_child_count_excluding_comments**\ (\ ) |const| :ref:`🔗<class_BTTask_method_get_child_count_excluding_comments>`
Returns the number of child tasks not counting :ref:`BTComment<class_BTComment>` tasks.
@ -438,7 +438,7 @@ Returns the number of child tasks not counting :ref:`BTComment<class_BTComment>`
.. rst-class:: classref-method
int **get_index** **(** **)** |const|
``int`` **get_index**\ (\ ) |const| :ref:`🔗<class_BTTask_method_get_index>`
Returns the task's position in the behavior tree branch. Returns ``-1`` if the task doesn't belong to a task tree, i.e. doesn't have a parent.
@ -450,7 +450,7 @@ Returns the task's position in the behavior tree branch. Returns ``-1`` if the t
.. rst-class:: classref-method
:ref:`BTTask<class_BTTask>` **get_parent** **(** **)** |const|
:ref:`BTTask<class_BTTask>` **get_parent**\ (\ ) |const| :ref:`🔗<class_BTTask_method_get_parent>`
Returns the task's parent.
@ -462,7 +462,7 @@ Returns the task's parent.
.. rst-class:: classref-method
:ref:`BTTask<class_BTTask>` **get_root** **(** **)** |const|
:ref:`BTTask<class_BTTask>` **get_root**\ (\ ) |const| :ref:`🔗<class_BTTask_method_get_root>`
Returns the root task of the behavior tree.
@ -474,7 +474,7 @@ Returns the root task of the behavior tree.
.. rst-class:: classref-method
String **get_task_name** **(** **)**
``String`` **get_task_name**\ (\ ) :ref:`🔗<class_BTTask_method_get_task_name>`
The string returned by this method is used to represent the task in the editor.
@ -488,7 +488,7 @@ Method :ref:`_generate_name<class_BTTask_private_method__generate_name>` is call
.. rst-class:: classref-method
bool **has_child** **(** :ref:`BTTask<class_BTTask>` task **)** |const|
``bool`` **has_child**\ (\ task\: :ref:`BTTask<class_BTTask>`\ ) |const| :ref:`🔗<class_BTTask_method_has_child>`
Returns ``true`` if ``task`` is a child of this task.
@ -500,7 +500,7 @@ Returns ``true`` if ``task`` is a child of this task.
.. rst-class:: classref-method
void **initialize** **(** Node agent, :ref:`Blackboard<class_Blackboard>` blackboard, Node scene_root **)**
|void| **initialize**\ (\ agent\: ``Node``, blackboard\: :ref:`Blackboard<class_Blackboard>`, scene_root\: ``Node``\ ) :ref:`🔗<class_BTTask_method_initialize>`
Initilizes the task. Assigns :ref:`agent<class_BTTask_property_agent>` and :ref:`blackboard<class_BTTask_property_blackboard>`, and calls :ref:`_setup<class_BTTask_private_method__setup>` for the task and its children.
@ -514,7 +514,7 @@ The method is called recursively for each child task. ``scene_root`` should be t
.. rst-class:: classref-method
bool **is_descendant_of** **(** :ref:`BTTask<class_BTTask>` task **)** |const|
``bool`` **is_descendant_of**\ (\ task\: :ref:`BTTask<class_BTTask>`\ ) |const| :ref:`🔗<class_BTTask_method_is_descendant_of>`
Returns ``true`` if this task is a descendant of ``task``. In other words, this task must be a child of ``task`` or one of its children or grandchildren.
@ -526,7 +526,7 @@ Returns ``true`` if this task is a descendant of ``task``. In other words, this
.. rst-class:: classref-method
bool **is_root** **(** **)** |const|
``bool`` **is_root**\ (\ ) |const| :ref:`🔗<class_BTTask_method_is_root>`
Returns ``true`` if this task is the root task of its behavior tree. A behavior tree can have only one root task.
@ -538,7 +538,7 @@ Returns ``true`` if this task is the root task of its behavior tree. A behavior
.. rst-class:: classref-method
:ref:`BTTask<class_BTTask>` **next_sibling** **(** **)** |const|
:ref:`BTTask<class_BTTask>` **next_sibling**\ (\ ) |const| :ref:`🔗<class_BTTask_method_next_sibling>`
Returns the next task after this task in the parent's children list.
@ -552,7 +552,7 @@ Returns ``null`` if this task has no parent or it is the last child in the paren
.. rst-class:: classref-method
void **print_tree** **(** int initial_tabs=0 **)**
|void| **print_tree**\ (\ initial_tabs\: ``int`` = 0\ ) :ref:`🔗<class_BTTask_method_print_tree>`
Prints the subtree that starts with this task to the console.
@ -564,7 +564,7 @@ Prints the subtree that starts with this task to the console.
.. rst-class:: classref-method
void **remove_child** **(** :ref:`BTTask<class_BTTask>` task **)**
|void| **remove_child**\ (\ task\: :ref:`BTTask<class_BTTask>`\ ) :ref:`🔗<class_BTTask_method_remove_child>`
Removes ``task`` from children.
@ -576,7 +576,7 @@ Removes ``task`` from children.
.. rst-class:: classref-method
void **remove_child_at_index** **(** int idx **)**
|void| **remove_child_at_index**\ (\ idx\: ``int``\ ) :ref:`🔗<class_BTTask_method_remove_child_at_index>`
Removes a child task at a specified index from children.
@ -587,3 +587,4 @@ Removes a child task at a specified index from children.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

17
doc/source/classes/class_bttimelimit.rst
View File

@ -2,8 +2,8 @@
.. 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/BTTimeLimit.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTTimeLimit.xml.
.. _class_BTTimeLimit:
@ -31,9 +31,9 @@ Properties
.. table::
:widths: auto
+-------+----------------------------------------------------------+---------+
| float | :ref:`time_limit<class_BTTimeLimit_property_time_limit>` | ``5.0`` |
+-------+----------------------------------------------------------+---------+
+-----------+----------------------------------------------------------+---------+
| ``float`` | :ref:`time_limit<class_BTTimeLimit_property_time_limit>` | ``5.0`` |
+-----------+----------------------------------------------------------+---------+
.. rst-class:: classref-section-separator
@ -48,12 +48,12 @@ Property Descriptions
.. rst-class:: classref-property
float **time_limit** = ``5.0``
``float`` **time_limit** = ``5.0`` :ref:`🔗<class_BTTimeLimit_property_time_limit>`
.. rst-class:: classref-property-setget
- void **set_time_limit** **(** float value **)**
- float **get_time_limit** **(** **)**
- |void| **set_time_limit**\ (\ value\: ``float``\ )
- ``float`` **get_time_limit**\ (\ )
Time allocated for the child task's execution.
@ -64,3 +64,4 @@ Time allocated for the child task's execution.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

17
doc/source/classes/class_btwait.rst
View File

@ -2,8 +2,8 @@
.. 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/BTWait.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTWait.xml.
.. _class_BTWait:
@ -22,9 +22,9 @@ Properties
.. table::
:widths: auto
+-------+-------------------------------------------------+---------+
| float | :ref:`duration<class_BTWait_property_duration>` | ``1.0`` |
+-------+-------------------------------------------------+---------+
+-----------+-------------------------------------------------+---------+
| ``float`` | :ref:`duration<class_BTWait_property_duration>` | ``1.0`` |
+-----------+-------------------------------------------------+---------+
.. rst-class:: classref-section-separator
@ -39,12 +39,12 @@ Property Descriptions
.. rst-class:: classref-property
float **duration** = ``1.0``
``float`` **duration** = ``1.0`` :ref:`🔗<class_BTWait_property_duration>`
.. rst-class:: classref-property-setget
- void **set_duration** **(** float value **)**
- float **get_duration** **(** **)**
- |void| **set_duration**\ (\ value\: ``float``\ )
- ``float`` **get_duration**\ (\ )
.. container:: contribute
@ -57,3 +57,4 @@ float **duration** = ``1.0``
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

17
doc/source/classes/class_btwaitticks.rst
View File

@ -2,8 +2,8 @@
.. 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/BTWaitTicks.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTWaitTicks.xml.
.. _class_BTWaitTicks:
@ -22,9 +22,9 @@ Properties
.. table::
:widths: auto
+-----+--------------------------------------------------------+-------+
| int | :ref:`num_ticks<class_BTWaitTicks_property_num_ticks>` | ``1`` |
+-----+--------------------------------------------------------+-------+
+---------+--------------------------------------------------------+-------+
| ``int`` | :ref:`num_ticks<class_BTWaitTicks_property_num_ticks>` | ``1`` |
+---------+--------------------------------------------------------+-------+
.. rst-class:: classref-section-separator
@ -39,12 +39,12 @@ Property Descriptions
.. rst-class:: classref-property
int **num_ticks** = ``1``
``int`` **num_ticks** = ``1`` :ref:`🔗<class_BTWaitTicks_property_num_ticks>`
.. rst-class:: classref-property-setget
- void **set_num_ticks** **(** int value **)**
- int **get_num_ticks** **(** **)**
- |void| **set_num_ticks**\ (\ value\: ``int``\ )
- ``int`` **get_num_ticks**\ (\ )
The number of ticks to wait before returning ``SUCCESS``.
@ -55,3 +55,4 @@ The number of ticks to wait before returning ``SUCCESS``.
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

83
doc/source/classes/class_limbohsm.rst
View File

@ -2,8 +2,8 @@
.. 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/LimboHSM.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/LimboHSM.xml.
.. _class_LimboHSM:
@ -45,21 +45,23 @@ Methods
.. table::
:widths: auto
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_transition<class_LimboHSM_method_add_transition>` **(** :ref:`LimboState<class_LimboState>` from_state, :ref:`LimboState<class_LimboState>` to_state, StringName event **)** |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`get_active_state<class_LimboHSM_method_get_active_state>` **(** **)** |const| |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`get_leaf_state<class_LimboHSM_method_get_leaf_state>` **(** **)** |const| |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`get_previous_active_state<class_LimboHSM_method_get_previous_active_state>` **(** **)** |const| |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`initialize<class_LimboHSM_method_initialize>` **(** Node agent, :ref:`Blackboard<class_Blackboard>` parent_scope=null **)** |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_active<class_LimboHSM_method_set_active>` **(** bool active **)** |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update<class_LimboHSM_method_update>` **(** float delta **)** |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_transition<class_LimboHSM_method_add_transition>`\ (\ from_state\: :ref:`LimboState<class_LimboState>`, to_state\: :ref:`LimboState<class_LimboState>`, event\: ``StringName``\ ) |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`get_active_state<class_LimboHSM_method_get_active_state>`\ (\ ) |const| |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`get_leaf_state<class_LimboHSM_method_get_leaf_state>`\ (\ ) |const| |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`get_previous_active_state<class_LimboHSM_method_get_previous_active_state>`\ (\ ) |const| |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`initialize<class_LimboHSM_method_initialize>`\ (\ agent\: ``Node``, parent_scope\: :ref:`Blackboard<class_Blackboard>` = null\ ) |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`remove_transition<class_LimboHSM_method_remove_transition>`\ (\ from_state\: :ref:`LimboState<class_LimboState>`, event\: ``StringName``\ ) |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_active<class_LimboHSM_method_set_active>`\ (\ active\: ``bool``\ ) |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`update<class_LimboHSM_method_update>`\ (\ delta\: ``float``\ ) |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@ -74,7 +76,7 @@ Signals
.. rst-class:: classref-signal
**active_state_changed** **(** :ref:`LimboState<class_LimboState>` current, :ref:`LimboState<class_LimboState>` previous **)**
**active_state_changed**\ (\ current\: :ref:`LimboState<class_LimboState>`, previous\: :ref:`LimboState<class_LimboState>`\ ) :ref:`🔗<class_LimboHSM_signal_active_state_changed>`
Emitted when the currently active substate is switched to a different substate.
@ -91,7 +93,7 @@ Enumerations
.. rst-class:: classref-enumeration
enum **UpdateMode**:
enum **UpdateMode**: :ref:`🔗<enum_LimboHSM_UpdateMode>`
.. _class_LimboHSM_constant_IDLE:
@ -130,11 +132,11 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`LimboState<class_LimboState>` **ANYSTATE**
:ref:`LimboState<class_LimboState>` **ANYSTATE** :ref:`🔗<class_LimboHSM_property_ANYSTATE>`
.. rst-class:: classref-property-setget
- :ref:`LimboState<class_LimboState>` **anystate** **(** **)**
- :ref:`LimboState<class_LimboState>` **anystate**\ (\ )
Useful for defining a transition from any state.
@ -146,12 +148,12 @@ Useful for defining a transition from any state.
.. rst-class:: classref-property
:ref:`LimboState<class_LimboState>` **initial_state**
:ref:`LimboState<class_LimboState>` **initial_state** :ref:`🔗<class_LimboHSM_property_initial_state>`
.. rst-class:: classref-property-setget
- void **set_initial_state** **(** :ref:`LimboState<class_LimboState>` value **)**
- :ref:`LimboState<class_LimboState>` **get_initial_state** **(** **)**
- |void| **set_initial_state**\ (\ value\: :ref:`LimboState<class_LimboState>`\ )
- :ref:`LimboState<class_LimboState>` **get_initial_state**\ (\ )
The substate that becomes active when the state machine is activated using the :ref:`set_active<class_LimboHSM_method_set_active>` method. If not explicitly set, the first child of the LimboHSM will be considered the initial state.
@ -163,12 +165,12 @@ The substate that becomes active when the state machine is activated using the :
.. rst-class:: classref-property
:ref:`UpdateMode<enum_LimboHSM_UpdateMode>` **update_mode** = ``1``
:ref:`UpdateMode<enum_LimboHSM_UpdateMode>` **update_mode** = ``1`` :ref:`🔗<class_LimboHSM_property_update_mode>`
.. rst-class:: classref-property-setget
- void **set_update_mode** **(** :ref:`UpdateMode<enum_LimboHSM_UpdateMode>` value **)**
- :ref:`UpdateMode<enum_LimboHSM_UpdateMode>` **get_update_mode** **(** **)**
- |void| **set_update_mode**\ (\ value\: :ref:`UpdateMode<enum_LimboHSM_UpdateMode>`\ )
- :ref:`UpdateMode<enum_LimboHSM_UpdateMode>` **get_update_mode**\ (\ )
Specifies when the state machine should be updated. See :ref:`UpdateMode<enum_LimboHSM_UpdateMode>`.
@ -185,7 +187,7 @@ Method Descriptions
.. rst-class:: classref-method
void **add_transition** **(** :ref:`LimboState<class_LimboState>` from_state, :ref:`LimboState<class_LimboState>` to_state, StringName event **)**
|void| **add_transition**\ (\ from_state\: :ref:`LimboState<class_LimboState>`, to_state\: :ref:`LimboState<class_LimboState>`, event\: ``StringName``\ ) :ref:`🔗<class_LimboHSM_method_add_transition>`
Establishes a transition from one state to another when ``event`` is dispatched. Both ``from_state`` and ``to_state`` must be immediate children of this state.
@ -197,7 +199,7 @@ Establishes a transition from one state to another when ``event`` is dispatched.
.. rst-class:: classref-method
:ref:`LimboState<class_LimboState>` **get_active_state** **(** **)** |const|
:ref:`LimboState<class_LimboState>` **get_active_state**\ (\ ) |const| :ref:`🔗<class_LimboHSM_method_get_active_state>`
Returns the currently active substate.
@ -209,7 +211,7 @@ Returns the currently active substate.
.. rst-class:: classref-method
:ref:`LimboState<class_LimboState>` **get_leaf_state** **(** **)** |const|
:ref:`LimboState<class_LimboState>` **get_leaf_state**\ (\ ) |const| :ref:`🔗<class_LimboHSM_method_get_leaf_state>`
Returns the currently active leaf state within the state machine.
@ -221,7 +223,7 @@ Returns the currently active leaf state within the state machine.
.. rst-class:: classref-method
:ref:`LimboState<class_LimboState>` **get_previous_active_state** **(** **)** |const|
:ref:`LimboState<class_LimboState>` **get_previous_active_state**\ (\ ) |const| :ref:`🔗<class_LimboHSM_method_get_previous_active_state>`
Returns the previously active substate.
@ -233,7 +235,7 @@ Returns the previously active substate.
.. rst-class:: classref-method
void **initialize** **(** Node agent, :ref:`Blackboard<class_Blackboard>` parent_scope=null **)**
|void| **initialize**\ (\ agent\: ``Node``, parent_scope\: :ref:`Blackboard<class_Blackboard>` = null\ ) :ref:`🔗<class_LimboHSM_method_initialize>`
Initiates the state and calls :ref:`LimboState._setup<class_LimboState_private_method__setup>` for both itself and all substates.
@ -241,11 +243,23 @@ Initiates the state and calls :ref:`LimboState._setup<class_LimboState_private_m
----
.. _class_LimboHSM_method_remove_transition:
.. rst-class:: classref-method
|void| **remove_transition**\ (\ from_state\: :ref:`LimboState<class_LimboState>`, event\: ``StringName``\ ) :ref:`🔗<class_LimboHSM_method_remove_transition>`
Removes a transition from a state associated with specific ``event``.
.. rst-class:: classref-item-separator
----
.. _class_LimboHSM_method_set_active:
.. rst-class:: classref-method
void **set_active** **(** bool active **)**
|void| **set_active**\ (\ active\: ``bool``\ ) :ref:`🔗<class_LimboHSM_method_set_active>`
When set to ``true``, switches the state to :ref:`initial_state<class_LimboHSM_property_initial_state>` and activates state processing according to :ref:`update_mode<class_LimboHSM_property_update_mode>`.
@ -257,7 +271,7 @@ When set to ``true``, switches the state to :ref:`initial_state<class_LimboHSM_p
.. rst-class:: classref-method
void **update** **(** float delta **)**
|void| **update**\ (\ delta\: ``float``\ ) :ref:`🔗<class_LimboHSM_method_update>`
Calls :ref:`LimboState._update<class_LimboState_private_method__update>` on itself and the active substate, with the call cascading down to the leaf state. This method is automatically triggered if :ref:`update_mode<class_LimboHSM_property_update_mode>` is not set to :ref:`MANUAL<class_LimboHSM_constant_MANUAL>`.
@ -268,3 +282,4 @@ Calls :ref:`LimboState._update<class_LimboState_private_method__update>` on itse
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

123
doc/source/classes/class_limbostate.rst
View File

@ -2,8 +2,8 @@
.. 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/LimboState.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/LimboState.xml.
.. _class_LimboState:
@ -36,9 +36,9 @@ Properties
:widths: auto
+---------------------------------------------+-------------------------------------------------------------------+
| StringName | :ref:`EVENT_FINISHED<class_LimboState_property_EVENT_FINISHED>` |
| ``StringName`` | :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>` |
+---------------------------------------------+-------------------------------------------------------------------+
@ -53,35 +53,35 @@ Methods
.. table::
:widths: auto
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_enter<class_LimboState_private_method__enter>` **(** **)** |virtual| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_exit<class_LimboState_private_method__exit>` **(** **)** |virtual| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_setup<class_LimboState_private_method__setup>` **(** **)** |virtual| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_update<class_LimboState_private_method__update>` **(** float delta **)** |virtual| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_event_handler<class_LimboState_method_add_event_handler>` **(** StringName event, Callable handler **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`call_on_enter<class_LimboState_method_call_on_enter>` **(** Callable callable **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`call_on_exit<class_LimboState_method_call_on_exit>` **(** Callable callable **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`call_on_update<class_LimboState_method_call_on_update>` **(** Callable callable **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_guard<class_LimboState_method_clear_guard>` **(** **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| bool | :ref:`dispatch<class_LimboState_method_dispatch>` **(** StringName event, Variant cargo=null **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`get_root<class_LimboState_method_get_root>` **(** **)** |const| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| bool | :ref:`is_active<class_LimboState_method_is_active>` **(** **)** |const| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`named<class_LimboState_method_named>` **(** String name **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_guard<class_LimboState_method_set_guard>` **(** Callable guard_callable **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_enter<class_LimboState_private_method__enter>`\ (\ ) |virtual| |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_exit<class_LimboState_private_method__exit>`\ (\ ) |virtual| |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_setup<class_LimboState_private_method__setup>`\ (\ ) |virtual| |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_update<class_LimboState_private_method__update>`\ (\ delta\: ``float``\ ) |virtual| |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_event_handler<class_LimboState_method_add_event_handler>`\ (\ event\: ``StringName``, handler\: ``Callable``\ ) |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`call_on_enter<class_LimboState_method_call_on_enter>`\ (\ callable\: ``Callable``\ ) |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`call_on_exit<class_LimboState_method_call_on_exit>`\ (\ callable\: ``Callable``\ ) |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`call_on_update<class_LimboState_method_call_on_update>`\ (\ callable\: ``Callable``\ ) |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`clear_guard<class_LimboState_method_clear_guard>`\ (\ ) |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``bool`` | :ref:`dispatch<class_LimboState_method_dispatch>`\ (\ event\: ``StringName``, cargo\: ``Variant`` = null\ ) |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`get_root<class_LimboState_method_get_root>`\ (\ ) |const| |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``bool`` | :ref:`is_active<class_LimboState_method_is_active>`\ (\ ) |const| |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`named<class_LimboState_method_named>`\ (\ name\: ``String``\ ) |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_guard<class_LimboState_method_set_guard>`\ (\ guard_callable\: ``Callable``\ ) |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@ -96,7 +96,7 @@ Signals
.. rst-class:: classref-signal
**entered** **(** **)**
**entered**\ (\ ) :ref:`🔗<class_LimboState_signal_entered>`
Emitted when the state is entered.
@ -108,7 +108,7 @@ Emitted when the state is entered.
.. rst-class:: classref-signal
**exited** **(** **)**
**exited**\ (\ ) :ref:`🔗<class_LimboState_signal_exited>`
Emitted when the state is exited.
@ -120,7 +120,7 @@ Emitted when the state is exited.
.. rst-class:: classref-signal
**setup** **(** **)**
**setup**\ (\ ) :ref:`🔗<class_LimboState_signal_setup>`
Emitted when the state is initialized.
@ -132,7 +132,7 @@ Emitted when the state is initialized.
.. rst-class:: classref-signal
**updated** **(** float delta **)**
**updated**\ (\ delta\: ``float``\ ) :ref:`🔗<class_LimboState_signal_updated>`
Emitted when the state is updated.
@ -149,11 +149,11 @@ Property Descriptions
.. rst-class:: classref-property
StringName **EVENT_FINISHED**
``StringName`` **EVENT_FINISHED** :ref:`🔗<class_LimboState_property_EVENT_FINISHED>`
.. rst-class:: classref-property-setget
- StringName **event_finished** **(** **)**
- ``StringName`` **event_finished**\ (\ )
A commonly used event that indicates that the state has finished its work.
@ -165,12 +165,12 @@ A commonly used event that indicates that the state has finished its work.
.. rst-class:: classref-property
Node **agent**
``Node`` **agent** :ref:`🔗<class_LimboState_property_agent>`
.. rst-class:: classref-property-setget
- void **set_agent** **(** Node value **)**
- Node **get_agent** **(** **)**
- |void| **set_agent**\ (\ value\: ``Node``\ )
- ``Node`` **get_agent**\ (\ )
An agent associated with the state, assigned during initialization.
@ -182,11 +182,11 @@ An agent associated with the state, assigned during initialization.
.. rst-class:: classref-property
:ref:`Blackboard<class_Blackboard>` **blackboard**
:ref:`Blackboard<class_Blackboard>` **blackboard** :ref:`🔗<class_LimboState_property_blackboard>`
.. rst-class:: classref-property-setget
- :ref:`Blackboard<class_Blackboard>` **get_blackboard** **(** **)**
- :ref:`Blackboard<class_Blackboard>` **get_blackboard**\ (\ )
A key/value data store shared by states within the state machine to which this state belongs.
@ -198,12 +198,12 @@ A key/value data store shared by states within the state machine to which this s
.. rst-class:: classref-property
:ref:`BlackboardPlan<class_BlackboardPlan>` **blackboard_plan**
:ref:`BlackboardPlan<class_BlackboardPlan>` **blackboard_plan** :ref:`🔗<class_LimboState_property_blackboard_plan>`
.. rst-class:: classref-property-setget
- void **set_blackboard_plan** **(** :ref:`BlackboardPlan<class_BlackboardPlan>` value **)**
- :ref:`BlackboardPlan<class_BlackboardPlan>` **get_blackboard_plan** **(** **)**
- |void| **set_blackboard_plan**\ (\ value\: :ref:`BlackboardPlan<class_BlackboardPlan>`\ )
- :ref:`BlackboardPlan<class_BlackboardPlan>` **get_blackboard_plan**\ (\ )
Stores and manages variables that will be used in constructing new :ref:`Blackboard<class_Blackboard>` instances.
@ -220,7 +220,7 @@ Method Descriptions
.. rst-class:: classref-method
void **_enter** **(** **)** |virtual|
|void| **_enter**\ (\ ) |virtual| :ref:`🔗<class_LimboState_private_method__enter>`
Called when the state is entered.
@ -232,7 +232,7 @@ Called when the state is entered.
.. rst-class:: classref-method
void **_exit** **(** **)** |virtual|
|void| **_exit**\ (\ ) |virtual| :ref:`🔗<class_LimboState_private_method__exit>`
Called when the state is exited.
@ -244,7 +244,7 @@ Called when the state is exited.
.. rst-class:: classref-method
void **_setup** **(** **)** |virtual|
|void| **_setup**\ (\ ) |virtual| :ref:`🔗<class_LimboState_private_method__setup>`
Called once during initialization. Use this method to initialize your state.
@ -256,7 +256,7 @@ Called once during initialization. Use this method to initialize your state.
.. rst-class:: classref-method
void **_update** **(** float delta **)** |virtual|
|void| **_update**\ (\ delta\: ``float``\ ) |virtual| :ref:`🔗<class_LimboState_private_method__update>`
Called during the update. Implement your state's behavior with this method.
@ -268,7 +268,7 @@ Called during the update. Implement your state's behavior with this method.
.. rst-class:: classref-method
void **add_event_handler** **(** StringName event, Callable handler **)**
|void| **add_event_handler**\ (\ event\: ``StringName``, handler\: ``Callable``\ ) :ref:`🔗<class_LimboState_method_add_event_handler>`
Registers a ``handler`` to be called when ``event`` is dispatched.
@ -280,7 +280,7 @@ Registers a ``handler`` to be called when ``event`` is dispatched.
.. rst-class:: classref-method
:ref:`LimboState<class_LimboState>` **call_on_enter** **(** Callable callable **)**
:ref:`LimboState<class_LimboState>` **call_on_enter**\ (\ callable\: ``Callable``\ ) :ref:`🔗<class_LimboState_method_call_on_enter>`
A chained method that connects the :ref:`entered<class_LimboState_signal_entered>` signal to a ``callable``.
@ -292,7 +292,7 @@ A chained method that connects the :ref:`entered<class_LimboState_signal_entered
.. rst-class:: classref-method
:ref:`LimboState<class_LimboState>` **call_on_exit** **(** Callable callable **)**
:ref:`LimboState<class_LimboState>` **call_on_exit**\ (\ callable\: ``Callable``\ ) :ref:`🔗<class_LimboState_method_call_on_exit>`
A chained method that connects the :ref:`exited<class_LimboState_signal_exited>` signal to a ``callable``.
@ -304,7 +304,7 @@ A chained method that connects the :ref:`exited<class_LimboState_signal_exited>`
.. rst-class:: classref-method
:ref:`LimboState<class_LimboState>` **call_on_update** **(** Callable callable **)**
:ref:`LimboState<class_LimboState>` **call_on_update**\ (\ callable\: ``Callable``\ ) :ref:`🔗<class_LimboState_method_call_on_update>`
A chained method that connects the :ref:`updated<class_LimboState_signal_updated>` signal to a ``callable``.
@ -316,7 +316,7 @@ A chained method that connects the :ref:`updated<class_LimboState_signal_updated
.. rst-class:: classref-method
void **clear_guard** **(** **)**
|void| **clear_guard**\ (\ ) :ref:`🔗<class_LimboState_method_clear_guard>`
Clears the guard function, removing the ``Callable`` previously set by :ref:`set_guard<class_LimboState_method_set_guard>`.
@ -328,7 +328,7 @@ Clears the guard function, removing the ``Callable`` previously set by :ref:`set
.. rst-class:: classref-method
bool **dispatch** **(** StringName event, Variant cargo=null **)**
``bool`` **dispatch**\ (\ event\: ``StringName``, cargo\: ``Variant`` = null\ ) :ref:`🔗<class_LimboState_method_dispatch>`
Recursively dispatches a state machine event named ``event`` with an optional argument ``cargo``. Returns ``true`` if the event was consumed.
@ -342,7 +342,7 @@ Events propagate from the leaf state to the root state, and propagation stops as
.. rst-class:: classref-method
:ref:`LimboState<class_LimboState>` **get_root** **(** **)** |const|
:ref:`LimboState<class_LimboState>` **get_root**\ (\ ) |const| :ref:`🔗<class_LimboState_method_get_root>`
Returns the root **LimboState**.
@ -354,7 +354,7 @@ Returns the root **LimboState**.
.. rst-class:: classref-method
bool **is_active** **(** **)** |const|
``bool`` **is_active**\ (\ ) |const| :ref:`🔗<class_LimboState_method_is_active>`
Returns ``true`` if it is currently active, meaning it is the active substate of the parent :ref:`LimboHSM<class_LimboHSM>`.
@ -366,7 +366,7 @@ Returns ``true`` if it is currently active, meaning it is the active substate of
.. rst-class:: classref-method
:ref:`LimboState<class_LimboState>` **named** **(** String name **)**
:ref:`LimboState<class_LimboState>` **named**\ (\ name\: ``String``\ ) :ref:`🔗<class_LimboState_method_named>`
A chained method for setting the name of this state.
@ -378,7 +378,7 @@ A chained method for setting the name of this state.
.. rst-class:: classref-method
void **set_guard** **(** Callable guard_callable **)**
|void| **set_guard**\ (\ guard_callable\: ``Callable``\ ) :ref:`🔗<class_LimboState_method_set_guard>`
Sets the guard function, which is a function called each time a transition to this state is considered. If the function returns ``false``, the transition will be disallowed.
@ -389,3 +389,4 @@ Sets the guard function, which is a function called each time a transition to th
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

59
doc/source/classes/class_limboutility.rst
View File

@ -2,8 +2,8 @@
.. 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/LimboUtility.xml.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/LimboUtility.xml.
.. _class_LimboUtility:
@ -22,23 +22,23 @@ Methods
.. table::
:widths: auto
+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| String | :ref:`decorate_output_var<class_LimboUtility_method_decorate_output_var>` **(** String variable **)** |const| |
+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| String | :ref:`decorate_var<class_LimboUtility_method_decorate_var>` **(** String variable **)** |const| |
+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| String | :ref:`get_check_operator_string<class_LimboUtility_method_get_check_operator_string>` **(** :ref:`CheckType<enum_LimboUtility_CheckType>` check **)** |const| |
+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| String | :ref:`get_operation_string<class_LimboUtility_method_get_operation_string>` **(** :ref:`Operation<enum_LimboUtility_Operation>` operation **)** |const| |
+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| String | :ref:`get_status_name<class_LimboUtility_method_get_status_name>` **(** int status **)** |const| |
+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Texture2D | :ref:`get_task_icon<class_LimboUtility_method_get_task_icon>` **(** String class_or_script_path **)** |const| |
+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| bool | :ref:`perform_check<class_LimboUtility_method_perform_check>` **(** :ref:`CheckType<enum_LimboUtility_CheckType>` check, Variant a, Variant b **)** |
+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Variant | :ref:`perform_operation<class_LimboUtility_method_perform_operation>` **(** :ref:`Operation<enum_LimboUtility_Operation>` operation, Variant a, Variant b **)** |
+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``String`` | :ref:`decorate_output_var<class_LimboUtility_method_decorate_output_var>`\ (\ variable\: ``String``\ ) |const| |
+---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``String`` | :ref:`decorate_var<class_LimboUtility_method_decorate_var>`\ (\ variable\: ``String``\ ) |const| |
+---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``String`` | :ref:`get_check_operator_string<class_LimboUtility_method_get_check_operator_string>`\ (\ check\: :ref:`CheckType<enum_LimboUtility_CheckType>`\ ) |const| |
+---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``String`` | :ref:`get_operation_string<class_LimboUtility_method_get_operation_string>`\ (\ operation\: :ref:`Operation<enum_LimboUtility_Operation>`\ ) |const| |
+---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``String`` | :ref:`get_status_name<class_LimboUtility_method_get_status_name>`\ (\ status\: ``int``\ ) |const| |
+---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``Texture2D`` | :ref:`get_task_icon<class_LimboUtility_method_get_task_icon>`\ (\ class_or_script_path\: ``String``\ ) |const| |
+---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``bool`` | :ref:`perform_check<class_LimboUtility_method_perform_check>`\ (\ check\: :ref:`CheckType<enum_LimboUtility_CheckType>`, a\: ``Variant``, b\: ``Variant``\ ) |
+---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``Variant`` | :ref:`perform_operation<class_LimboUtility_method_perform_operation>`\ (\ operation\: :ref:`Operation<enum_LimboUtility_Operation>`, a\: ``Variant``, b\: ``Variant``\ ) |
+---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@ -53,7 +53,7 @@ Enumerations
.. rst-class:: classref-enumeration
enum **CheckType**:
enum **CheckType**: :ref:`🔗<enum_LimboUtility_CheckType>`
.. _class_LimboUtility_constant_CHECK_EQUAL:
@ -111,7 +111,7 @@ Inequality Check.
.. rst-class:: classref-enumeration
enum **Operation**:
enum **Operation**: :ref:`🔗<enum_LimboUtility_Operation>`
.. _class_LimboUtility_constant_OPERATION_NONE:
@ -222,7 +222,7 @@ Method Descriptions
.. rst-class:: classref-method
String **decorate_output_var** **(** String variable **)** |const|
``String`` **decorate_output_var**\ (\ variable\: ``String``\ ) |const| :ref:`🔗<class_LimboUtility_method_decorate_output_var>`
Just like :ref:`decorate_var<class_LimboUtility_method_decorate_var>`, produces a string with a :ref:`Blackboard<class_Blackboard>` variable name that is formatted for display, and also adds an additional symbol to indicate that the variable is used as an output.
@ -234,7 +234,7 @@ Just like :ref:`decorate_var<class_LimboUtility_method_decorate_var>`, produces
.. rst-class:: classref-method
String **decorate_var** **(** String variable **)** |const|
``String`` **decorate_var**\ (\ variable\: ``String``\ ) |const| :ref:`🔗<class_LimboUtility_method_decorate_var>`
Produces a string with a :ref:`Blackboard<class_Blackboard>` variable name that is formatted for display or console output.
@ -246,7 +246,7 @@ Produces a string with a :ref:`Blackboard<class_Blackboard>` variable name that
.. rst-class:: classref-method
String **get_check_operator_string** **(** :ref:`CheckType<enum_LimboUtility_CheckType>` check **)** |const|
``String`` **get_check_operator_string**\ (\ check\: :ref:`CheckType<enum_LimboUtility_CheckType>`\ ) |const| :ref:`🔗<class_LimboUtility_method_get_check_operator_string>`
Returns an operator string for a :ref:`CheckType<enum_LimboUtility_CheckType>` enum value. For example, :ref:`CHECK_EQUAL<class_LimboUtility_constant_CHECK_EQUAL>` returns "==".
@ -258,7 +258,7 @@ Returns an operator string for a :ref:`CheckType<enum_LimboUtility_CheckType>` e
.. rst-class:: classref-method
String **get_operation_string** **(** :ref:`Operation<enum_LimboUtility_Operation>` operation **)** |const|
``String`` **get_operation_string**\ (\ operation\: :ref:`Operation<enum_LimboUtility_Operation>`\ ) |const| :ref:`🔗<class_LimboUtility_method_get_operation_string>`
Returns a string representation of an :ref:`Operation<enum_LimboUtility_Operation>` enum value.
@ -270,7 +270,7 @@ Returns a string representation of an :ref:`Operation<enum_LimboUtility_Operatio
.. rst-class:: classref-method
String **get_status_name** **(** int status **)** |const|
``String`` **get_status_name**\ (\ status\: ``int``\ ) |const| :ref:`🔗<class_LimboUtility_method_get_status_name>`
Returns a name of a :ref:`BTTask<class_BTTask>` status code.
@ -282,7 +282,7 @@ Returns a name of a :ref:`BTTask<class_BTTask>` status code.
.. rst-class:: classref-method
Texture2D **get_task_icon** **(** String class_or_script_path **)** |const|
``Texture2D`` **get_task_icon**\ (\ class_or_script_path\: ``String``\ ) |const| :ref:`🔗<class_LimboUtility_method_get_task_icon>`
Returns the icon texture associated with a task based on its class name or script resource path.
@ -294,7 +294,7 @@ Returns the icon texture associated with a task based on its class name or scrip
.. rst-class:: classref-method
bool **perform_check** **(** :ref:`CheckType<enum_LimboUtility_CheckType>` check, Variant a, Variant b **)**
``bool`` **perform_check**\ (\ check\: :ref:`CheckType<enum_LimboUtility_CheckType>`, a\: ``Variant``, b\: ``Variant``\ ) :ref:`🔗<class_LimboUtility_method_perform_check>`
Performs a ``check`` on two values, ``a`` and ``b``, and returns ``true`` if the check passes.
@ -306,7 +306,7 @@ Performs a ``check`` on two values, ``a`` and ``b``, and returns ``true`` if the
.. rst-class:: classref-method
Variant **perform_operation** **(** :ref:`Operation<enum_LimboUtility_Operation>` operation, Variant a, Variant b **)**
``Variant`` **perform_operation**\ (\ operation\: :ref:`Operation<enum_LimboUtility_Operation>`, a\: ``Variant``, b\: ``Variant``\ ) :ref:`🔗<class_LimboUtility_method_perform_operation>`
Performs an ``operation`` on two values, ``a`` and ``b``, and returns the result.
@ -317,3 +317,4 @@ Performs an ``operation`` on two values, ``a`` and ``b``, and returns the result
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`

8
doc_classes/LimboHSM.xml
View File

@ -44,6 +44,14 @@
Initiates the state and calls [method LimboState._setup] for both itself and all substates.
</description>
</method>
<method name="remove_transition">
<return type="void" />
<param index="0" name="from_state" type="LimboState" />
<param index="1" name="event" type="StringName" />
<description>
Removes a transition from a state associated with specific [param event].
</description>
</method>
<method name="set_active">
<return type="void" />
<param index="0" name="active" type="bool" />