Feature request: CBA_statemachine_fnc_addCompoundState

[Fusselwurm]

The ability for states to include substates by nesting a state machine – thus creating compound states – would be a nice addition the CBA state machine library.

( see also https://statecharts.github.io/glossary/compound-state.html )

tl;dr:

• entering the compound state adds the item to the initial state in the nested state machine
• exiting the compound state
  • executes the nested state's onExit handler
  • removes the item from the nested state machine

Proposed interface:

Description

Adds a compound state to a state machine.

Parameters

name	description	type
_stateMachine	state machine	<LOCATION>
_nestedStateMachine	state machine to be nested in the state	<LOCATION>
_onState	code that is executed when state is active (frequency depends on amount of objects active in state machine)	<CODE> (Default: {})
_onStateEntered	code that is executed once when state was entered, after onTransition (also once for the intial state)	<CODE> (Default: {})
_onStateLeaving	code that is executed once when exiting state, before onTransition	<CODE> (Default: {})
_name	unique state name	STRING (Default: “stateX” with X being a unique number)

Returns

	description	type
_name	unique state name or empty string on error	<STRING>

Examples

_name = [_stateMachine, _nestedMachine, {}] call CBA_statemachine_fnc_addCompoundState;

[Fusselwurm]

🤔 two ways to approach this:

https://github.com/CBATeam/CBA_A3/compare/master...gruppe-adler:add-compound-state-1?expand=1
https://github.com/CBATeam/CBA_A3/compare/master...gruppe-adler:add-compound-state-2?expand=1