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

Doc: Update class docs

This commit is contained in:
Serhii Snitsaruk 2024-03-04 16:14:47 +01:00
parent 7cf4a4b3b8
commit ecf1e4b65f
26 changed files with 174 additions and 174 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -38,7 +38,7 @@ Properties
+----------------------------------------------+----------------------------------------------------------+----------+
| :ref:`ValueSource<enum_BBParam_ValueSource>` | :ref:`value_source<class_BBParam_property_value_source>` | ``0`` |
+----------------------------------------------+----------------------------------------------------------+----------+
| String | :ref:`variable<class_BBParam_property_variable>` | |
| StringName | :ref:`variable<class_BBParam_property_variable>` | |
+----------------------------------------------+----------------------------------------------------------+----------+
.. rst-class:: classref-reftable-group
@ -133,12 +133,12 @@ Specifies the source of the value for BBParam. See :ref:`ValueSource<enum_BBPara
.. rst-class:: classref-property
String **variable**
StringName **variable**
.. rst-class:: classref-property-setget
- void **set_variable** **(** String value **)**
- String **get_variable** **(** **)**
- void **set_variable** **(** StringName value **)**
- StringName **get_variable** **(** **)**
Stores the name of a :ref:`Blackboard<class_Blackboard>` variable when :ref:`value_source<class_BBParam_property_value_source>` is set to :ref:`BLACKBOARD_VAR<class_BBParam_constant_BLACKBOARD_VAR>`.

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

@ -33,27 +33,27 @@ Methods
.. table::
:widths: auto
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`bind_var_to_property<class_Blackboard_method_bind_var_to_property>` **(** String p_name, Object p_object, StringName p_property **)** |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_var<class_Blackboard_method_erase_var>` **(** String p_name **)** |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`bind_var_to_property<class_Blackboard_method_bind_var_to_property>` **(** StringName p_name, Object p_object, StringName p_property **)** |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_var<class_Blackboard_method_erase_var>` **(** StringName p_name **)** |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Blackboard<class_Blackboard>` | :ref:`get_parent<class_Blackboard_method_get_parent>` **(** **)** |const| |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| Variant | :ref:`get_var<class_Blackboard_method_get_var>` **(** String p_name, Variant p_default=null, bool p_complain=true **)** |const| |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| bool | :ref:`has_var<class_Blackboard_method_has_var>` **(** String p_name **)** |const| |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| Variant | :ref:`get_var<class_Blackboard_method_get_var>` **(** StringName p_name, Variant p_default=null, bool p_complain=true **)** |const| |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| bool | :ref:`has_var<class_Blackboard_method_has_var>` **(** StringName p_name **)** |const| |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`prefetch_nodepath_vars<class_Blackboard_method_prefetch_nodepath_vars>` **(** Node p_node **)** |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_parent<class_Blackboard_method_set_parent>` **(** :ref:`Blackboard<class_Blackboard>` p_blackboard **)** |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_var<class_Blackboard_method_set_var>` **(** String p_name, Variant p_value **)** |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_var<class_Blackboard_method_set_var>` **(** StringName p_name, Variant p_value **)** |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Blackboard<class_Blackboard>` | :ref:`top<class_Blackboard_method_top>` **(** **)** |const| |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unbind_var<class_Blackboard_method_unbind_var>` **(** String p_name **)** |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unbind_var<class_Blackboard_method_unbind_var>` **(** StringName p_name **)** |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@ -68,7 +68,7 @@ Method Descriptions
.. rst-class:: classref-method
void **bind_var_to_property** **(** String p_name, Object p_object, StringName p_property **)**
void **bind_var_to_property** **(** StringName p_name, Object p_object, StringName p_property **)**
Establish a binding between a variable and the object's property specified by ``p_property`` and ``p_object``. Changes to the variable update the property, and vice versa.
@ -80,7 +80,7 @@ Establish a binding between a variable and the object's property specified by ``
.. rst-class:: classref-method
void **erase_var** **(** String p_name **)**
void **erase_var** **(** StringName p_name **)**
Removes a variable by its name.
@ -104,7 +104,7 @@ Returns a Blackboard that serves as the parent scope for this instance.
.. rst-class:: classref-method
Variant **get_var** **(** String p_name, Variant p_default=null, bool p_complain=true **)** |const|
Variant **get_var** **(** StringName p_name, Variant p_default=null, bool p_complain=true **)** |const|
Returns variable value or ``p_default`` if variable doesn't exist. If ``p_complain`` is ``true``, an error will be printed if variable doesn't exist.
@ -116,7 +116,7 @@ Returns variable value or ``p_default`` if variable doesn't exist. If ``p_compla
.. rst-class:: classref-method
bool **has_var** **(** String p_name **)** |const|
bool **has_var** **(** StringName p_name **)** |const|
Returns ``true`` if the Blackboard contains the ``p_name`` variable, including the parent scopes.
@ -152,7 +152,7 @@ Assigns the parent scope. If a value isn't in the current Blackboard scope, it w
.. rst-class:: classref-method
void **set_var** **(** String p_name, Variant p_value **)**
void **set_var** **(** StringName p_name, Variant p_value **)**
Assigns a value to a Blackboard variable.
@ -176,7 +176,7 @@ Returns the topmost **Blackboard** in the scope chain.
.. rst-class:: classref-method
void **unbind_var** **(** String p_name **)**
void **unbind_var** **(** StringName p_name **)**
Remove binding from a variable.

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

@ -55,7 +55,7 @@ Constructs a new instance of a :ref:`Blackboard<class_Blackboard>` using this pl
void **populate_blackboard** **(** :ref:`Blackboard<class_Blackboard>` p_blackboard, bool p_overwrite **)**
Populates ``p_blackboard`` with the variables from this plan. If ``p_override`` is ``true``, existing variables with the same names will be overwritten.
Populates ``p_blackboard`` with the variables from this plan. If ``p_overwrite`` is ``true``, existing variables with the same names will be overwritten.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`

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

@ -40,7 +40,7 @@ Properties
+-------------------------------------+---------------------------------------------------------------------------+-----------+
| :ref:`BBNode<class_BBNode>` | :ref:`node<class_BTCallMethod_property_node>` | |
+-------------------------------------+---------------------------------------------------------------------------+-----------+
| String | :ref:`result_var<class_BTCallMethod_property_result_var>` | ``""`` |
| StringName | :ref:`result_var<class_BTCallMethod_property_result_var>` | ``&""`` |
+-------------------------------------+---------------------------------------------------------------------------+-----------+
.. rst-class:: classref-section-separator
@ -124,12 +124,12 @@ Specifies the ``Node`` or ``Object`` instance containing the method to be called
.. rst-class:: classref-property
String **result_var** = ``""``
StringName **result_var** = ``&""``
.. rst-class:: classref-property-setget
- void **set_result_var** **(** String value **)**
- String **get_result_var** **(** **)**
- void **set_result_var** **(** StringName value **)**
- StringName **get_result_var** **(** **)**
if non-empty, assign the result of the method call to the blackboard variable specified by this property.

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

@ -31,9 +31,9 @@ Properties
.. table::
:widths: auto
+--------+---------------------------------------------------------+--------+
| String | :ref:`variable<class_BTCheckTrigger_property_variable>` | ``""`` |
+--------+---------------------------------------------------------+--------+
+------------+---------------------------------------------------------+---------+
| StringName | :ref:`variable<class_BTCheckTrigger_property_variable>` | ``&""`` |
+------------+---------------------------------------------------------+---------+
.. rst-class:: classref-section-separator
@ -48,12 +48,12 @@ Property Descriptions
.. rst-class:: classref-property
String **variable** = ``""``
StringName **variable** = ``&""``
.. rst-class:: classref-property-setget
- void **set_variable** **(** String value **)**
- String **get_variable** **(** **)**
- void **set_variable** **(** StringName value **)**
- StringName **get_variable** **(** **)**
A boolean variable on the blackboard used as a trigger. See also :ref:`BTTask.blackboard<class_BTTask_property_blackboard>`.

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

@ -29,13 +29,13 @@ Properties
.. table::
:widths: auto
+-----------------------------------------------+---------------------------------------------------------+--------+
+-----------------------------------------------+---------------------------------------------------------+---------+
| :ref:`CheckType<enum_LimboUtility_CheckType>` | :ref:`check_type<class_BTCheckVar_property_check_type>` | ``0`` |
+-----------------------------------------------+---------------------------------------------------------+--------+
+-----------------------------------------------+---------------------------------------------------------+---------+
| :ref:`BBVariant<class_BBVariant>` | :ref:`value<class_BTCheckVar_property_value>` | |
+-----------------------------------------------+---------------------------------------------------------+--------+
| String | :ref:`variable<class_BTCheckVar_property_variable>` | ``""`` |
+-----------------------------------------------+---------------------------------------------------------+--------+
+-----------------------------------------------+---------------------------------------------------------+---------+
| StringName | :ref:`variable<class_BTCheckVar_property_variable>` | ``&""`` |
+-----------------------------------------------+---------------------------------------------------------+---------+
.. rst-class:: classref-section-separator
@ -84,12 +84,12 @@ A parameter that specifies the value against which the :ref:`variable<class_BTCh
.. rst-class:: classref-property
String **variable** = ``""``
StringName **variable** = ``&""``
.. rst-class:: classref-property-setget
- void **set_variable** **(** String value **)**
- String **get_variable** **(** **)**
- void **set_variable** **(** StringName value **)**
- StringName **get_variable** **(** **)**
The name of the variable to check its value.

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

@ -35,17 +35,17 @@ Properties
.. table::
:widths: auto
+--------+-------------------------------------------------------------------------+-----------+
| String | :ref:`cooldown_state_var<class_BTCooldown_property_cooldown_state_var>` | ``""`` |
+--------+-------------------------------------------------------------------------+-----------+
+------------+-------------------------------------------------------------------------+-----------+
| StringName | :ref:`cooldown_state_var<class_BTCooldown_property_cooldown_state_var>` | ``&""`` |
+------------+-------------------------------------------------------------------------+-----------+
| float | :ref:`duration<class_BTCooldown_property_duration>` | ``10.0`` |
+--------+-------------------------------------------------------------------------+-----------+
+------------+-------------------------------------------------------------------------+-----------+
| bool | :ref:`process_pause<class_BTCooldown_property_process_pause>` | ``false`` |
+--------+-------------------------------------------------------------------------+-----------+
+------------+-------------------------------------------------------------------------+-----------+
| bool | :ref:`start_cooled<class_BTCooldown_property_start_cooled>` | ``false`` |
+--------+-------------------------------------------------------------------------+-----------+
+------------+-------------------------------------------------------------------------+-----------+
| bool | :ref:`trigger_on_failure<class_BTCooldown_property_trigger_on_failure>` | ``false`` |
+--------+-------------------------------------------------------------------------+-----------+
+------------+-------------------------------------------------------------------------+-----------+
.. rst-class:: classref-section-separator
@ -60,12 +60,12 @@ Property Descriptions
.. rst-class:: classref-property
String **cooldown_state_var** = ``""``
StringName **cooldown_state_var** = ``&""``
.. rst-class:: classref-property-setget
- void **set_cooldown_state_var** **(** String value **)**
- String **get_cooldown_state_var** **(** **)**
- void **set_cooldown_state_var** **(** StringName value **)**
- StringName **get_cooldown_state_var** **(** **)**
A boolean variable used to store the cooldown state in the :ref:`Blackboard<class_Blackboard>`. If left empty, the variable will be automatically generated and assigned.

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

@ -42,7 +42,7 @@ Properties
+-------------------------------------+-------------------------------------------------------------------------------------+-------------------------+
| :ref:`BBNode<class_BBNode>` | :ref:`node<class_BTEvaluateExpression_property_node>` | |
+-------------------------------------+-------------------------------------------------------------------------------------+-------------------------+
| String | :ref:`result_var<class_BTEvaluateExpression_property_result_var>` | ``""`` |
| StringName | :ref:`result_var<class_BTEvaluateExpression_property_result_var>` | ``&""`` |
+-------------------------------------+-------------------------------------------------------------------------------------+-------------------------+
.. rst-class:: classref-reftable-group
@ -161,12 +161,12 @@ Specifies the ``Node`` or ``Object`` instance containing the method to be called
.. rst-class:: classref-property
String **result_var** = ``""``
StringName **result_var** = ``&""``
.. rst-class:: classref-property-setget
- void **set_result_var** **(** String value **)**
- String **get_result_var** **(** **)**
- void **set_result_var** **(** StringName value **)**
- StringName **get_result_var** **(** **)**
if non-empty, assign the result of the method call to the blackboard variable specified by this property.

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

@ -35,11 +35,11 @@ Properties
.. table::
:widths: auto
+--------+------------------------------------------------------+--------+
| String | :ref:`array_var<class_BTForEach_property_array_var>` | ``""`` |
+--------+------------------------------------------------------+--------+
| String | :ref:`save_var<class_BTForEach_property_save_var>` | ``""`` |
+--------+------------------------------------------------------+--------+
+------------+------------------------------------------------------+---------+
| StringName | :ref:`array_var<class_BTForEach_property_array_var>` | ``&""`` |
+------------+------------------------------------------------------+---------+
| StringName | :ref:`save_var<class_BTForEach_property_save_var>` | ``&""`` |
+------------+------------------------------------------------------+---------+
.. rst-class:: classref-section-separator
@ -54,12 +54,12 @@ Property Descriptions
.. rst-class:: classref-property
String **array_var** = ``""``
StringName **array_var** = ``&""``
.. rst-class:: classref-property-setget
- void **set_array_var** **(** String value **)**
- String **get_array_var** **(** **)**
- void **set_array_var** **(** StringName value **)**
- StringName **get_array_var** **(** **)**
A variable within the :ref:`Blackboard<class_Blackboard>` that holds an ``Array``, which is used for the iteration process.
@ -71,12 +71,12 @@ A variable within the :ref:`Blackboard<class_Blackboard>` that holds an ``Array`
.. rst-class:: classref-property
String **save_var** = ``""``
StringName **save_var** = ``&""``
.. rst-class:: classref-property-setget
- void **set_save_var** **(** String value **)**
- String **get_save_var** **(** **)**
- void **set_save_var** **(** StringName value **)**
- StringName **get_save_var** **(** **)**
A :ref:`Blackboard<class_Blackboard>` variable used to store an element of the array referenced by :ref:`array_var<class_BTForEach_property_array_var>`.

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

@ -31,13 +31,13 @@ Properties
.. table::
:widths: auto
+-----------------------------------------------+-----------------------------------------------------+--------+
+-----------------------------------------------+-----------------------------------------------------+---------+
| :ref:`Operation<enum_LimboUtility_Operation>` | :ref:`operation<class_BTSetVar_property_operation>` | ``0`` |
+-----------------------------------------------+-----------------------------------------------------+--------+
+-----------------------------------------------+-----------------------------------------------------+---------+
| :ref:`BBVariant<class_BBVariant>` | :ref:`value<class_BTSetVar_property_value>` | |
+-----------------------------------------------+-----------------------------------------------------+--------+
| String | :ref:`variable<class_BTSetVar_property_variable>` | ``""`` |
+-----------------------------------------------+-----------------------------------------------------+--------+
+-----------------------------------------------+-----------------------------------------------------+---------+
| StringName | :ref:`variable<class_BTSetVar_property_variable>` | ``&""`` |
+-----------------------------------------------+-----------------------------------------------------+---------+
.. rst-class:: classref-section-separator
@ -88,12 +88,12 @@ Parameter that specifies the value to be assigned to the variable.
.. rst-class:: classref-property
String **variable** = ``""``
StringName **variable** = ``&""``
.. rst-class:: classref-property-setget
- void **set_variable** **(** String value **)**
- String **get_variable** **(** **)**
- void **set_variable** **(** StringName value **)**
- StringName **get_variable** **(** **)**
Name of the variable to which the value will be assigned.

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

@ -29,13 +29,13 @@ Properties
.. table::
:widths: auto
+-----------------------------------------+------------------------------------------------------------+---------------+
+-----------------------------------------+------------------------------------------------------------+----------------+
| :ref:`BehaviorTree<class_BehaviorTree>` | :ref:`behavior_tree<class_BTState_property_behavior_tree>` | |
+-----------------------------------------+------------------------------------------------------------+---------------+
| String | :ref:`failure_event<class_BTState_property_failure_event>` | ``"failure"`` |
+-----------------------------------------+------------------------------------------------------------+---------------+
| String | :ref:`success_event<class_BTState_property_success_event>` | ``"success"`` |
+-----------------------------------------+------------------------------------------------------------+---------------+
+-----------------------------------------+------------------------------------------------------------+----------------+
| StringName | :ref:`failure_event<class_BTState_property_failure_event>` | ``&"failure"`` |
+-----------------------------------------+------------------------------------------------------------+----------------+
| StringName | :ref:`success_event<class_BTState_property_success_event>` | ``&"success"`` |
+-----------------------------------------+------------------------------------------------------------+----------------+
.. rst-class:: classref-reftable-group
@ -79,12 +79,12 @@ A :ref:`BehaviorTree<class_BehaviorTree>` resource that defines state behavior.
.. rst-class:: classref-property
String **failure_event** = ``"failure"``
StringName **failure_event** = ``&"failure"``
.. rst-class:: classref-property-setget
- void **set_failure_event** **(** String value **)**
- String **get_failure_event** **(** **)**
- void **set_failure_event** **(** StringName value **)**
- StringName **get_failure_event** **(** **)**
HSM event that will be dispatched when the behavior tree results in ``FAILURE``. See :ref:`LimboState.dispatch<class_LimboState_method_dispatch>`.
@ -96,12 +96,12 @@ HSM event that will be dispatched when the behavior tree results in ``FAILURE``.
.. rst-class:: classref-property
String **success_event** = ``"success"``
StringName **success_event** = ``&"success"``
.. rst-class:: classref-property-setget
- void **set_success_event** **(** String value **)**
- String **get_success_event** **(** **)**
- void **set_success_event** **(** StringName value **)**
- StringName **get_success_event** **(** **)**
HSM event that will be dispatched when the behavior tree results in ``SUCCESS``. See :ref:`LimboState.dispatch<class_LimboState_method_dispatch>`.

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

@ -45,19 +45,19 @@ Methods
.. table::
:widths: auto
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_transition<class_LimboHSM_method_add_transition>` **(** :ref:`LimboState<class_LimboState>` p_from_state, :ref:`LimboState<class_LimboState>` p_to_state, String p_event **)** |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_transition<class_LimboHSM_method_add_transition>` **(** :ref:`LimboState<class_LimboState>` p_from_state, :ref:`LimboState<class_LimboState>` p_to_state, StringName p_event **)** |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`get_active_state<class_LimboHSM_method_get_active_state>` **(** **)** |const| |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`get_leaf_state<class_LimboHSM_method_get_leaf_state>` **(** **)** |const| |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`initialize<class_LimboHSM_method_initialize>` **(** Node p_agent, :ref:`Blackboard<class_Blackboard>` p_parent_scope=null **)** |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_active<class_LimboHSM_method_set_active>` **(** bool p_active **)** |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update<class_LimboHSM_method_update>` **(** float p_delta **)** |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@ -183,7 +183,7 @@ Method Descriptions
.. rst-class:: classref-method
void **add_transition** **(** :ref:`LimboState<class_LimboState>` p_from_state, :ref:`LimboState<class_LimboState>` p_to_state, String p_event **)**
void **add_transition** **(** :ref:`LimboState<class_LimboState>` p_from_state, :ref:`LimboState<class_LimboState>` p_to_state, StringName p_event **)**
Establishes a transition from one state to another when ``p_event`` is dispatched. Both ``p_from_state`` and ``p_to_state`` must be immediate children of this state.

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

@ -36,7 +36,7 @@ Properties
:widths: auto
+---------------------------------------------+-------------------------------------------------------------------+
| String | :ref:`EVENT_FINISHED<class_LimboState_property_EVENT_FINISHED>` |
| StringName | :ref:`EVENT_FINISHED<class_LimboState_property_EVENT_FINISHED>` |
+---------------------------------------------+-------------------------------------------------------------------+
| Node | :ref:`agent<class_LimboState_property_agent>` |
+---------------------------------------------+-------------------------------------------------------------------+
@ -53,35 +53,35 @@ Methods
.. table::
:widths: auto
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_enter<class_LimboState_private_method__enter>` **(** **)** |virtual| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_exit<class_LimboState_private_method__exit>` **(** **)** |virtual| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_setup<class_LimboState_private_method__setup>` **(** **)** |virtual| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_update<class_LimboState_private_method__update>` **(** float p_delta **)** |virtual| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_event_handler<class_LimboState_method_add_event_handler>` **(** String p_event, Callable p_handler **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_event_handler<class_LimboState_method_add_event_handler>` **(** StringName p_event, Callable p_handler **)** |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`call_on_enter<class_LimboState_method_call_on_enter>` **(** Callable p_callable **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`call_on_exit<class_LimboState_method_call_on_exit>` **(** Callable p_callable **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`call_on_update<class_LimboState_method_call_on_update>` **(** Callable p_callable **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_guard<class_LimboState_method_clear_guard>` **(** **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| bool | :ref:`dispatch<class_LimboState_method_dispatch>` **(** String p_event, Variant p_cargo=null **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| bool | :ref:`dispatch<class_LimboState_method_dispatch>` **(** StringName p_event, Variant p_cargo=null **)** |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`get_root<class_LimboState_method_get_root>` **(** **)** |const| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| bool | :ref:`is_active<class_LimboState_method_is_active>` **(** **)** |const| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`LimboState<class_LimboState>` | :ref:`named<class_LimboState_method_named>` **(** String p_name **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_guard<class_LimboState_method_set_guard>` **(** Callable p_guard_callable **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@ -149,11 +149,11 @@ Property Descriptions
.. rst-class:: classref-property
String **EVENT_FINISHED**
StringName **EVENT_FINISHED**
.. rst-class:: classref-property-setget
- String **event_finished** **(** **)**
- StringName **event_finished** **(** **)**
A commonly used event that indicates that the state has finished its work.
@ -268,7 +268,7 @@ Called during the update. Implement your state's behavior with this method.
.. rst-class:: classref-method
void **add_event_handler** **(** String p_event, Callable p_handler **)**
void **add_event_handler** **(** StringName p_event, Callable p_handler **)**
Registers a ``p_handler`` to be called when ``p_event`` is dispatched.
@ -328,7 +328,7 @@ Clears the guard function, removing the ``Callable`` previously set by :ref:`set
.. rst-class:: classref-method
bool **dispatch** **(** String p_event, Variant p_cargo=null **)**
bool **dispatch** **(** StringName p_event, Variant p_cargo=null **)**
Recursively dispatches a state machine event named ``p_event`` with an optional argument ``p_cargo``. Returns ``true`` if the event was consumed.

2
doc_classes/BBParam.xml
View File

@ -33,7 +33,7 @@
<member name="value_source" type="int" setter="set_value_source" getter="get_value_source" enum="BBParam.ValueSource" default="0">
Specifies the source of the value for BBParam. See [enum ValueSource].
</member>
<member name="variable" type="String" setter="set_variable" getter="get_variable">
<member name="variable" type="StringName" setter="set_variable" getter="get_variable">
Stores the name of a [Blackboard] variable when [member value_source] is set to [constant BLACKBOARD_VAR].
</member>
</members>

2
doc_classes/BTCallMethod.xml
View File

@ -22,7 +22,7 @@
<member name="node" type="BBNode" setter="set_node_param" getter="get_node_param">
Specifies the [Node] or [Object] instance containing the method to be called.
</member>
<member name="result_var" type="String" setter="set_result_var" getter="get_result_var" default="&quot;&quot;">
<member name="result_var" type="StringName" setter="set_result_var" getter="get_result_var" default="&amp;&quot;&quot;">
if non-empty, assign the result of the method call to the blackboard variable specified by this property.
</member>
</members>

2
doc_classes/BTCheckTrigger.xml
View File

@ -10,7 +10,7 @@
<tutorials>
</tutorials>
<members>
<member name="variable" type="String" setter="set_variable" getter="get_variable" default="&quot;&quot;">
<member name="variable" type="StringName" setter="set_variable" getter="get_variable" default="&amp;&quot;&quot;">
A boolean variable on the blackboard used as a trigger. See also [member BTTask.blackboard].
If variable's value is [code]true[/code], [BTCheckTrigger] will switch it to [code]false[/code] and return [code]SUCCESS[/code].
If variable's value is [code]false[/code], [BTCheckTrigger] will return [code]FAILURE[/code].

2
doc_classes/BTCheckVar.xml
View File

@ -15,7 +15,7 @@
<member name="value" type="BBVariant" setter="set_value" getter="get_value">
A parameter that specifies the value against which the [member variable] will be compared.
</member>
<member name="variable" type="String" setter="set_variable" getter="get_variable" default="&quot;&quot;">
<member name="variable" type="StringName" setter="set_variable" getter="get_variable" default="&amp;&quot;&quot;">
The name of the variable to check its value.
</member>
</members>

2
doc_classes/BTCooldown.xml
View File

@ -12,7 +12,7 @@
<tutorials>
</tutorials>
<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="StringName" setter="set_cooldown_state_var" getter="get_cooldown_state_var" default="&amp;&quot;&quot;">
A boolean variable used to store the cooldown state in the [Blackboard]. If left empty, the variable will be automatically generated and assigned.
If the variable's value is set to [code]true[/code], it indicates that the cooldown is activated. This feature is useful for checking the cooldown state from other parts of the tree or sharing it among different sections of the [BehaviorTree].
</member>

2
doc_classes/BTEvaluateExpression.xml
View File

@ -36,7 +36,7 @@
<member name="node" type="BBNode" setter="set_node_param" getter="get_node_param">
Specifies the [Node] or [Object] instance containing the method to be called.
</member>
<member name="result_var" type="String" setter="set_result_var" getter="get_result_var" default="&quot;&quot;">
<member name="result_var" type="StringName" setter="set_result_var" getter="get_result_var" default="&amp;&quot;&quot;">
if non-empty, assign the result of the method call to the blackboard variable specified by this property.
</member>
</members>

4
doc_classes/BTForEach.xml
View File

@ -12,10 +12,10 @@
<tutorials>
</tutorials>
<members>
<member name="array_var" type="String" setter="set_array_var" getter="get_array_var" default="&quot;&quot;">
<member name="array_var" type="StringName" setter="set_array_var" getter="get_array_var" default="&amp;&quot;&quot;">
A variable within the [Blackboard] that holds an [Array], which is used for the iteration process.
</member>
<member name="save_var" type="String" setter="set_save_var" getter="get_save_var" default="&quot;&quot;">
<member name="save_var" type="StringName" setter="set_save_var" getter="get_save_var" default="&amp;&quot;&quot;">
A [Blackboard] variable used to store an element of the array referenced by [member array_var].
</member>
</members>

2
doc_classes/BTSetVar.xml
View File

@ -17,7 +17,7 @@
<member name="value" type="BBVariant" setter="set_value" getter="get_value">
Parameter that specifies the value to be assigned to the variable.
</member>
<member name="variable" type="String" setter="set_variable" getter="get_variable" default="&quot;&quot;">
<member name="variable" type="StringName" setter="set_variable" getter="get_variable" default="&amp;&quot;&quot;">
Name of the variable to which the value will be assigned.
</member>
</members>

4
doc_classes/BTState.xml
View File

@ -20,10 +20,10 @@
<member name="behavior_tree" type="BehaviorTree" setter="set_behavior_tree" getter="get_behavior_tree">
A [BehaviorTree] resource that defines state behavior.
</member>
<member name="failure_event" type="String" setter="set_failure_event" getter="get_failure_event" default="&quot;failure&quot;">
<member name="failure_event" type="StringName" setter="set_failure_event" getter="get_failure_event" default="&amp;&quot;failure&quot;">
HSM event that will be dispatched when the behavior tree results in [code]FAILURE[/code]. See [method LimboState.dispatch].
</member>
<member name="success_event" type="String" setter="set_success_event" getter="get_success_event" default="&quot;success&quot;">
<member name="success_event" type="StringName" setter="set_success_event" getter="get_success_event" default="&amp;&quot;success&quot;">
HSM event that will be dispatched when the behavior tree results in [code]SUCCESS[/code]. See [method LimboState.dispatch].
</member>
</members>

12
doc_classes/Blackboard.xml
View File

@ -13,7 +13,7 @@
<methods>
<method name="bind_var_to_property">
<return type="void" />
<param index="0" name="p_name" type="String" />
<param index="0" name="p_name" type="StringName" />
<param index="1" name="p_object" type="Object" />
<param index="2" name="p_property" type="StringName" />
<description>
@ -22,7 +22,7 @@
</method>
<method name="erase_var">
<return type="void" />
<param index="0" name="p_name" type="String" />
<param index="0" name="p_name" type="StringName" />
<description>
Removes a variable by its name.
</description>
@ -35,7 +35,7 @@
</method>
<method name="get_var" qualifiers="const">
<return type="Variant" />
<param index="0" name="p_name" type="String" />
<param index="0" name="p_name" type="StringName" />
<param index="1" name="p_default" type="Variant" default="null" />
<param index="2" name="p_complain" type="bool" default="true" />
<description>
@ -44,7 +44,7 @@
</method>
<method name="has_var" qualifiers="const">
<return type="bool" />
<param index="0" name="p_name" type="String" />
<param index="0" name="p_name" type="StringName" />
<description>
Returns [code]true[/code] if the Blackboard contains the [param p_name] variable, including the parent scopes.
</description>
@ -65,7 +65,7 @@
</method>
<method name="set_var">
<return type="void" />
<param index="0" name="p_name" type="String" />
<param index="0" name="p_name" type="StringName" />
<param index="1" name="p_value" type="Variant" />
<description>
Assigns a value to a Blackboard variable.
@ -79,7 +79,7 @@
</method>
<method name="unbind_var">
<return type="void" />
<param index="0" name="p_name" type="String" />
<param index="0" name="p_name" type="StringName" />
<description>
Remove binding from a variable.
</description>

2
doc_classes/BlackboardPlan.xml
View File

@ -19,7 +19,7 @@
<param index="0" name="p_blackboard" type="Blackboard" />
<param index="1" name="p_overwrite" type="bool" />
<description>
Populates [param p_blackboard] with the variables from this plan. If [param p_override] is [code]true[/code], existing variables with the same names will be overwritten.
Populates [param p_blackboard] with the variables from this plan. If [param p_overwrite] is [code]true[/code], existing variables with the same names will be overwritten.
</description>
</method>
</methods>

2
doc_classes/LimboHSM.xml
View File

@ -13,7 +13,7 @@
<return type="void" />
<param index="0" name="p_from_state" type="LimboState" />
<param index="1" name="p_to_state" type="LimboState" />
<param index="2" name="p_event" type="String" />
<param index="2" name="p_event" type="StringName" />
<description>
Establishes a transition from one state to another when [param p_event] is dispatched. Both [param p_from_state] and [param p_to_state] must be immediate children of this state.
</description>

6
doc_classes/LimboState.xml
View File

@ -38,7 +38,7 @@
</method>
<method name="add_event_handler">
<return type="void" />
<param index="0" name="p_event" type="String" />
<param index="0" name="p_event" type="StringName" />
<param index="1" name="p_handler" type="Callable" />
<description>
Registers a [param p_handler] to be called when [param p_event] is dispatched.
@ -73,7 +73,7 @@
</method>
<method name="dispatch">
<return type="bool" />
<param index="0" name="p_event" type="String" />
<param index="0" name="p_event" type="StringName" />
<param index="1" name="p_cargo" type="Variant" default="null" />
<description>
Recursively dispatches a state machine event named [param p_event] with an optional argument [param p_cargo]. Returns [code]true[/code] if the event was consumed.
@ -108,7 +108,7 @@
</method>
</methods>
<members>
<member name="EVENT_FINISHED" type="String" setter="" getter="event_finished">
<member name="EVENT_FINISHED" type="StringName" setter="" getter="event_finished">
A commonly used event that indicates that the state has finished its work.
</member>
<member name="agent" type="Node" setter="set_agent" getter="get_agent">