Merge pull request #100 from PaulNonatomic/develop

Develop

Author: PaulNonatomic

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## [0.7.2-beta] - Aug 24, 2024
+- Exposed the JumpTo method on the StateMachineController
+  - This allows users to manually trigger a JumpIn node externally broadening the use-cases for the VSM
+- Exposed the State member of the StateMachine through a public State member of the StateMachineController
+  - This allows users to determine the current state and to directly call methods upon externally.
+  - I experimented with implementing a StatePattern with all States implementing a common interface.
+
 ## [0.7.1-beta] - Aug 21, 2024
 - Amended the exception forwarding of StateMachine to throw the original exception rather than wrapping it. This improves debugging errors in states.
 

Runtime/StateGraph/StateMachine.cs

@@ -15,6 +15,7 @@ public class StateMachine
 	{
 		public event Action<State, StateMachineModel> OnComplete;
 
+		public State State => _currentNode?.State;
 		public StateMachineModel Model { get; private set; }
 		public bool IsComplete { get; private set; }
 

Runtime/StateGraph/StateMachineController.cs

@@ -1,4 +1,5 @@
 using System;
+using Nonatomic.VSM2.StateGraph.States;
 using UnityEngine;
 
 namespace Nonatomic.VSM2.StateGraph
@@ -12,6 +13,8 @@ public class StateMachineController : MonoBehaviour
 		/// Gets the unique identifier for this controller.
 		/// </summary>
 		public string Id => _id;
+
+		public State State => _stateMachine?.State;
 
 		/// <summary>
 		/// Gets the current StateMachineModel, either from the active state machine or the serialized field.
@@ -27,6 +30,15 @@ public class StateMachineController : MonoBehaviour
 		private bool _activated;
 		private bool _started;
 
+		/// <summary>
+		/// Jumps to a state via a JumpIn state using the JumpId to identify the JumpIn node.
+		/// </summary>
+		/// <param name="id">The JumpIn id of the destination JumpIn node</param>
+		public void JumpTo(JumpId id)
+		{
+			_stateMachine?.JumpTo(id);
+		}
+
 		/// <summary>
 		/// Changes the StateMachineModel and reinitializes the state machine.
 		/// If the GameObject is active and has already started, it will also call Start and Enter on the new state machine.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "com.nonatomic.visualstatemachinev2",
-  "version": "0.7.1-beta",
+  "version": "0.7.2-beta",
   "displayName": "Visual State Machine V2",
   "description": "Visual State Machine V2",
   "unity": "2022.3",