Added onStateEntered and onStateLeaving functions

Author: BaerMitUmlaut

addons/statemachine/example.hpp

@@ -13,6 +13,8 @@ class MyAddon_Statemachine {
     // States are just subclasses of the state machine
     class Initial {
         onState = "";
+        onStateEntered = "";
+        onStateLeaving = "";
 
         // Transitions are also just subclasses of states
         class InCombat {

addons/statemachine/example.sqf

@@ -12,11 +12,12 @@
 
 private _stateMachine = [{allGroups select {!isPlayer leader _x}}] call CBA_statemachine_fnc_create;
 
-[_stateMachine, {}, "Initial"] call CBA_statemachine_fnc_addState;
-[_stateMachine, {}, "Alert"] call CBA_statemachine_fnc_addState;
+[_stateMachine, {}, {}, {}, "Initial"] call CBA_statemachine_fnc_addState;
+[_stateMachine, {}, {}, {}, "Alert"] call CBA_statemachine_fnc_addState;
 
 [_stateMachine, "Initial", "Alert", {combatMode _this == "YELLOW"}, {
     // Set skill once on transition
+    // This could also be done in the onStateEntered function
     {
         _x setSkill ["spotDistance", ((_x skill "spotDistance") * 1.5) min 1];
         _x setSkill ["spotTime",     ((_x skill "spotTime")     * 1.5) min 1];

addons/statemachine/fnc_addState.sqf

@@ -9,6 +9,13 @@ Parameters:
     _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)
 
@@ -28,6 +35,8 @@ SCRIPT(addState);
 params [
     ["_stateMachine", locationNull, [locationNull]],
     ["_onState", {}, [{}]],
+    ["_onStateEntered", {}, [{}]],
+    ["_onStateLeaving", {}, [{}]],
     ["_name", "", [""]]
 ];
 
@@ -45,6 +54,8 @@ if (_name == "") then {
 _states pushBack _name;
 _stateMachine setVariable [QGVAR(states), _states];
 _stateMachine setVariable [ONSTATE(_name), _onState];
+_stateMachine setVariable [ONSTATEENTERED(_name), _onStateEntered];
+_stateMachine setVariable [ONSTATELEAVING(_name), _onStateLeaving];
 _stateMachine setVariable [TRANSITIONS(_name), []];
 
 diag_log "derp";

addons/statemachine/fnc_clockwork.sqf

@@ -41,7 +41,15 @@ SCRIPT(clockwork);
             _stateMachine setVariable [QGVAR(tick), _tick + 1];
 
             private _current = _list select _tick;
-            private _thisState = _current getVariable [QGVAR(state) + str _id, _stateMachine getVariable QGVAR(initialState)];
+            private _thisState = _current getVariable (QGVAR(state) + str _id);
+
+            if (isNil "_thisState") then {
+                // Item is new and gets set to the intial state, onStateEntered
+                // function of initial state gets executed as well.
+                _thisState = _stateMachine getVariable QGVAR(initialState);
+                _current setVariable [QGVAR(state) + str _id, _thisState];
+                _current call (_stateMachine getVariable ONSTATEENTERED(_thisState));
+            };
 
             // onState functions can use:
             //   _stateMachine - the state machine
@@ -52,15 +60,24 @@ SCRIPT(clockwork);
             private _thisOrigin = _thisState;
             {
                 _x params ["_thisTransition", "_condition", "_thisTarget", "_onTransition"];
-                // Transition conditions and onTransition functions can use:
+                // Transition conditions, onTransition, onStateLeaving and
+                // onStateEntered functions can use:
                 //   _stateMachine   - the state machine
                 //   _this           - the current list item
                 //   _thisTransition - the current transition we're in
                 //   _thisOrigin     - the state we're coming from
+                //   _thisState      - same as _thisOrigin
                 //   _thisTarget     - the state we're transitioning to
+                // Note: onTransition and onStateLeaving functions can change
+                //       the transition target by overwriting the passed
+                //       _thisTarget variable.
+                // Note: onStateEntered functions of initial states won't have
+                //       some of these variables defined.
                 if (_current call _condition) exitWith {
+                    _current call (_stateMachine getVariable ONSTATELEAVING(_thisOrigin));
                     _current call _onTransition;
                     _current setVariable [QGVAR(state) + str _id, _thisTarget];
+                    _current call (_stateMachine getVariable ONSTATEENTERED(_thisTarget));
                 };
             } forEach (_stateMachine getVariable TRANSITIONS(_thisState));
         };

addons/statemachine/fnc_createFromConfig.sqf

@@ -32,7 +32,9 @@ private _stateMachine = [_list] call FUNC(create);
 {
     private _state = configName _x;
     private _onState = compile getText (_x >> "onState");
-    [_stateMachine, _onState, _state] call FUNC(addState);
+    private _onStateEntered = compile getText (_x >> "onStateEntered");
+    private _onStateLeaving = compile getText (_x >> "onStateLeaving");
+    [_stateMachine, _onState, _onStateEntered, _onStateLeaving, _state] call FUNC(addState);
 
     false
 } count ("true" configClasses _config);

addons/statemachine/script_component.hpp

@@ -15,3 +15,5 @@
 
 #define TRANSITIONS(var) (var + "_transitions")
 #define ONSTATE(var) (var + "_onState")
+#define ONSTATEENTERED(var) (var + "_onStateEntered")
+#define ONSTATELEAVING(var) (var + "_onStateLeaving")