diff --git a/doc_classes/LimboHSM.xml b/doc_classes/LimboHSM.xml index 11ec342..05a1caf 100644 --- a/doc_classes/LimboHSM.xml +++ b/doc_classes/LimboHSM.xml @@ -4,8 +4,7 @@ Event-based Hierarchical State Machine (HSM). - Event-based Hierarchical State Machine (HSM). - Manages [LimboState] instances and transitions between them. LimboHSM is a [LimboState] itself, and can be a child of another LimboHSM instance. + Event-based Hierarchical State Machine (HSM) that manages [LimboState] instances and facilitates transitions between them. LimboHSM is a [LimboState] in itself and can also serve as a child of another LimboHSM node. @@ -16,19 +15,19 @@ - Adds a transition from one state to another when [code]p_event[/code] is dispatched. + Establishes a transition from one state to another when [code]p_event[/code] is dispatched. Both [code]p_from_state[/code] and [code]p_to_state[/code] must be immediate children of this state. - Returns active state. + Returns the currently active substate. - Returns the leaf state that is currently active in HSM. + Returns the currently active leaf state within the state machine. @@ -36,53 +35,52 @@ - Initializes state and calls [code]_setup[/code] for itself and every substate. + Initiates the state and calls [code]_setup[/code] for both itself and all substates. - If [code]true[/code], changes state to [member initial_state] and enables state processing depending on [member update_mode]. + When set to [code]true[/code], switches the state to [member initial_state] and activates state processing according to [member update_mode]. - Calls [method 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]. + Calls [method LimboState._update] on itself and the active substate, with the call cascading down to the leaf state. This method is automatically triggered if [member update_mode] is not set to [constant MANUAL]. - Useful to define a transition from any state. + Useful for defining a transition from any state. - A state that becomes active when state machine is activated by [method set_active] method. + The substate that becomes active when the state machine is activated using the [method set_active] method. If not explicitly set, the first child of the LimboHSM will be considered the initial state. - Determines when state machine is updated. See [enum UpdateMode]. + Specifies when the state machine should be updated. See [enum UpdateMode]. - Emitted when state is changed. + Emitted when the currently active substate is switched to a different substate. - Update state machine during idle process. + Update the state machine during the idle process. - Update state machine during physics process. + Update the state machine during the physics process. - Update state machine manually by calling [method update] from a script. + Manually update the state machine by calling [method update] from a script. diff --git a/doc_classes/LimboUtility.xml b/doc_classes/LimboUtility.xml index 3edb3b8..e6fee10 100644 --- a/doc_classes/LimboUtility.xml +++ b/doc_classes/LimboUtility.xml @@ -12,36 +12,42 @@ - Returns a string with a [Blackboard] variable name ready to be displayed or printed to console. + Produces a string with a [Blackboard] variable name that is formatted for display or console output. - Returns name of a [BTTask] status code. + Returns a name of a [BTTask] status code. - Returns the icon texture associated with a task, given its class name or script resource path. + Returns the icon texture associated with a task based on its class name or script resource path. + Equality Check. + Less Than Check. + Less Than or Equal To Check. + Greater Than Check. + Greater Than or Equal To Check + Inequality Check.