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

Update and improve class documentation

This commit is contained in:
Serhii Snitsaruk 2023-04-10 16:57:36 +02:00
parent 348aa4f750
commit 9344bce9b1
74 changed files with 313 additions and 450 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc_classes/BBAabb.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBAabb" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBAabb" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
AABB-type parameter to be used with BT tasks. See [BBParam]. AABB-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="AABB( 0, 0, 0, 0, 0, 0 )" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="AABB(0, 0, 0, 0, 0, 0)" />
</members> </members>
<constants>
</constants>
</class> </class>

8
doc_classes/BBArray.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBArray" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBArray" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Array-type parameter to be used with BT tasks. See [BBParam]. Array-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="[ ]" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="[]" />
</members> </members>
<constants>
</constants>
</class> </class>

8
doc_classes/BBBasis.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBBasis" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBBasis" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Basis-type parameter to be used with BT tasks. See [BBParam]. Basis-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Basis( 1, 0, 0, 0, 1, 0, 0, 0, 1 )" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)" />
</members> </members>
<constants>
</constants>
</class> </class>

6
doc_classes/BBBool.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBBool" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBBool" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Bool-type parameter to be used with BT tasks. See [BBParam]. Bool-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="false" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="false" />
</members> </members>
<constants>
</constants>
</class> </class>

8
doc_classes/BBByteArray.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBByteArray" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBByteArray" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
ByteArray-type parameter to be used with BT tasks. See [BBParam]. ByteArray-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PoolByteArray( )" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PackedByteArray()" />
</members> </members>
<constants>
</constants>
</class> </class>

8
doc_classes/BBColor.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBColor" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBColor" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Color-type parameter to be used with BT tasks. See [BBParam]. Color-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Color( 0, 0, 0, 1 )" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Color(0, 0, 0, 1)" />
</members> </members>
<constants>
</constants>
</class> </class>

9
doc_classes/BBColorArray.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBColorArray" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBColorArray" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
ColorArray-type parameter to be used with BT tasks. See [BBParam]. ColorArray-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,8 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <members>
</methods> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PackedColorArray()" />
<constants> </members>
</constants>
</class> </class>

6
doc_classes/BBDictionary.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBDictionary" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBDictionary" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Dictionary-type parameter to be used with BT tasks. See [BBParam]. Dictionary-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="{}" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="{}" />
</members> </members>
<constants>
</constants>
</class> </class>

6
doc_classes/BBFloat.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBFloat" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBFloat" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Float-type parameter to be used with BT tasks. See [BBParam]. Float-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="0.0" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="0.0" />
</members> </members>
<constants>
</constants>
</class> </class>

12
doc_classes/BBFloatArray.xml Normal file
View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BBFloatArray" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PackedFloat64Array()" />
</members>
</class>

9
doc_classes/BBInt.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBInt" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBInt" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Integer-type parameter to be used with BT tasks. See [BBParam]. Integer-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,4 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="0" />
</members>
<constants>
</constants>
</class> </class>

8
doc_classes/BBIntArray.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBIntArray" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBIntArray" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
IntArray-type parameter to be used with BT tasks. See [BBParam]. IntArray-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PoolIntArray( )" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PackedInt64Array()" />
</members> </members>
<constants>
</constants>
</class> </class>

6
doc_classes/BBNode.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBNode" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBNode" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Node-type parameter to be used with BT tasks. See [BBParam]. Node-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="NodePath(&quot;&quot;)" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="NodePath(&quot;&quot;)" />
</members> </members>
<constants>
</constants>
</class> </class>

10
doc_classes/BBParam.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBParam" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBParam" inherits="Resource" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
A base class for typed parameters to be used with BT tasks. A base class for typed parameters to be used with BT tasks.
</brief_description> </brief_description>
@ -19,16 +19,16 @@
</method> </method>
<method name="get_value"> <method name="get_value">
<return type="Variant" /> <return type="Variant" />
<argument index="0" name="p_agent" type="Object" /> <param index="0" name="p_agent" type="Object" />
<argument index="1" name="p_blackboard" type="Blackboard" /> <param index="1" name="p_blackboard" type="Blackboard" />
<argument index="2" name="p_default" type="Variant" default="null" /> <param index="2" name="p_default" type="Variant" default="null" />
<description> <description>
Returns value of the parameter. Returns value of the parameter.
</description> </description>
</method> </method>
</methods> </methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" default="PoolColorArray( )"> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" default="0">
A value that is saved with BBParam resource. The type of value is defined by [method get_type]. Provides the parameter's value, if [member value_source] is [constant SAVED_VALUE]. A value that is saved with BBParam resource. The type of value is defined by [method get_type]. Provides the parameter's value, if [member value_source] is [constant SAVED_VALUE].
</member> </member>
<member name="value_source" type="int" setter="set_value_source" getter="get_value_source" enum="BBParam.ValueSource" default="0"> <member name="value_source" type="int" setter="set_value_source" getter="get_value_source" enum="BBParam.ValueSource" default="0">

8
doc_classes/BBPlane.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBPlane" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBPlane" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Plane-type parameter to be used with BT tasks. See [BBParam]. Plane-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Plane( 0, 0, 0, 0 )" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Plane(0, 0, 0, 0)" />
</members> </members>
<constants>
</constants>
</class> </class>

17
doc_classes/BBQuat.xml
View File

@ -1,17 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BBQuat" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Quat-type parameter to be used with BT tasks. See [BBParam].
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Quat( 0, 0, 0, 1 )" />
</members>
<constants>
</constants>
</class>

12
doc_classes/BBQuaternion.xml Normal file
View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BBQuaternion" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Quaternion(0, 0, 0, 1)" />
</members>
</class>

17
doc_classes/BBRealArray.xml
View File

@ -1,17 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BBRealArray" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
RealArray-type parameter to be used with BT tasks. See [BBParam].
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PoolRealArray( )" />
</members>
<constants>
</constants>
</class>

8
doc_classes/BBRect2.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBRect2" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBRect2" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Rect2-type parameter to be used with BT tasks. See [BBParam]. Rect2-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Rect2( 0, 0, 0, 0 )" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Rect2(0, 0, 0, 0)" />
</members> </members>
<constants>
</constants>
</class> </class>

12
doc_classes/BBRect2i.xml Normal file
View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BBRect2i" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Rect2i(0, 0, 0, 0)" />
</members>
</class>

6
doc_classes/BBString.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBString" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBString" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
String-type parameter to be used with BT tasks. See [BBParam]. String-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="&quot;&quot;" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="&quot;&quot;" />
</members> </members>
<constants>
</constants>
</class> </class>

8
doc_classes/BBStringArray.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBStringArray" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBStringArray" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
StringArray-type parameter to be used with BT tasks. See [BBParam]. StringArray-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PoolStringArray( )" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PackedStringArray()" />
</members> </members>
<constants>
</constants>
</class> </class>

12
doc_classes/BBStringName.xml Normal file
View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BBStringName" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="&amp;&quot;&quot;" />
</members>
</class>

17
doc_classes/BBTransform.xml
View File

@ -1,17 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BBTransform" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Transform-type parameter to be used with BT tasks. See [BBParam].
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )" />
</members>
<constants>
</constants>
</class>

8
doc_classes/BBTransform2D.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBTransform2D" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBTransform2D" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Transform2D-type parameter to be used with BT tasks. See [BBParam]. Transform2D-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Transform2D( 1, 0, 0, 1, 0, 0 )" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Transform2D(1, 0, 0, 1, 0, 0)" />
</members> </members>
<constants>
</constants>
</class> </class>

12
doc_classes/BBTransform3D.xml Normal file
View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BBTransform3D" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)" />
</members>
</class>

6
doc_classes/BBVariant.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBVariant" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBVariant" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Variant-type parameter to be used with BT tasks. See [BBParam]. Variant-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,13 +7,9 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="null" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="null" />
<member name="type" type="int" setter="set_type" getter="get_type" enum="Variant.Type" default="0"> <member name="type" type="int" setter="set_type" getter="get_type" enum="Variant.Type" default="0">
</member> </member>
</members> </members>
<constants>
</constants>
</class> </class>

8
doc_classes/BBVector2.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBVector2" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBVector2" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Vector2-type parameter to be used with BT tasks. See [BBParam]. Vector2-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Vector2( 0, 0 )" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Vector2(0, 0)" />
</members> </members>
<constants>
</constants>
</class> </class>

8
doc_classes/BBVector2Array.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBVector2Array" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBVector2Array" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Vector2Array-type parameter to be used with BT tasks. See [BBParam]. Vector2Array-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PoolVector2Array( )" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PackedVector2Array()" />
</members> </members>
<constants>
</constants>
</class> </class>

12
doc_classes/BBVector2i.xml Normal file
View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BBVector2i" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Vector2i(0, 0)" />
</members>
</class>

8
doc_classes/BBVector3.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBVector3" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBVector3" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Vector3-type parameter to be used with BT tasks. See [BBParam]. Vector3-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Vector3( 0, 0, 0 )" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Vector3(0, 0, 0)" />
</members> </members>
<constants>
</constants>
</class> </class>

8
doc_classes/BBVector3Array.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BBVector3Array" inherits="BBParam" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BBVector3Array" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Vector3Array-type parameter to be used with BT tasks. See [BBParam]. Vector3Array-type parameter to be used with BT tasks. See [BBParam].
</brief_description> </brief_description>
@ -7,11 +7,7 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PoolVector3Array( )" /> <member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PackedVector3Array()" />
</members> </members>
<constants>
</constants>
</class> </class>

12
doc_classes/BBVector3i.xml Normal file
View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BBVector3i" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Vector3i(0, 0, 0)" />
</members>
</class>

12
doc_classes/BBVector4.xml Normal file
View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BBVector4" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Vector4(0, 0, 0, 0)" />
</members>
</class>

12
doc_classes/BBVector4i.xml Normal file
View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BBVector4i" inherits="BBParam" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Vector4i(0, 0, 0, 0)" />
</members>
</class>

9
doc_classes/BTAction.xml
View File

@ -1,16 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTAction" inherits="BTTask" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTAction" inherits="BTTask" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Base class for BT actions. Base class for BT actions.
</brief_description> </brief_description>
<description> <description>
Base class for all behavior tree actions. Extend [code]BTAction[/code] to create your own actions. Base class for all behavior tree actions. Extend [code]BTAction[/code] to create your own actions.
An action performs a task in one or multiple ticks. Actions return [code]RUNNING[/code] status, when it takes more than one tick to perform a task. When a task is finished an action returns [code]SUCCESS[/code] or [code]FAILURE[/code]. Actions cannot have child tasks. Represents a specific action or behavior in a [BehaviorTree] that the agent should perform. It is the lowest level of the [BehaviorTree] hierarchy and is responsible for carrying out the actual work required to achieve a goal. Actions cannot have child tasks.
Actions performs a task in one or multiple ticks. Actions return [code]RUNNING[/code] status, when it takes more than one tick to perform a task. When a task is finished an action returns [code]SUCCESS[/code] or [code]FAILURE[/code].
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<constants>
</constants>
</class> </class>

6
doc_classes/BTAlwaysFail.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTAlwaysFail" inherits="BTDecorator" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTAlwaysFail" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT decorator that turns SUCCESS into FAILURE. BT decorator that turns SUCCESS into FAILURE.
</brief_description> </brief_description>
@ -7,8 +7,4 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<constants>
</constants>
</class> </class>

6
doc_classes/BTAlwaysSucceed.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTAlwaysSucceed" inherits="BTDecorator" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTAlwaysSucceed" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT decorator that turns FAILURE into SUCCESS. BT decorator that turns FAILURE into SUCCESS.
</brief_description> </brief_description>
@ -7,8 +7,4 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<constants>
</constants>
</class> </class>

8
doc_classes/BTComposite.xml
View File

@ -1,16 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTComposite" inherits="BTTask" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTComposite" inherits="BTTask" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Base class for BT composite tasks. Base class for BT composite tasks.
</brief_description> </brief_description>
<description> <description>
Base class for all behavior tree composite tasks. Extend [code]BTComposite[/code] to create your own. Base class for all behavior tree composite tasks. Extend [code]BTComposite[/code] to create your own.
Composite tasks can have one or more child tasks. A composite task will execute its child tasks in a certain order. Depending on the status returned by a child task, execution either continues to the next task in order or stops and a status is returned to the parent task. Composite is a control task in a [BehaviorTree] that contains one or more child tasks. It defines the structure and flow of the [BehaviorTree] by specifying how child tasks are executed. It can be used to group related tasks into a single unit, making it easier to manage and maintain the [BehaviorTree]. Examples of [BehaviorTree] composites include [BTSelector], [BTSequence], and [BTParallel].
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<constants>
</constants>
</class> </class>

11
doc_classes/BTCondition.xml
View File

@ -1,16 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTCondition" inherits="BTTask" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTCondition" inherits="BTTask" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Base class for BT conditions. Base class for BT conditions.
</brief_description> </brief_description>
<description> <description>
Base class for all behavior tree conditions. Extend [code]BTCondition[/code] to create your own conditions. Base class for all [BehaviorTree] conditions. Extend [code]BTCondition[/code] to create your own conditions.
Conditions don't take multiple ticks to finish and return [constant BTTask.SUCCESS] or [constant BTTask.FAILURE] immeditely. Condition is a task in a [BehaviorTree] that checks for a specific condition before executing subsequent tasks and often used inside composite tasks to control the execution flow. It is used to verify the state of the environment, check for the presence of an enemy, or evaluate the health status of the agent. The use of [BehaviorTree] condition tasks can improve the efficiency of the system and avoid unnecessary actions. However, it may not be suitable for complex decision-making processes, and too many condition tasks can make the [BehaviorTree] difficult to read.
Conditions usually don't take multiple ticks to finish and return [constant BTTask.SUCCESS] or [constant BTTask.FAILURE] immeditely.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<constants>
</constants>
</class> </class>

9
doc_classes/BTConsolePrint.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTConsolePrint" inherits="BTAction" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTConsolePrint" inherits="BTAction" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT action task that prints text to console. BT action task that prints text to console.
</brief_description> </brief_description>
@ -8,16 +8,11 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="format_var_args" type="PoolStringArray" setter="set_format_var_args" getter="get_format_var_args" default="PoolStringArray( )"> <member name="bb_format_parameters" type="PackedStringArray" setter="set_bb_format_parameters" getter="get_bb_format_parameters" default="PackedStringArray()">
An array with blackboard variables, values of which will serve as format arguments.
</member> </member>
<member name="text" type="String" setter="set_text" getter="get_text" default="&quot;&quot;"> <member name="text" type="String" setter="set_text" getter="get_text" default="&quot;&quot;">
Text to print. Can contain multiple placeholders to be replaced with format arguments. Same as GDScript's % operator, placeholders start with '%' followed by a format specifier. For example: %s - string, %d - integer, %f - real. Text to print. Can contain multiple placeholders to be replaced with format arguments. Same as GDScript's % operator, placeholders start with '%' followed by a format specifier. For example: %s - string, %d - integer, %f - real.
</member> </member>
</members> </members>
<constants>
</constants>
</class> </class>

6
doc_classes/BTCooldown.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTCooldown" inherits="BTDecorator" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTCooldown" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT decorator that executes child only if [member cooldown] time passed since previous execution. BT decorator that executes child only if [member cooldown] time passed since previous execution.
</brief_description> </brief_description>
@ -11,8 +11,6 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="cooldown_state_var" type="String" setter="set_cooldown_state_var" getter="get_cooldown_state_var" default="&quot;&quot;"> <member name="cooldown_state_var" type="String" setter="set_cooldown_state_var" getter="get_cooldown_state_var" default="&quot;&quot;">
Boolean variable to save cooldown state in the [Blackboard]. If empty, the variable will be automatically created and assigned. Boolean variable to save cooldown state in the [Blackboard]. If empty, the variable will be automatically created and assigned.
@ -32,6 +30,4 @@
Trigger cooldown, if the child returns [code]FAILURE[/code]. Trigger cooldown, if the child returns [code]FAILURE[/code].
</member> </member>
</members> </members>
<constants>
</constants>
</class> </class>

9
doc_classes/BTDecorator.xml
View File

@ -1,16 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTDecorator" inherits="BTTask" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTDecorator" inherits="BTTask" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Base class for BT decorators. Base class for BT decorators.
</brief_description> </brief_description>
<description> <description>
Base class for all behavior tree decorators. Extend [code]BTDecorator[/code] to create your own decorators. Base class for all behavior tree decorators. Extend [code]BTDecorator[/code] to create your own decorators.
Decorator alters the behavior of its child task in some way. Decorators can only have one child. Decorator is a task in a [BehaviorTree] that alters the behavior of its child task. Can only have a single child.
It can be used to add conditions, limits, or other constraints to the execution of a task. Examples of [BehaviorTree] decorators include [BTInvert], [BTRepeat], and [BTCooldown]. The use of [BehaviorTree] decorators can help to simplify the design and implementation of complex behaviors by adding additional logic to existing tasks.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<constants>
</constants>
</class> </class>

6
doc_classes/BTDelay.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTDelay" inherits="BTDecorator" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTDelay" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT decorator that delays execution of its child. BT decorator that delays execution of its child.
</brief_description> </brief_description>
@ -8,13 +8,9 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="seconds" type="float" setter="set_seconds" getter="get_seconds" default="1.0"> <member name="seconds" type="float" setter="set_seconds" getter="get_seconds" default="1.0">
Delay duration in seconds. Delay duration in seconds.
</member> </member>
</members> </members>
<constants>
</constants>
</class> </class>

6
doc_classes/BTDynamicSelector.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTDynamicSelector" inherits="BTComposite" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTDynamicSelector" inherits="BTComposite" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT composite that executes tasks from the beginning each tick until first [code]SUCCESS[/code]. BT composite that executes tasks from the beginning each tick until first [code]SUCCESS[/code].
</brief_description> </brief_description>
@ -11,8 +11,4 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<constants>
</constants>
</class> </class>

6
doc_classes/BTDynamicSequence.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTDynamicSequence" inherits="BTComposite" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTDynamicSequence" inherits="BTComposite" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT composite that executes tasks from the beginning each tick for as long as they return [code]SUCCESS[/code]. BT composite that executes tasks from the beginning each tick for as long as they return [code]SUCCESS[/code].
</brief_description> </brief_description>
@ -11,8 +11,4 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<constants>
</constants>
</class> </class>

6
doc_classes/BTFail.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTFail" inherits="BTAction" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTFail" inherits="BTAction" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT action that returns FAILURE. BT action that returns FAILURE.
</brief_description> </brief_description>
@ -7,8 +7,4 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<constants>
</constants>
</class> </class>

6
doc_classes/BTForEach.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTForEach" inherits="BTDecorator" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTForEach" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT decorator that executes child for each element of an [Array]. BT decorator that executes child for each element of an [Array].
</brief_description> </brief_description>
@ -8,8 +8,6 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="array_var" type="String" setter="set_array_var" getter="get_array_var" default="&quot;&quot;"> <member name="array_var" type="String" setter="set_array_var" getter="get_array_var" default="&quot;&quot;">
An [Array] stored in the [Blackboard] to iterate over. An [Array] stored in the [Blackboard] to iterate over.
@ -18,6 +16,4 @@
[Blackboard] variable to store an element of array, referenced by [member array_var]. [Blackboard] variable to store an element of array, referenced by [member array_var].
</member> </member>
</members> </members>
<constants>
</constants>
</class> </class>

6
doc_classes/BTInvert.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTInvert" inherits="BTDecorator" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTInvert" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT decorator that inverts FAILURE to SUCCESS and SUCCESS to FAILURE. BT decorator that inverts FAILURE to SUCCESS and SUCCESS to FAILURE.
</brief_description> </brief_description>
@ -7,8 +7,4 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<constants>
</constants>
</class> </class>

6
doc_classes/BTNewScope.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTNewScope" inherits="BTDecorator" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTNewScope" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT decorator that creates a new [Blackboard] scope. BT decorator that creates a new [Blackboard] scope.
</brief_description> </brief_description>
@ -9,13 +9,9 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="_blackboard_data" type="Dictionary" setter="_set_blackboard_data" getter="_get_blackboard_data" default="{}"> <member name="_blackboard_data" type="Dictionary" setter="_set_blackboard_data" getter="_get_blackboard_data" default="{}">
Data that is used to populate a new scope of the [Blackboard]. Data that is used to populate a new scope of the [Blackboard].
</member> </member>
</members> </members>
<constants>
</constants>
</class> </class>

6
doc_classes/BTParallel.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTParallel" inherits="BTComposite" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTParallel" inherits="BTComposite" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT composite that executes tasks simultaneously. BT composite that executes tasks simultaneously.
</brief_description> </brief_description>
@ -12,8 +12,6 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="num_failures_required" type="int" setter="set_num_failures_required" getter="get_num_failures_required" default="1"> <member name="num_failures_required" type="int" setter="set_num_failures_required" getter="get_num_failures_required" default="1">
</member> </member>
@ -22,6 +20,4 @@
<member name="repeat" type="bool" setter="set_repeat" getter="get_repeat" default="false"> <member name="repeat" type="bool" setter="set_repeat" getter="get_repeat" default="false">
</member> </member>
</members> </members>
<constants>
</constants>
</class> </class>

21
doc_classes/BTPlayer.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTPlayer" inherits="Node" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTPlayer" inherits="Node" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Player of [BehaviorTree] resources. Player of [BehaviorTree] resources.
</brief_description> </brief_description>
@ -9,6 +9,12 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_last_status" qualifiers="const">
<return type="int" />
<description>
Returns last execution status. See [enum BTTask.TaskStatus].
</description>
</method>
<method name="restart"> <method name="restart">
<return type="void" /> <return type="void" />
<description> <description>
@ -17,26 +23,23 @@
</method> </method>
<method name="set_blackboard"> <method name="set_blackboard">
<return type="void" /> <return type="void" />
<argument index="0" name="p_blackboard" type="Blackboard" /> <param index="0" name="p_blackboard" type="Blackboard" />
<description> <description>
Assign a [Blackboard] instance. Assign a [Blackboard] instance.
</description> </description>
</method> </method>
<method name="update"> <method name="update">
<return type="void" /> <return type="void" />
<argument index="0" name="p_delta" type="float" /> <param index="0" name="p_delta" type="float" />
<description> <description>
Updates the tree by executing the root task. Call this method when [member update_mode] is set to [constant MANUAL]. When [member update_mode] is not set to [constant MANUAL], the tree is updated automatically. See [enum UpdateMode]. Updates the tree by executing the root task. Call this method when [member update_mode] is set to [constant MANUAL]. When [member update_mode] is not set to [constant MANUAL], the tree is updated automatically. See [enum UpdateMode].
</description> </description>
</method> </method>
</methods> </methods>
<members> <members>
<member name="active" type="bool" setter="set_active" getter="get_active" default="false"> <member name="active" type="bool" setter="set_active" getter="get_active" default="true">
If [code]true[/code], tree is active and will be processed. If [code]true[/code], tree is active and will be processed.
</member> </member>
<member name="auto_restart" type="bool" setter="set_auto_restart" getter="get_auto_restart" default="false">
If [code]true[/code] player will restart when it finishes executing the tree and receives a [code]SUCCESS[/code] or [code]FAILURE[/code].
</member>
<member name="behavior_tree" type="BehaviorTree" setter="set_behavior_tree" getter="get_behavior_tree"> <member name="behavior_tree" type="BehaviorTree" setter="set_behavior_tree" getter="get_behavior_tree">
[BehaviorTree] resource to instantiate and process at run time. [BehaviorTree] resource to instantiate and process at run time.
</member> </member>
@ -46,13 +49,13 @@
<member name="prefetch_nodepath_vars" type="bool" setter="set_prefetch_nodepath_vars" getter="get_prefetch_nodepath_vars" default="true"> <member name="prefetch_nodepath_vars" type="bool" setter="set_prefetch_nodepath_vars" getter="get_prefetch_nodepath_vars" default="true">
If [code]true[/code], any NodePath variables in the [Blackboard] are replaced with references during tree instantiation. References are retrieved by calling [method Node.get_node] of BTPlayer. If [code]true[/code], any NodePath variables in the [Blackboard] are replaced with references during tree instantiation. References are retrieved by calling [method Node.get_node] of BTPlayer.
</member> </member>
<member name="update_mode" type="int" setter="set_update_mode" getter="get_update_mode" enum="BTPlayer.UpdateMode" default="0"> <member name="update_mode" type="int" setter="set_update_mode" getter="get_update_mode" enum="BTPlayer.UpdateMode" default="1">
Defines when BehaviorTree is executed. See [enum UpdateMode]. Defines when BehaviorTree is executed. See [enum UpdateMode].
</member> </member>
</members> </members>
<signals> <signals>
<signal name="behavior_tree_finished"> <signal name="behavior_tree_finished">
<argument index="0" name="p_status" type="int" /> <param index="0" name="p_status" type="int" />
<description> <description>
Notifies when behavior tree finishes executing and returns [code]SUCCESS[/code] or [code]FAILURE[/code]. Notifies when behavior tree finishes executing and returns [code]SUCCESS[/code] or [code]FAILURE[/code].
Argument [code]p_status[/code] holds the status returned by the behavior tree. Argument [code]p_status[/code] holds the status returned by the behavior tree.

6
doc_classes/BTProbability.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTProbability" inherits="BTDecorator" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTProbability" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT decorator that executes child with probability. BT decorator that executes child with probability.
</brief_description> </brief_description>
@ -8,12 +8,8 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="run_chance" type="float" setter="set_run_chance" getter="get_run_chance" default="0.5"> <member name="run_chance" type="float" setter="set_run_chance" getter="get_run_chance" default="0.5">
</member> </member>
</members> </members>
<constants>
</constants>
</class> </class>

6
doc_classes/BTRandomSelector.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTRandomSelector" inherits="BTComposite" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTRandomSelector" inherits="BTComposite" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT composite that executes tasks in random order until first [code]SUCCESS[/code]. BT composite that executes tasks in random order until first [code]SUCCESS[/code].
</brief_description> </brief_description>
@ -11,8 +11,4 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<constants>
</constants>
</class> </class>

6
doc_classes/BTRandomSequence.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTRandomSequence" inherits="BTComposite" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTRandomSequence" inherits="BTComposite" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT composite that executes tasks in random order for as long as they return [code]SUCCESS[/code]. BT composite that executes tasks in random order for as long as they return [code]SUCCESS[/code].
</brief_description> </brief_description>
@ -11,8 +11,4 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<constants>
</constants>
</class> </class>

14
doc_classes/BTRandomWait.xml
View File

@ -1,19 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTRandomWait" inherits="BTAction" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTRandomWait" inherits="BTAction" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT action that waits for a randomized duration to pass and returns [code]SUCCESS[/code]. BT action that waits for a randomized duration to pass and returns [code]SUCCESS[/code].
</brief_description> </brief_description>
<description> <description>
BT action that waits for a randomized duration to pass and returns [code]SUCCESS[/code]. The minimum wait time is defined by [code]duration_min_max.x[/code], and the maximum is defined by [code]duration_min_max.y[/code]. BT action that waits for a randomized duration to pass and returns [code]SUCCESS[/code]. Actual duration is randomized. The minimum wait time is defined by [code]min_duration[/code], and the maximum is defined by [code]max_duration[/code].
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="duration_min_max" type="Vector2" setter="set_duration_min_max" getter="get_duration_min_max" default="Vector2( 1, 2 )"> <member name="max_duration" type="float" setter="set_max_duration" getter="get_max_duration" default="2.0">
Maximum duration to wait.
</member>
<member name="min_duration" type="float" setter="set_min_duration" getter="get_min_duration" default="1.0">
Minimum duration to wait.
</member> </member>
</members> </members>
<constants>
</constants>
</class> </class>

6
doc_classes/BTRepeat.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTRepeat" inherits="BTDecorator" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTRepeat" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT decorator that repeats its child specified number of [member times]. BT decorator that repeats its child specified number of [member times].
</brief_description> </brief_description>
@ -11,8 +11,6 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="abort_on_failure" type="bool" setter="set_abort_on_failure" getter="get_abort_on_failure" default="false"> <member name="abort_on_failure" type="bool" setter="set_abort_on_failure" getter="get_abort_on_failure" default="false">
If [code]false[/code], [code]FAILURE[/code] status returned by the child is also considered a successfully finished execution. If [code]false[/code], [code]FAILURE[/code] status returned by the child is also considered a successfully finished execution.
@ -21,6 +19,4 @@
A number of times to repeat an execution of the child task. A number of times to repeat an execution of the child task.
</member> </member>
</members> </members>
<constants>
</constants>
</class> </class>

6
doc_classes/BTRepeatUntilFailure.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTRepeatUntilFailure" inherits="BTDecorator" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTRepeatUntilFailure" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT decorator that repeats child until [code]FAILURE[/code]. BT decorator that repeats child until [code]FAILURE[/code].
</brief_description> </brief_description>
@ -10,8 +10,4 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<constants>
</constants>
</class> </class>

6
doc_classes/BTRepeatUntilSuccess.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTRepeatUntilSuccess" inherits="BTDecorator" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTRepeatUntilSuccess" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT decorator that repeats child until [code]SUCCESS[/code]. BT decorator that repeats child until [code]SUCCESS[/code].
</brief_description> </brief_description>
@ -10,8 +10,4 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<constants>
</constants>
</class> </class>

6
doc_classes/BTRunLimit.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTRunLimit" inherits="BTDecorator" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTRunLimit" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT decorator that allows child's execution a limited number of times. BT decorator that allows child's execution a limited number of times.
</brief_description> </brief_description>
@ -9,13 +9,9 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="run_limit" type="int" setter="set_run_limit" getter="get_run_limit" default="1"> <member name="run_limit" type="int" setter="set_run_limit" getter="get_run_limit" default="1">
A limit on number of times the child is allowed to be executed. A limit on number of times the child is allowed to be executed.
</member> </member>
</members> </members>
<constants>
</constants>
</class> </class>

6
doc_classes/BTSelector.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTSelector" inherits="BTComposite" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTSelector" inherits="BTComposite" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT composite that executes tasks in turn until first [code]SUCCESS[/code]. BT composite that executes tasks in turn until first [code]SUCCESS[/code].
</brief_description> </brief_description>
@ -11,8 +11,4 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<constants>
</constants>
</class> </class>

6
doc_classes/BTSequence.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTSequence" inherits="BTComposite" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTSequence" inherits="BTComposite" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT composite that executes tasks in turn for as long as they return [code]SUCCESS[/code]. BT composite that executes tasks in turn for as long as they return [code]SUCCESS[/code].
</brief_description> </brief_description>
@ -11,8 +11,4 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<constants>
</constants>
</class> </class>

11
doc_classes/BTState.xml
View File

@ -1,17 +1,14 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTState" inherits="LimboState" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTState" inherits="LimboState" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
A state node for [LimboHSM] that hosts a [BehaviorTree]. A state node for [LimboHSM] that hosts a [BehaviorTree].
</brief_description> </brief_description>
<description> <description>
This state node instantiates an instance of [BehaviorTree] and dispatches events, when the tree returns [code]SUCCESS[/code] or [code]FAILURE[/code]. This state node instantiates and executes a [BehaviorTree] resource. Dispatches state machine event, when the task tree returns [code]SUCCESS[/code] or [code]FAILURE[/code]. Event names can be specified by [member success_event] and [member failure_event].
When the tree returns [code]SUCCESS[/code], this state dispatches [member success_event]. For more information about state machine events see [method LimboState.dispatch].
When the tree returns [code]FAILURE[/code], this state dispatches [member failure_event].
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="behavior_tree" type="BehaviorTree" setter="set_behavior_tree" getter="get_behavior_tree"> <member name="behavior_tree" type="BehaviorTree" setter="set_behavior_tree" getter="get_behavior_tree">
A [BehaviorTree] resource that contains state behavior. A [BehaviorTree] resource that contains state behavior.
@ -23,6 +20,4 @@
HSM event that will be dispatched when the behavior tree returns [code]SUCCESS[/code]. HSM event that will be dispatched when the behavior tree returns [code]SUCCESS[/code].
</member> </member>
</members> </members>
<constants>
</constants>
</class> </class>

7
doc_classes/BTSubtree.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTSubtree" inherits="BTNewScope" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTSubtree" inherits="BTNewScope" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT decorator that instantiates a subtree. BT decorator that instantiates a subtree.
</brief_description> </brief_description>
@ -9,14 +9,9 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="_blackboard_data" type="Dictionary" setter="_set_blackboard_data" getter="_get_blackboard_data" overrides="BTNewScope" default="{}" />
<member name="subtree" type="BehaviorTree" setter="set_subtree" getter="get_subtree"> <member name="subtree" type="BehaviorTree" setter="set_subtree" getter="get_subtree">
A [BehaviorTree] resource that will be instantiated as a subtree. A [BehaviorTree] resource that will be instantiated as a subtree.
</member> </member>
</members> </members>
<constants>
</constants>
</class> </class>

55
doc_classes/BTTask.xml
View File

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTTask" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTTask" inherits="Resource" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Base class for BT tasks. Base class for [BehaviorTree] tasks.
</brief_description> </brief_description>
<description> <description>
Base class for all behavior tree tasks. Tasks are arranged in a tree-like structure called behavior tree (BT). Base class for all [BehaviorTree] tasks. A task is a building block in a [BehaviorTree] that represents a specific behavior or control flow. It is the basic unit of the Behavior Tree (BT) and is used to create complex behaviors by combining and nesting tasks in a hierarchy.
Tasks perform work and return their status with [method _tick]. See [enum TaskStatus]. Tasks perform work and return their status with [method _tick]. See [enum TaskStatus].
There are several types of tasks: actions, conditions, decorators, and composites. Each type of task has its own corresponding subclass: [BTAction], [BTCondition], [BTDecorator], [BTComposite]. A Task can be an action, a condition, a composite, or a decorator. Each type of task has its own corresponding subclass: [BTAction], [BTCondition], [BTDecorator], [BTComposite].
[b]Note:[/b] Do not inherint [BTTask] directly for your own tasks, instead inherit one of the subtypes above. [b]Note:[/b] Do not extend [code]BTTask[/code] directly for your own tasks, instead extend one of the subtypes above.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
@ -25,13 +25,13 @@
Called when task is "exited", i.e. after [method _tick] returns [constant SUCCESS] or [constant FAILURE] status. Called when task is "exited", i.e. after [method _tick] returns [constant SUCCESS] or [constant FAILURE] status.
</description> </description>
</method> </method>
<method name="_generate_name" qualifiers="virtual"> <method name="_generate_name" qualifiers="virtual const">
<return type="String" /> <return type="String" />
<description> <description>
When [member custom_name] is empty, the string returned by this method is used to display the task by the editor. See [method get_task_name]. When [member custom_name] is empty, the string returned by this method is used to display the task by the editor. See [method get_task_name].
</description> </description>
</method> </method>
<method name="_get_configuration_warning" qualifiers="virtual"> <method name="_get_configuration_warning" qualifiers="virtual const">
<return type="String" /> <return type="String" />
<description> <description>
The string returned by this method is displayed as a warning in the BT editor if the script that overrides it is a [code]tool[/code] script. The string returned by this method is displayed as a warning in the BT editor if the script that overrides it is a [code]tool[/code] script.
@ -45,7 +45,7 @@
</method> </method>
<method name="_tick" qualifiers="virtual"> <method name="_tick" qualifiers="virtual">
<return type="int" /> <return type="int" />
<argument index="0" name="p_delta" type="float" /> <param index="0" name="p_delta" type="float" />
<description> <description>
Called when task is "ticked", i.e. executed by [BTPlayer] or [BTState] during update. Called when task is "ticked", i.e. executed by [BTPlayer] or [BTState] during update.
Returns [member TaskStatus]. Returns [member TaskStatus].
@ -54,15 +54,15 @@
</method> </method>
<method name="add_child"> <method name="add_child">
<return type="void" /> <return type="void" />
<argument index="0" name="p_child" type="BTTask" /> <param index="0" name="p_child" type="BTTask" />
<description> <description>
Adds a child task. The [code]p_child[/code] is placed at the end of the children list. Adds a child task. The [code]p_child[/code] is placed at the end of the children list.
</description> </description>
</method> </method>
<method name="add_child_at_index"> <method name="add_child_at_index">
<return type="void" /> <return type="void" />
<argument index="0" name="p_child" type="BTTask" /> <param index="0" name="p_child" type="BTTask" />
<argument index="1" name="p_idx" type="int" /> <param index="1" name="p_idx" type="int" />
<description> <description>
Adds a child task. The [code]p_child[/code] is placed at [code]p_idx[/code] position in the children list. Adds a child task. The [code]p_child[/code] is placed at [code]p_idx[/code] position in the children list.
</description> </description>
@ -75,14 +75,14 @@
</method> </method>
<method name="execute"> <method name="execute">
<return type="int" /> <return type="int" />
<argument index="0" name="p_delta" type="float" /> <param index="0" name="p_delta" type="float" />
<description> <description>
Performs task's execution. During execution [method _enter] is called first, unless current task [member status] is [code]RUNNING[/code]. [method _tick] is called next to perform task's main function. If [constant SUCCESS] or [constant FAILURE] status is returned by [method _tick], [method _exit] will be called next. Performs task's execution. During execution [method _enter] is called first, unless current task [member status] is [code]RUNNING[/code]. [method _tick] is called next to perform task's main function. If [constant SUCCESS] or [constant FAILURE] status is returned by [method _tick], [method _exit] will be called next.
</description> </description>
</method> </method>
<method name="get_child" qualifiers="const"> <method name="get_child" qualifiers="const">
<return type="BTTask" /> <return type="BTTask" />
<argument index="0" name="p_idx" type="int" /> <param index="0" name="p_idx" type="int" />
<description> <description>
Returns a child task by its index. Returns a child task by its index.
</description> </description>
@ -95,11 +95,17 @@
</method> </method>
<method name="get_child_index" qualifiers="const"> <method name="get_child_index" qualifiers="const">
<return type="int" /> <return type="int" />
<argument index="0" name="p_child" type="BTTask" /> <param index="0" name="p_child" type="BTTask" />
<description> <description>
Returns the child task's index. If [code]p_child[/code] is not a child of the task, [code]-1[/code] is returned instead. Returns the child task's index. If [code]p_child[/code] is not a child of the task, [code]-1[/code] is returned instead.
</description> </description>
</method> </method>
<method name="get_parent" qualifiers="const">
<return type="BTTask" />
<description>
Returns task's parent.
</description>
</method>
<method name="get_root" qualifiers="const"> <method name="get_root" qualifiers="const">
<return type="BTTask" /> <return type="BTTask" />
<description> <description>
@ -115,15 +121,15 @@
</method> </method>
<method name="has_child" qualifiers="const"> <method name="has_child" qualifiers="const">
<return type="bool" /> <return type="bool" />
<argument index="0" name="p_child" type="BTTask" /> <param index="0" name="p_child" type="BTTask" />
<description> <description>
Returns [code]true[/code] if [code]p_child[/code] is a child of this task. Returns [code]true[/code] if [code]p_child[/code] is a child of this task.
</description> </description>
</method> </method>
<method name="initialize"> <method name="initialize">
<return type="void" /> <return type="void" />
<argument index="0" name="p_agent" type="Object" /> <param index="0" name="p_agent" type="Node" />
<argument index="1" name="p_blackboard" type="Blackboard" /> <param index="1" name="p_blackboard" type="Blackboard" />
<description> <description>
Initilizes the task. Assigns [member agent] and [member blackboard], and calls [method _setup] for the task and its children. Initilizes the task. Assigns [member agent] and [member blackboard], and calls [method _setup] for the task and its children.
The method is called recursively for each child task. The method is called recursively for each child task.
@ -131,7 +137,7 @@
</method> </method>
<method name="is_descendant_of" qualifiers="const"> <method name="is_descendant_of" qualifiers="const">
<return type="bool" /> <return type="bool" />
<argument index="0" name="p_task" type="BTTask" /> <param index="0" name="p_task" type="BTTask" />
<description> <description>
Returns [code]true[/code] if this task is descendant of [code]p_task[/code]. I.e. this task must be a child of [code]p_task[/code] or one of its children or grandchildren. Returns [code]true[/code] if this task is descendant of [code]p_task[/code]. I.e. this task must be a child of [code]p_task[/code] or one of its children or grandchildren.
</description> </description>
@ -151,29 +157,29 @@
</method> </method>
<method name="print_tree" qualifiers="const"> <method name="print_tree" qualifiers="const">
<return type="void" /> <return type="void" />
<argument index="0" name="p_initial_tabs" type="int" default="0" /> <param index="0" name="p_initial_tabs" type="int" default="0" />
<description> <description>
Prints the subtree that starts with this task to console. Prints the subtree that starts with this task to console.
</description> </description>
</method> </method>
<method name="remove_child"> <method name="remove_child">
<return type="void" /> <return type="void" />
<argument index="0" name="p_child" type="BTTask" /> <param index="0" name="p_child" type="BTTask" />
<description> <description>
Removes [code]p_child[/code] task from children. Removes [code]p_child[/code] task from children.
</description> </description>
</method> </method>
<method name="remove_child_at_index"> <method name="remove_child_at_index">
<return type="void" /> <return type="void" />
<argument index="0" name="p_idx" type="int" /> <param index="0" name="p_idx" type="int" />
<description> <description>
Removes a child task by index. Removes a child task by index.
</description> </description>
</method> </method>
</methods> </methods>
<members> <members>
<member name="agent" type="Object" setter="set_agent" getter="get_agent"> <member name="agent" type="Node" setter="set_agent" getter="get_agent">
The agent is a contextual object for the task's behavior tree instance. Usually, the agent is an owner of the node with the behavior tree instance. The agent is a contextual object for the task's behavior tree instance. Usually, agent is the owner of a node with the [BehaviorTree] resource.
</member> </member>
<member name="blackboard" type="Blackboard" setter="" getter="get_blackboard"> <member name="blackboard" type="Blackboard" setter="" getter="get_blackboard">
Provides access to the blackboard for this task and behavior tree. Blackboard is used to share data among tasks of the associated behavior tree. Provides access to the blackboard for this task and behavior tree. Blackboard is used to share data among tasks of the associated behavior tree.
@ -182,9 +188,6 @@
<member name="custom_name" type="String" setter="set_custom_name" getter="get_custom_name" default="&quot;&quot;"> <member name="custom_name" type="String" setter="set_custom_name" getter="get_custom_name" default="&quot;&quot;">
User provided name for the task. If not empty, [code]custom_name[/code] is used by the editor to display the task. See [method get_task_name]. User provided name for the task. If not empty, [code]custom_name[/code] is used by the editor to display the task. See [method get_task_name].
</member> </member>
<member name="parent" type="BTTask" setter="" getter="get_parent">
The task's parent.
</member>
<member name="status" type="int" setter="" getter="get_status"> <member name="status" type="int" setter="" getter="get_status">
Last execution [enum TaskStatus] returned by [method _tick]. Last execution [enum TaskStatus] returned by [method _tick].
</member> </member>

6
doc_classes/BTTimeLimit.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTTimeLimit" inherits="BTDecorator" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTTimeLimit" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT decorator that allots a limited time for child's execution. BT decorator that allots a limited time for child's execution.
</brief_description> </brief_description>
@ -8,13 +8,9 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="time_limit" type="float" setter="set_time_limit" getter="get_time_limit" default="5.0"> <member name="time_limit" type="float" setter="set_time_limit" getter="get_time_limit" default="5.0">
Time allotted for a child task's execution. Time allotted for a child task's execution.
</member> </member>
</members> </members>
<constants>
</constants>
</class> </class>

6
doc_classes/BTWait.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTWait" inherits="BTAction" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTWait" inherits="BTAction" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT action that waits for a [member duration] to pass and returns [code]SUCCESS[/code]. BT action that waits for a [member duration] to pass and returns [code]SUCCESS[/code].
</brief_description> </brief_description>
@ -7,12 +7,8 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="duration" type="float" setter="set_duration" getter="get_duration" default="1.0"> <member name="duration" type="float" setter="set_duration" getter="get_duration" default="1.0">
</member> </member>
</members> </members>
<constants>
</constants>
</class> </class>

6
doc_classes/BTWaitTicks.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BTWaitTicks" inherits="BTAction" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BTWaitTicks" inherits="BTAction" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
BT action that waits for a number of ticks to pass and returns SUCCESS. BT action that waits for a number of ticks to pass and returns SUCCESS.
</brief_description> </brief_description>
@ -7,12 +7,8 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="num_ticks" type="int" setter="set_num_ticks" getter="get_num_ticks" default="1"> <member name="num_ticks" type="int" setter="set_num_ticks" getter="get_num_ticks" default="1">
</member> </member>
</members> </members>
<constants>
</constants>
</class> </class>

30
doc_classes/BehaviorTree.xml
View File

@ -1,9 +1,11 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BehaviorTree" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="BehaviorTree" inherits="Resource" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Contains behavior tree data. Contains Behavior Tree data.
</brief_description> </brief_description>
<description> <description>
[BehaviorTree] is a hierarchical structure used to model and control the behavior of agents in a game. It is composed of tasks that represent specific actions or decision-making rules. The [BehaviorTree] is executed from the root task down to the leaf tasks, which represent the actual actions or behaviors that the agent should perform.
See also [BTTask] class.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
@ -14,29 +16,31 @@
Makes a copy of behavior tree. Makes a copy of behavior tree.
</description> </description>
</method> </method>
<method name="init"> <method name="get_root_task" qualifiers="const">
<return type="void" /> <return type="BTTask" />
<description> <description>
Initializes a loaded behavior tree, making sure tasks are properly linked. Returns root task of the [BehaviorTree] resource.
</description> </description>
</method> </method>
<method name="instance" qualifiers="const"> <method name="instantiate" qualifiers="const">
<return type="BTTask" /> <return type="BTTask" />
<argument index="0" name="p_agent" type="Object" /> <param index="0" name="p_agent" type="Node" />
<argument index="1" name="p_blackboard" type="Blackboard" /> <param index="1" name="p_blackboard" type="Blackboard" />
<description> <description>
Instantiates behavior tree and returns the root [BTTask]. Instantiates behavior tree and returns the root [BTTask].
</description> </description>
</method> </method>
<method name="set_root_task">
<return type="void" />
<param index="0" name="p_value" type="BTTask" />
<description>
Assign new root task to [BehaviorTree] resource.
</description>
</method>
</methods> </methods>
<members> <members>
<member name="description" type="String" setter="set_description" getter="get_description" default="&quot;&quot;"> <member name="description" type="String" setter="set_description" getter="get_description" default="&quot;&quot;">
User-provided description of BehaviorTree. User-provided description of BehaviorTree.
</member> </member>
<member name="root_task" type="BTTask" setter="set_root_task" getter="get_root_task">
Stores root task.
</member>
</members> </members>
<constants>
</constants>
</class> </class>

33
doc_classes/Blackboard.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="Blackboard" inherits="Reference" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="Blackboard" inherits="RefCounted" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
A key/value store to hold data shared by BT tasks. A key/value store to hold data shared by BT tasks.
</brief_description> </brief_description>
@ -11,6 +11,13 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="erase_var">
<return type="void" />
<param index="0" name="p_key" type="Variant" />
<description>
Removes variable by name.
</description>
</method>
<method name="get_data" qualifiers="const"> <method name="get_data" qualifiers="const">
<return type="Dictionary" /> <return type="Dictionary" />
<description> <description>
@ -25,49 +32,53 @@
</method> </method>
<method name="get_var" qualifiers="const"> <method name="get_var" qualifiers="const">
<return type="Variant" /> <return type="Variant" />
<argument index="0" name="p_key" type="Variant" /> <param index="0" name="p_key" type="Variant" />
<argument index="1" name="p_default" type="Variant" default="null" /> <param index="1" name="p_default" type="Variant" default="null" />
<description> <description>
Returns variable value. Returns variable value.
</description> </description>
</method> </method>
<method name="has_var" qualifiers="const"> <method name="has_var" qualifiers="const">
<return type="bool" /> <return type="bool" />
<argument index="0" name="p_key" type="Variant" /> <param index="0" name="p_key" type="Variant" />
<description> <description>
Returns [code]true[/code] if Blackboard contains [code]p_key[/code] variable. Parent scope included. Returns [code]true[/code] if Blackboard contains [code]p_key[/code] variable. Parent scope included.
</description> </description>
</method> </method>
<method name="prefetch_nodepath_vars"> <method name="prefetch_nodepath_vars">
<return type="void" /> <return type="void" />
<argument index="0" name="p_node" type="Node" /> <param index="0" name="p_node" type="Node" />
<description> <description>
Replaces NodePath variables in the [Blackboard] with references that are retrieved by calling [method Node.get_node] on a [code]p_node[/code] argument. Replaces NodePath variables in the [Blackboard] with references that are retrieved by calling [method Node.get_node] on a [code]p_node[/code] argument.
</description> </description>
</method> </method>
<method name="set_data"> <method name="set_data">
<return type="void" /> <return type="void" />
<argument index="0" name="p_data" type="Dictionary" /> <param index="0" name="p_data" type="Dictionary" />
<description> <description>
Overrides Blackboard data, discarding anything that was stored at this scope. Use with caution. Overrides Blackboard data, discarding anything that was stored at this scope. Use with caution.
</description> </description>
</method> </method>
<method name="set_parent_scope"> <method name="set_parent_scope">
<return type="void" /> <return type="void" />
<argument index="0" name="p_blackboard" type="Blackboard" /> <param index="0" name="p_blackboard" type="Blackboard" />
<description> <description>
Sets the parent scope. If a value is not found in the Blackboard's active scope, the parent scope Blackboard will be asked to retrieve it. Sets the parent scope. If a value is not found in the Blackboard's active scope, the parent scope Blackboard will be asked to retrieve it.
</description> </description>
</method> </method>
<method name="set_var"> <method name="set_var">
<return type="void" /> <return type="void" />
<argument index="0" name="p_key" type="Variant" /> <param index="0" name="p_key" type="Variant" />
<argument index="1" name="p_value" type="Variant" /> <param index="1" name="p_value" type="Variant" />
<description> <description>
Sets value of blackboard variable. Sets value of blackboard variable.
</description> </description>
</method> </method>
<method name="top" qualifiers="const">
<return type="Blackboard" />
<description>
Returns topmost [Blackboard] in the scope chain.
</description>
</method>
</methods> </methods>
<constants>
</constants>
</class> </class>

20
doc_classes/LimboHSM.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="LimboHSM" inherits="LimboState" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="LimboHSM" inherits="LimboState" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Event-based Hierarchical State Machine (HSM). Event-based Hierarchical State Machine (HSM).
</brief_description> </brief_description>
@ -12,9 +12,9 @@
<methods> <methods>
<method name="add_transition"> <method name="add_transition">
<return type="void" /> <return type="void" />
<argument index="0" name="p_from_state" type="Node" /> <param index="0" name="p_from_state" type="Node" />
<argument index="1" name="p_to_state" type="Node" /> <param index="1" name="p_to_state" type="Node" />
<argument index="2" name="p_event" type="String" /> <param index="2" name="p_event" type="String" />
<description> <description>
Adds a transition from one state to another when [code]p_event[/code] is dispatched. Adds a transition from one state to another when [code]p_event[/code] is dispatched.
</description> </description>
@ -33,22 +33,22 @@
</method> </method>
<method name="initialize"> <method name="initialize">
<return type="void" /> <return type="void" />
<argument index="0" name="p_agent" type="Object" /> <param index="0" name="p_agent" type="Node" />
<argument index="1" name="p_parent_scope" type="Blackboard" default="null" /> <param index="1" name="p_parent_scope" type="Blackboard" default="null" />
<description> <description>
Initializes state and calls [code]_setup[/code] for itself and every substate. Initializes state and calls [code]_setup[/code] for itself and every substate.
</description> </description>
</method> </method>
<method name="set_active"> <method name="set_active">
<return type="void" /> <return type="void" />
<argument index="0" name="p_active" type="bool" /> <param index="0" name="p_active" type="bool" />
<description> <description>
If [code]true[/code], changes state to [member initial_state] and enables state processing depending on [member update_mode]. If [code]true[/code], changes state to [member initial_state] and enables state processing depending on [member update_mode].
</description> </description>
</method> </method>
<method name="update"> <method name="update">
<return type="void" /> <return type="void" />
<argument index="0" name="p_delta" type="float" /> <param index="0" name="p_delta" type="float" />
<description> <description>
Calls [member LimboState._update] on itself and on the active substate. Call propagates down to the leaf state. Calls [member LimboState._update] on itself and on the active substate. Call propagates down to the leaf state.
It is called automatically, if [member update_mode] is not set to [constant MANUAL]. It is called automatically, if [member update_mode] is not set to [constant MANUAL].
@ -62,13 +62,13 @@
<member name="initial_state" type="LimboState" setter="set_initial_state" getter="get_initial_state"> <member name="initial_state" type="LimboState" setter="set_initial_state" getter="get_initial_state">
A state that becomes active when state machine is activated by [method set_active] method. A state that becomes active when state machine is activated by [method set_active] method.
</member> </member>
<member name="update_mode" type="int" setter="set_update_mode" getter="get_update_mode" enum="LimboHSM.UpdateMode" default="0"> <member name="update_mode" type="int" setter="set_update_mode" getter="get_update_mode" enum="LimboHSM.UpdateMode" default="1">
Determines when state machine is updated. See [enum UpdateMode]. Determines when state machine is updated. See [enum UpdateMode].
</member> </member>
</members> </members>
<signals> <signals>
<signal name="state_changed"> <signal name="state_changed">
<argument index="0" name="p_state" type="LimboState" /> <param index="0" name="p_state" type="LimboState" />
<description> <description>
Emitted when state is changed. Emitted when state is changed.
</description> </description>

43
doc_classes/LimboState.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="LimboState" inherits="Node" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="LimboState" inherits="Node" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
A State node for Hierarchical State Machine (HSM). A State node for Hierarchical State Machine (HSM).
</brief_description> </brief_description>
@ -28,56 +28,53 @@
</method> </method>
<method name="_update" qualifiers="virtual"> <method name="_update" qualifiers="virtual">
<return type="void" /> <return type="void" />
<argument index="0" name="p_delta" type="float" /> <param index="0" name="p_delta" type="float" />
<description> <description>
Called during update. Called during update.
</description> </description>
</method> </method>
<method name="add_event_handler"> <method name="add_event_handler">
<return type="void" /> <return type="void" />
<argument index="0" name="p_event" type="String" /> <param index="0" name="p_event" type="String" />
<argument index="1" name="p_method" type="String" /> <param index="1" name="p_handler" type="Callable" />
<description> <description>
Register [code]p_method[/code] that will be called when [code]p_event[/code] happens. Method must belong to the state. Register [code]p_method[/code] that will be called when [code]p_event[/code] happens. Method must belong to the state.
</description> </description>
</method> </method>
<method name="call_on_enter"> <method name="call_on_enter">
<return type="LimboState" /> <return type="LimboState" />
<argument index="0" name="p_object" type="Object" /> <param index="0" name="p_callable" type="Callable" />
<argument index="1" name="p_method" type="String" />
<description> <description>
A chained method that connects [signal entered] signal to a [code]p_method[/code] on a [p_object]. A chained method that connects [signal entered] signal to a [code]p_method[/code] on a [p_object].
</description> </description>
</method> </method>
<method name="call_on_exit"> <method name="call_on_exit">
<return type="LimboState" /> <return type="LimboState" />
<argument index="0" name="p_object" type="Object" /> <param index="0" name="p_callable" type="Callable" />
<argument index="1" name="p_method" type="String" />
<description> <description>
A chained method that connects [signal exited] signal to a [code]p_method[/code] on a [p_object]. A chained method that connects [signal exited] signal to a [code]p_method[/code] on a [p_object].
</description> </description>
</method> </method>
<method name="call_on_update"> <method name="call_on_update">
<return type="LimboState" /> <return type="LimboState" />
<argument index="0" name="p_object" type="Object" /> <param index="0" name="p_callable" type="Callable" />
<argument index="1" name="p_method" type="String" />
<description> <description>
A chained method that connects [signal updated] signal to a [code]p_method[/code] on a [p_object]. A chained method that connects [signal updated] signal to a [code]p_method[/code] on a [p_object].
</description> </description>
</method> </method>
<method name="clear_guard_func"> <method name="clear_guard">
<return type="void" /> <return type="void" />
<description> <description>
Removes the guard function that was set by [method set_guard_func]. Removes state's guard function that was set by [method set_guard].
</description> </description>
</method> </method>
<method name="dispatch"> <method name="dispatch">
<return type="bool" /> <return type="bool" />
<argument index="0" name="p_event" type="String" /> <param index="0" name="p_event" type="String" />
<argument index="1" name="p_cargo" type="Variant" default="null" /> <param index="1" name="p_cargo" type="Variant" default="null" />
<description> <description>
Dispatches recursively a state machine event named [code]p_event[/code] with an optional argument [code]p_cargo[/code]. Returns [code]true[/code] if event was consumed. Dispatches recursively a state machine event named [code]p_event[/code] with an optional argument [code]p_cargo[/code]. Returns [code]true[/code] if event was consumed.
Events propagate from the leaf state to the root. Propagation stops as soon as some state consumes the event. Events propagate from the leaf state to the root. Propagation stops as soon as some state consumes the event. States will consume event if they have a transition associated with it, or an event handler. See also [method add_event_handler].
</description> </description>
</method> </method>
<method name="get_root" qualifiers="const"> <method name="get_root" qualifiers="const">
@ -94,18 +91,16 @@
</method> </method>
<method name="named"> <method name="named">
<return type="LimboState" /> <return type="LimboState" />
<argument index="0" name="p_name" type="String" /> <param index="0" name="p_name" type="String" />
<description> <description>
A chained method that sets the name of this state. A chained method that sets the name of this state.
</description> </description>
</method> </method>
<method name="set_guard_func"> <method name="set_guard">
<return type="void" /> <return type="void" />
<argument index="0" name="p_object" type="Object" /> <param index="0" name="p_guard_callable" type="Callable" />
<argument index="1" name="p_func" type="String" />
<argument index="2" name="p_binds" type="Array" default="[ ]" />
<description> <description>
Sets the guard function. It is a function that will be called each time a transition to this state should happen. If that function returns [code]false[/code], that transition will not be allowed. Sets the guard function. It is a function that will be called each time a transition to this state should happen. If that function returns [code]false[/code], the transition will not be allowed.
</description> </description>
</method> </method>
</methods> </methods>
@ -113,7 +108,7 @@
<member name="EVENT_FINISHED" type="String" setter="" getter="event_finished"> <member name="EVENT_FINISHED" type="String" setter="" getter="event_finished">
A commonly used event that signifies that the state has finished work. A commonly used event that signifies that the state has finished work.
</member> </member>
<member name="agent" type="Object" setter="set_agent" getter="get_agent"> <member name="agent" type="Node" setter="set_agent" getter="get_agent">
An agent that is associated with the state. Assinged by initialization. An agent that is associated with the state. Assinged by initialization.
</member> </member>
<member name="blackboard" type="Blackboard" setter="" getter="get_blackboard"> <member name="blackboard" type="Blackboard" setter="" getter="get_blackboard">
@ -137,12 +132,10 @@
</description> </description>
</signal> </signal>
<signal name="updated"> <signal name="updated">
<argument index="0" name="p_delta" type="float" /> <param index="0" name="p_delta" type="float" />
<description> <description>
Emitted when the state is updated. Emitted when the state is updated.
</description> </description>
</signal> </signal>
</signals> </signals>
<constants>
</constants>
</class> </class>

8
doc_classes/LimboUtility.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="LimboUtility" inherits="Object" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="LimboUtility" inherits="Object" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
Helper functions for LimboAI. Helper functions for LimboAI.
</brief_description> </brief_description>
@ -10,19 +10,17 @@
<methods> <methods>
<method name="decorate_var" qualifiers="const"> <method name="decorate_var" qualifiers="const">
<return type="String" /> <return type="String" />
<argument index="0" name="p_variable" type="String" /> <param index="0" name="p_variable" type="String" />
<description> <description>
Returns a string with a [Blackboard] variable name ready to be displayed or printed to console. Returns a string with a [Blackboard] variable name ready to be displayed or printed to console.
</description> </description>
</method> </method>
<method name="get_status_name" qualifiers="const"> <method name="get_status_name" qualifiers="const">
<return type="String" /> <return type="String" />
<argument index="0" name="p_status" type="int" /> <param index="0" name="p_status" type="int" />
<description> <description>
Returns name of a [BTTask] status code. Returns name of a [BTTask] status code.
</description> </description>
</method> </method>
</methods> </methods>
<constants>
</constants>
</class> </class>

2
editor/limbo_ai_editor_plugin.cpp
View File

@ -1020,6 +1020,8 @@ void LimboAIEditor::apply_changes() {
} }
Ref<Texture> LimboAIEditor::get_task_icon(String p_script_path_or_class) { Ref<Texture> LimboAIEditor::get_task_icon(String p_script_path_or_class) {
ERR_FAIL_COND_V_MSG(p_script_path_or_class.is_empty(), Variant(), "BTTask: script path or class cannot be empty.");
String base_type = p_script_path_or_class; String base_type = p_script_path_or_class;
if (p_script_path_or_class.begins_with("res:")) { if (p_script_path_or_class.begins_with("res:")) {
Ref<Script> script = ResourceLoader::load(p_script_path_or_class, "Script"); Ref<Script> script = ResourceLoader::load(p_script_path_or_class, "Script");