Modifying state machine callbacks

Author: Sahasrara

Assets/TestRig/ConversationUI.cs

@@ -74,7 +74,7 @@ public void OnConversationExit(Conversation conversation, ReadyNotifier readyNot
         m_OnComplete(this);
     }
 
-    public void OnNodeDecision(List<Node> nodes, DecisionNotifier decisionNotifier)
+    public void OnNodeExit(List<Node> nodes, DecisionNotifier decisionNotifier)
     {
         for (int i = 0; i < nodes.Count; i++)
         {

Packages/studio.shortsleeve.gamescriptunity/Runtime/Execution/RunnerContext.cs

@@ -123,21 +123,12 @@ internal bool Tick()
                     }
                     case MachineState.NodeExit:
                     {
-                        m_Listener.OnNodeExit(m_Node, new(SequenceNumber, this, m_OnReady));
-                        m_CurrentState = MachineState.NodeExitWait;
-                        goto case MachineState.NodeExitWait;
-                    }
-                    case MachineState.NodeExitWait:
-                    {
-                        if (!m_OnReadyCalled)
-                            return true;
-                        m_OnReadyCalled = false;
-                        m_CurrentState = MachineState.NodeDecision;
-                        goto case MachineState.NodeDecision;
-                    }
-                    case MachineState.NodeDecision:
-                    {
-                        // Gather available edges
+                        // Three possiblities, we need to determine which one it is:
+                        // 1) Conversation Exit - No Available Edges
+                        // 2) Decision - Multiple Available Edges
+                        // 3) Next Node - One Available Edge
+
+                        // Start by determining which nodes are available to go to
                         uint actorId = 0;
                         bool allEdgesSameActor = true;
                         byte priority = 0;
@@ -173,15 +164,13 @@ internal bool Tick()
                         // Conversation Exit - No Available Edges
                         if (m_AvailableNodes.Count == 0)
                         {
-                            m_Listener.OnConversationExit(
-                                m_Conversation,
-                                new(SequenceNumber, this, m_OnReady)
-                            );
-                            m_CurrentState = MachineState.ConversationExitWait;
-                            goto case MachineState.ConversationExitWait;
+                            m_Listener.OnNodeExit(m_Node, new(SequenceNumber, this, m_OnReady));
+                            m_Node = null; // There is no next node
+                            m_CurrentState = MachineState.NodeExitWait;
+                            goto case MachineState.NodeExitWait;
                         }
 
-                        // Node Decision
+                        // Node Decision - Multiple Available Edges
                         if (
                             // If we have multiple choices or
                             // we allow single node choices and there's a single choice with UI text
@@ -199,19 +188,20 @@ internal bool Tick()
                             && !m_Node.IsPreventResponse
                         )
                         {
-                            m_Listener.OnNodeDecision(
+                            m_Listener.OnNodeExit(
                                 m_AvailableNodes,
                                 new(SequenceNumber, this, m_OnDecisionMade)
                             );
                             m_CurrentState = MachineState.NodeDecisionWait;
                             goto case MachineState.NodeDecisionWait;
                         }
 
-                        // Node Enter
+                        // Next Node - One Available Edge
+                        m_Listener.OnNodeExit(m_Node, new(SequenceNumber, this, m_OnReady));
                         m_AvailableNodes.Clear();
                         m_Node = highestPriorityNode;
-                        m_CurrentState = MachineState.NodeEnter;
-                        goto case MachineState.NodeEnter;
+                        m_CurrentState = MachineState.NodeExitWait;
+                        goto case MachineState.NodeExitWait;
                     }
                     case MachineState.NodeDecisionWait:
                     {
@@ -224,6 +214,28 @@ internal bool Tick()
                         m_CurrentState = MachineState.NodeEnter;
                         goto case MachineState.NodeEnter;
                     }
+                    case MachineState.NodeExitWait:
+                    {
+                        if (!m_OnReadyCalled)
+                            return true;
+                        m_OnReadyCalled = false;
+                        if (m_Node == null)
+                        {
+                            m_CurrentState = MachineState.ConversationExit;
+                            goto case MachineState.ConversationExit;
+                        }
+                        m_CurrentState = MachineState.NodeEnter;
+                        goto case MachineState.NodeEnter;
+                    }
+                    case MachineState.ConversationExit:
+                    {
+                        m_Listener.OnConversationExit(
+                            m_Conversation,
+                            new(SequenceNumber, this, m_OnReady)
+                        );
+                        m_CurrentState = MachineState.ConversationExitWait;
+                        goto case MachineState.ConversationExitWait;
+                    }
                     case MachineState.ConversationExitWait:
                     {
                         if (!m_OnReadyCalled)
@@ -347,9 +359,8 @@ private enum MachineState
             NodeEnterWait,
             NodeExecute,
             NodeExit,
+            NodeDecisionWait, // Really just NodeExitWait, but this keeps things simple
             NodeExitWait,
-            NodeDecision,
-            NodeDecisionWait,
             ConversationExit,
             ConversationExitWait,
         }

Packages/studio.shortsleeve.gamescriptunity/Runtime/Execution/RunnerListener.cs

@@ -85,9 +85,9 @@ public interface IGameScriptListener
         public void OnNodeEnter(Node node, ReadyNotifier readyNotifier);
 
         /**
-         * Called when a decision must be made to proceed with the conversation.
+         * Called before proceeding to find the next available node when a decision must be made.
          */
-        public void OnNodeDecision(List<Node> nodes, DecisionNotifier decisionNotifier);
+        public void OnNodeExit(List<Node> nodes, DecisionNotifier decisionNotifier);
 
         /**
          * Called before proceeding to find the next available node.

Packages/studio.shortsleeve.gamescriptunity/package.json

@@ -1,7 +1,7 @@
 {
   "name": "studio.shortsleeve.gamescriptunity",
   "displayName": "GameScriptUnity",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "unity": "2023.2",
   "description": "Cross-platform dialogue middleware",
   "keywords": [