Click or drag to resize

SimpleStateMachineTcurrentState Property

Current state of the machine.

Namespace:  KSPDev.ProcessingUtils
Assembly:  KSPDev_Utils.1.2 (in KSPDev_Utils.1.2.dll) Version: 1.2 for KSP v1.6+
Syntax
C#
Copy
public Nullable<T> currentState { get; set; }
Request Example View Source

Property Value

Type: NullableT
The current state. It can be null.
Remarks

Setting the same state as the current one is a NO-OP. Setting of a new state may throw an exception in the strict mode.

The initial state is always null, whiсh means STOPPED. The caller must set the initial state before starting using the machine. In spite of the other transitions, the initial state change is not restricted by the state transition constraints, regardless to the isStrict setting.

To STOP the machine, just set the current state to null. No "enter state" handlers will be executed in this case, but all the "leave state" handlers will do their job.

Examples
Copy
class SimpleStateMachineFree {
  public enum State {
    One,
    Two,
    Three
  };

  public void TestMachine() {
    var sm = new SimpleStateMachine<State>(strict: false);
    sm.AddStateHandlers(
        State.One,
        enterHandler: oldState => Debug.Log("Now in state ONE"),
        leaveHandler: newState => Debug.LogFormat("Going into state: {0}", newState));
    sm.onBeforeTransition += (from, to) => Debug.LogFormat(
        "Before move: current={0}, new={1}",
        DbgFormatter.Nullable(sm.currentState), DbgFormatter.Nullable(to));
    sm.onAfterTransition += (from, to) => Debug.LogFormat(
        "After move: old={0}, current={1}",
        DbgFormatter.Nullable(from), DbgFormatter.Nullable(sm.currentState));

    sm.currentState = State.One;  // Start the machine.
    // Logs:
    // Now in state ONE
    // Before move: current=NULL, new=One
    // After move: old=NULL, current=One

    sm.currentState = State.Two;
    // Logs:
    // Going into state: Two
    // Before move: current=One, new=Two
    // After move: old=One, current=Two

    sm.currentState = State.Three;
    // Logs:
    // Before move: current=Two, new=Three
    // After move: old=Two, current=Three

    sm.currentState = null;  // Stop the machine.
    // Logs:
    // Before move: current=Three, new=NULL
    // After move: old=Three, current=NULL
  }
}
See Also