diff --git a/doc/source/classes/class_bbparam.rst b/doc/source/classes/class_bbparam.rst index 04ba624..b9c3f04 100644 --- a/doc/source/classes/class_bbparam.rst +++ b/doc/source/classes/class_bbparam.rst @@ -38,7 +38,7 @@ Properties +----------------------------------------------+----------------------------------------------------------+----------+ | :ref:`ValueSource` | :ref:`value_source` | ``0`` | +----------------------------------------------+----------------------------------------------------------+----------+ - | String | :ref:`variable` | | + | StringName | :ref:`variable` | | +----------------------------------------------+----------------------------------------------------------+----------+ .. rst-class:: classref-reftable-group @@ -133,12 +133,12 @@ Specifies the source of the value for BBParam. See :ref:`ValueSource` variable when :ref:`value_source` is set to :ref:`BLACKBOARD_VAR`. diff --git a/doc/source/classes/class_blackboard.rst b/doc/source/classes/class_blackboard.rst index c9c2358..c026a54 100644 --- a/doc/source/classes/class_blackboard.rst +++ b/doc/source/classes/class_blackboard.rst @@ -33,27 +33,27 @@ Methods .. table:: :widths: auto - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`bind_var_to_property` **(** String p_name, Object p_object, StringName p_property **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`erase_var` **(** String p_name **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Blackboard` | :ref:`get_parent` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | Variant | :ref:`get_var` **(** String p_name, Variant p_default=null, bool p_complain=true **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | bool | :ref:`has_var` **(** String p_name **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`prefetch_nodepath_vars` **(** Node p_node **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_parent` **(** :ref:`Blackboard` p_blackboard **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_var` **(** String p_name, Variant p_value **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Blackboard` | :ref:`top` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`unbind_var` **(** String p_name **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`bind_var_to_property` **(** StringName p_name, Object p_object, StringName p_property **)** | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`erase_var` **(** StringName p_name **)** | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Blackboard` | :ref:`get_parent` **(** **)** |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | Variant | :ref:`get_var` **(** StringName p_name, Variant p_default=null, bool p_complain=true **)** |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | bool | :ref:`has_var` **(** StringName p_name **)** |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`prefetch_nodepath_vars` **(** Node p_node **)** | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_parent` **(** :ref:`Blackboard` p_blackboard **)** | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_var` **(** StringName p_name, Variant p_value **)** | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Blackboard` | :ref:`top` **(** **)** |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`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. diff --git a/doc/source/classes/class_blackboardplan.rst b/doc/source/classes/class_blackboardplan.rst index d08ac4a..2c967d6 100644 --- a/doc/source/classes/class_blackboardplan.rst +++ b/doc/source/classes/class_blackboardplan.rst @@ -55,7 +55,7 @@ Constructs a new instance of a :ref:`Blackboard` using this pl void **populate_blackboard** **(** :ref:`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.)` diff --git a/doc/source/classes/class_btcallmethod.rst b/doc/source/classes/class_btcallmethod.rst index 231f27f..c9d75b9 100644 --- a/doc/source/classes/class_btcallmethod.rst +++ b/doc/source/classes/class_btcallmethod.rst @@ -40,7 +40,7 @@ Properties +-------------------------------------+---------------------------------------------------------------------------+-----------+ | :ref:`BBNode` | :ref:`node` | | +-------------------------------------+---------------------------------------------------------------------------+-----------+ - | String | :ref:`result_var` | ``""`` | + | StringName | :ref:`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. diff --git a/doc/source/classes/class_btchecktrigger.rst b/doc/source/classes/class_btchecktrigger.rst index 24efade..11c322c 100644 --- a/doc/source/classes/class_btchecktrigger.rst +++ b/doc/source/classes/class_btchecktrigger.rst @@ -31,9 +31,9 @@ Properties .. table:: :widths: auto - +--------+---------------------------------------------------------+--------+ - | String | :ref:`variable` | ``""`` | - +--------+---------------------------------------------------------+--------+ + +------------+---------------------------------------------------------+---------+ + | StringName | :ref:`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`. diff --git a/doc/source/classes/class_btcheckvar.rst b/doc/source/classes/class_btcheckvar.rst index 17ec6f6..7720350 100644 --- a/doc/source/classes/class_btcheckvar.rst +++ b/doc/source/classes/class_btcheckvar.rst @@ -29,13 +29,13 @@ Properties .. table:: :widths: auto - +-----------------------------------------------+---------------------------------------------------------+--------+ - | :ref:`CheckType` | :ref:`check_type` | ``0`` | - +-----------------------------------------------+---------------------------------------------------------+--------+ - | :ref:`BBVariant` | :ref:`value` | | - +-----------------------------------------------+---------------------------------------------------------+--------+ - | String | :ref:`variable` | ``""`` | - +-----------------------------------------------+---------------------------------------------------------+--------+ + +-----------------------------------------------+---------------------------------------------------------+---------+ + | :ref:`CheckType` | :ref:`check_type` | ``0`` | + +-----------------------------------------------+---------------------------------------------------------+---------+ + | :ref:`BBVariant` | :ref:`value` | | + +-----------------------------------------------+---------------------------------------------------------+---------+ + | StringName | :ref:`variable` | ``&""`` | + +-----------------------------------------------+---------------------------------------------------------+---------+ .. rst-class:: classref-section-separator @@ -84,12 +84,12 @@ A parameter that specifies the value against which the :ref:`variable` | ``""`` | - +--------+-------------------------------------------------------------------------+-----------+ - | float | :ref:`duration` | ``10.0`` | - +--------+-------------------------------------------------------------------------+-----------+ - | bool | :ref:`process_pause` | ``false`` | - +--------+-------------------------------------------------------------------------+-----------+ - | bool | :ref:`start_cooled` | ``false`` | - +--------+-------------------------------------------------------------------------+-----------+ - | bool | :ref:`trigger_on_failure` | ``false`` | - +--------+-------------------------------------------------------------------------+-----------+ + +------------+-------------------------------------------------------------------------+-----------+ + | StringName | :ref:`cooldown_state_var` | ``&""`` | + +------------+-------------------------------------------------------------------------+-----------+ + | float | :ref:`duration` | ``10.0`` | + +------------+-------------------------------------------------------------------------+-----------+ + | bool | :ref:`process_pause` | ``false`` | + +------------+-------------------------------------------------------------------------+-----------+ + | bool | :ref:`start_cooled` | ``false`` | + +------------+-------------------------------------------------------------------------+-----------+ + | bool | :ref:`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`. If left empty, the variable will be automatically generated and assigned. diff --git a/doc/source/classes/class_btevaluateexpression.rst b/doc/source/classes/class_btevaluateexpression.rst index 422c43f..2151893 100644 --- a/doc/source/classes/class_btevaluateexpression.rst +++ b/doc/source/classes/class_btevaluateexpression.rst @@ -42,7 +42,7 @@ Properties +-------------------------------------+-------------------------------------------------------------------------------------+-------------------------+ | :ref:`BBNode` | :ref:`node` | | +-------------------------------------+-------------------------------------------------------------------------------------+-------------------------+ - | String | :ref:`result_var` | ``""`` | + | StringName | :ref:`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. diff --git a/doc/source/classes/class_btforeach.rst b/doc/source/classes/class_btforeach.rst index f04bab6..af9c2d7 100644 --- a/doc/source/classes/class_btforeach.rst +++ b/doc/source/classes/class_btforeach.rst @@ -35,11 +35,11 @@ Properties .. table:: :widths: auto - +--------+------------------------------------------------------+--------+ - | String | :ref:`array_var` | ``""`` | - +--------+------------------------------------------------------+--------+ - | String | :ref:`save_var` | ``""`` | - +--------+------------------------------------------------------+--------+ + +------------+------------------------------------------------------+---------+ + | StringName | :ref:`array_var` | ``&""`` | + +------------+------------------------------------------------------+---------+ + | StringName | :ref:`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` that holds an ``Array``, which is used for the iteration process. @@ -71,12 +71,12 @@ A variable within the :ref:`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` variable used to store an element of the array referenced by :ref:`array_var`. diff --git a/doc/source/classes/class_btsetvar.rst b/doc/source/classes/class_btsetvar.rst index 7b27305..219f93f 100644 --- a/doc/source/classes/class_btsetvar.rst +++ b/doc/source/classes/class_btsetvar.rst @@ -31,13 +31,13 @@ Properties .. table:: :widths: auto - +-----------------------------------------------+-----------------------------------------------------+--------+ - | :ref:`Operation` | :ref:`operation` | ``0`` | - +-----------------------------------------------+-----------------------------------------------------+--------+ - | :ref:`BBVariant` | :ref:`value` | | - +-----------------------------------------------+-----------------------------------------------------+--------+ - | String | :ref:`variable` | ``""`` | - +-----------------------------------------------+-----------------------------------------------------+--------+ + +-----------------------------------------------+-----------------------------------------------------+---------+ + | :ref:`Operation` | :ref:`operation` | ``0`` | + +-----------------------------------------------+-----------------------------------------------------+---------+ + | :ref:`BBVariant` | :ref:`value` | | + +-----------------------------------------------+-----------------------------------------------------+---------+ + | StringName | :ref:`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. diff --git a/doc/source/classes/class_btstate.rst b/doc/source/classes/class_btstate.rst index cfe4e6e..2d501bb 100644 --- a/doc/source/classes/class_btstate.rst +++ b/doc/source/classes/class_btstate.rst @@ -29,13 +29,13 @@ Properties .. table:: :widths: auto - +-----------------------------------------+------------------------------------------------------------+---------------+ - | :ref:`BehaviorTree` | :ref:`behavior_tree` | | - +-----------------------------------------+------------------------------------------------------------+---------------+ - | String | :ref:`failure_event` | ``"failure"`` | - +-----------------------------------------+------------------------------------------------------------+---------------+ - | String | :ref:`success_event` | ``"success"`` | - +-----------------------------------------+------------------------------------------------------------+---------------+ + +-----------------------------------------+------------------------------------------------------------+----------------+ + | :ref:`BehaviorTree` | :ref:`behavior_tree` | | + +-----------------------------------------+------------------------------------------------------------+----------------+ + | StringName | :ref:`failure_event` | ``&"failure"`` | + +-----------------------------------------+------------------------------------------------------------+----------------+ + | StringName | :ref:`success_event` | ``&"success"`` | + +-----------------------------------------+------------------------------------------------------------+----------------+ .. rst-class:: classref-reftable-group @@ -79,12 +79,12 @@ A :ref:`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`. @@ -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`. diff --git a/doc/source/classes/class_limbohsm.rst b/doc/source/classes/class_limbohsm.rst index ada74a1..6766ca4 100644 --- a/doc/source/classes/class_limbohsm.rst +++ b/doc/source/classes/class_limbohsm.rst @@ -45,19 +45,19 @@ Methods .. table:: :widths: auto - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_transition` **(** :ref:`LimboState` p_from_state, :ref:`LimboState` p_to_state, String p_event **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`LimboState` | :ref:`get_active_state` **(** **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`LimboState` | :ref:`get_leaf_state` **(** **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`initialize` **(** Node p_agent, :ref:`Blackboard` p_parent_scope=null **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_active` **(** bool p_active **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`update` **(** float p_delta **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_transition` **(** :ref:`LimboState` p_from_state, :ref:`LimboState` p_to_state, StringName p_event **)** | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`LimboState` | :ref:`get_active_state` **(** **)** |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`LimboState` | :ref:`get_leaf_state` **(** **)** |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`initialize` **(** Node p_agent, :ref:`Blackboard` p_parent_scope=null **)** | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_active` **(** bool p_active **)** | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`update` **(** float p_delta **)** | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -183,7 +183,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_transition** **(** :ref:`LimboState` p_from_state, :ref:`LimboState` p_to_state, String p_event **)** +void **add_transition** **(** :ref:`LimboState` p_from_state, :ref:`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. diff --git a/doc/source/classes/class_limbostate.rst b/doc/source/classes/class_limbostate.rst index baa51ce..8b9bdbb 100644 --- a/doc/source/classes/class_limbostate.rst +++ b/doc/source/classes/class_limbostate.rst @@ -36,7 +36,7 @@ Properties :widths: auto +---------------------------------------------+-------------------------------------------------------------------+ - | String | :ref:`EVENT_FINISHED` | + | StringName | :ref:`EVENT_FINISHED` | +---------------------------------------------+-------------------------------------------------------------------+ | Node | :ref:`agent` | +---------------------------------------------+-------------------------------------------------------------------+ @@ -53,35 +53,35 @@ Methods .. table:: :widths: auto - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_enter` **(** **)** |virtual| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_exit` **(** **)** |virtual| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_setup` **(** **)** |virtual| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_update` **(** float p_delta **)** |virtual| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_event_handler` **(** String p_event, Callable p_handler **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`LimboState` | :ref:`call_on_enter` **(** Callable p_callable **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`LimboState` | :ref:`call_on_exit` **(** Callable p_callable **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`LimboState` | :ref:`call_on_update` **(** Callable p_callable **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_guard` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | bool | :ref:`dispatch` **(** String p_event, Variant p_cargo=null **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`LimboState` | :ref:`get_root` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | bool | :ref:`is_active` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`LimboState` | :ref:`named` **(** String p_name **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_guard` **(** Callable p_guard_callable **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_enter` **(** **)** |virtual| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_exit` **(** **)** |virtual| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_setup` **(** **)** |virtual| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_update` **(** float p_delta **)** |virtual| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_event_handler` **(** StringName p_event, Callable p_handler **)** | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | :ref:`LimboState` | :ref:`call_on_enter` **(** Callable p_callable **)** | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | :ref:`LimboState` | :ref:`call_on_exit` **(** Callable p_callable **)** | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | :ref:`LimboState` | :ref:`call_on_update` **(** Callable p_callable **)** | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`clear_guard` **(** **)** | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | bool | :ref:`dispatch` **(** StringName p_event, Variant p_cargo=null **)** | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | :ref:`LimboState` | :ref:`get_root` **(** **)** |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | bool | :ref:`is_active` **(** **)** |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | :ref:`LimboState` | :ref:`named` **(** String p_name **)** | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`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. diff --git a/doc_classes/BBParam.xml b/doc_classes/BBParam.xml index 61b6cf7..e96ba7c 100644 --- a/doc_classes/BBParam.xml +++ b/doc_classes/BBParam.xml @@ -33,7 +33,7 @@ Specifies the source of the value for BBParam. See [enum ValueSource]. - + Stores the name of a [Blackboard] variable when [member value_source] is set to [constant BLACKBOARD_VAR]. diff --git a/doc_classes/BTCallMethod.xml b/doc_classes/BTCallMethod.xml index 66e8656..ca5a1a9 100644 --- a/doc_classes/BTCallMethod.xml +++ b/doc_classes/BTCallMethod.xml @@ -22,7 +22,7 @@ Specifies the [Node] or [Object] instance containing the method to be called. - + if non-empty, assign the result of the method call to the blackboard variable specified by this property. diff --git a/doc_classes/BTCheckTrigger.xml b/doc_classes/BTCheckTrigger.xml index 0239b1e..6bfa8cd 100644 --- a/doc_classes/BTCheckTrigger.xml +++ b/doc_classes/BTCheckTrigger.xml @@ -10,7 +10,7 @@ - + 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]. diff --git a/doc_classes/BTCheckVar.xml b/doc_classes/BTCheckVar.xml index 1a37389..16ba47d 100644 --- a/doc_classes/BTCheckVar.xml +++ b/doc_classes/BTCheckVar.xml @@ -15,7 +15,7 @@ A parameter that specifies the value against which the [member variable] will be compared. - + The name of the variable to check its value. diff --git a/doc_classes/BTCooldown.xml b/doc_classes/BTCooldown.xml index 1f84cbd..fb04958 100644 --- a/doc_classes/BTCooldown.xml +++ b/doc_classes/BTCooldown.xml @@ -12,7 +12,7 @@ - + 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]. diff --git a/doc_classes/BTEvaluateExpression.xml b/doc_classes/BTEvaluateExpression.xml index 36593a9..e2ee74a 100644 --- a/doc_classes/BTEvaluateExpression.xml +++ b/doc_classes/BTEvaluateExpression.xml @@ -36,7 +36,7 @@ Specifies the [Node] or [Object] instance containing the method to be called. - + if non-empty, assign the result of the method call to the blackboard variable specified by this property. diff --git a/doc_classes/BTForEach.xml b/doc_classes/BTForEach.xml index 2fbe450..7bbd10f 100644 --- a/doc_classes/BTForEach.xml +++ b/doc_classes/BTForEach.xml @@ -12,10 +12,10 @@ - + A variable within the [Blackboard] that holds an [Array], which is used for the iteration process. - + A [Blackboard] variable used to store an element of the array referenced by [member array_var]. diff --git a/doc_classes/BTSetVar.xml b/doc_classes/BTSetVar.xml index dc461ed..dffa89a 100644 --- a/doc_classes/BTSetVar.xml +++ b/doc_classes/BTSetVar.xml @@ -17,7 +17,7 @@ Parameter that specifies the value to be assigned to the variable. - + Name of the variable to which the value will be assigned. diff --git a/doc_classes/BTState.xml b/doc_classes/BTState.xml index 80a490e..d7d5d1a 100644 --- a/doc_classes/BTState.xml +++ b/doc_classes/BTState.xml @@ -20,10 +20,10 @@ A [BehaviorTree] resource that defines state behavior. - + HSM event that will be dispatched when the behavior tree results in [code]FAILURE[/code]. See [method LimboState.dispatch]. - + HSM event that will be dispatched when the behavior tree results in [code]SUCCESS[/code]. See [method LimboState.dispatch]. diff --git a/doc_classes/Blackboard.xml b/doc_classes/Blackboard.xml index e6748a0..9ad8bf0 100644 --- a/doc_classes/Blackboard.xml +++ b/doc_classes/Blackboard.xml @@ -13,7 +13,7 @@ - + @@ -22,7 +22,7 @@ - + Removes a variable by its name. @@ -35,7 +35,7 @@ - + @@ -44,7 +44,7 @@ - + Returns [code]true[/code] if the Blackboard contains the [param p_name] variable, including the parent scopes. @@ -65,7 +65,7 @@ - + Assigns a value to a Blackboard variable. @@ -79,7 +79,7 @@ - + Remove binding from a variable. diff --git a/doc_classes/BlackboardPlan.xml b/doc_classes/BlackboardPlan.xml index 0b39b81..44036d1 100644 --- a/doc_classes/BlackboardPlan.xml +++ b/doc_classes/BlackboardPlan.xml @@ -19,7 +19,7 @@ - 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. diff --git a/doc_classes/LimboHSM.xml b/doc_classes/LimboHSM.xml index 53033be..7928f1d 100644 --- a/doc_classes/LimboHSM.xml +++ b/doc_classes/LimboHSM.xml @@ -13,7 +13,7 @@ - + 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. diff --git a/doc_classes/LimboState.xml b/doc_classes/LimboState.xml index 26eb61f..1994fe1 100644 --- a/doc_classes/LimboState.xml +++ b/doc_classes/LimboState.xml @@ -38,7 +38,7 @@ - + Registers a [param p_handler] to be called when [param p_event] is dispatched. @@ -73,7 +73,7 @@ - + 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 @@ - + A commonly used event that indicates that the state has finished its work.