Adds ChatterboxNodeChangeCallback()

JujuAdams · Sep 4, 2024 · 7e71dea · 7e71dea
1 parent 755556c
commit 7e71dea
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 12 deletions.
diff --git a/chatterbox.yyp b/chatterbox.yyp
diff --git a/scripts/ChatterboxCreate/ChatterboxCreate.gml b/scripts/ChatterboxCreate/ChatterboxCreate.gml
@@ -116,9 +116,8 @@ function __ChatterboxClass(_filename, _singleton, _local_scope) constructor
             return undefined;
         }
 
-        current_node = _node;
+        __ChangeNode(_node, true);
         current_instruction = current_node.root_instruction;
-        current_node.MarkVisited();
 
         __ChatterboxVM();
     }
@@ -159,9 +158,8 @@ function __ChatterboxClass(_filename, _singleton, _local_scope) constructor
             return undefined;
         }
 
-        current_node = _node;
+        __ChangeNode(_node, true);
         current_instruction = current_node.root_instruction;
-        current_node.MarkVisited();
 
         __ChatterboxVM();
     }
@@ -193,7 +191,7 @@ function __ChatterboxClass(_filename, _singleton, _local_scope) constructor
             return undefined;
         }
 
-        current_node = _node;
+        __ChangeNode(_node, false);
         current_instruction = _next;
 
         __ChatterboxVM();
@@ -512,4 +510,22 @@ function __ChatterboxClass(_filename, _singleton, _local_scope) constructor
         array_resize(optionStructArray,   _count);
         array_resize(optionWeightArray,   _count);
     }
+
+    static __ChangeNode = function(_newNode, _markAsVisited)
+    {
+        var _oldNode = current_node;
+
+        current_node = _newNode;
+        if (_markAsVisited) current_node.MarkVisited();
+
+        if (is_undefined(_system.__nodeChangeCallback))
+        {
+            //Do nothing!
+        }
+        else if (is_method(_system.__nodeChangeCallback) || script_exists(_system.__nodeChangeCallback))
+        {
+            _system.__nodeChangeCallback((_oldNode != undefined)? _oldNode.title : undefined, 
+                                         (_newNode != undefined)? _newNode.title : undefined);
+        }
+    }
 }
diff --git a/scripts/ChatterboxNodeChangeCallback/ChatterboxNodeChangeCallback.gml b/scripts/ChatterboxNodeChangeCallback/ChatterboxNodeChangeCallback.gml
@@ -0,0 +1,18 @@
+// Feather disable all
+
+/// Sets a callback functiojn that is executed whenever a chatterbox changes node. The callback
+/// will be executed in the following situations:
+/// 
+/// - Jumping to a node
+/// - Hopping to a node
+/// - Hopping back to a node
+/// 
+/// Three arguments are passed to the callback function: the name of the old node and the name of
+/// the new node (in that order).
+
+function ChatterboxNodeChangeCallback(_function)
+{
+    static _system = __ChatterboxSystem();
+
+    _system.__nodeChangeCallback = _function;
+}
diff --git a/scripts/ChatterboxNodeChangeCallback/ChatterboxNodeChangeCallback.yy b/scripts/ChatterboxNodeChangeCallback/ChatterboxNodeChangeCallback.yy
diff --git a/scripts/__ChatterboxSystem/__ChatterboxSystem.gml b/scripts/__ChatterboxSystem/__ChatterboxSystem.gml
@@ -64,6 +64,7 @@ function __ChatterboxSystem()
         __variablesMap         = ds_map_create();
         __variablesList        = ds_list_create();
         __variablesSetCallback = undefined;
+        __nodeChangeCallback   = undefined;
         __constantsMap         = ds_map_create();
         __constantsList        = ds_list_create();
         __defaultVariablesMap  = ds_map_create();

diff --git a/scripts/__ChatterboxVM/__ChatterboxVM.gml b/scripts/__ChatterboxVM/__ChatterboxVM.gml
@@ -300,9 +300,9 @@ function __ChatterboxVMInner(_instruction)
                         {
                             var _next_node = FindNode(_split.node);
                             if (_next_node == undefined) __ChatterboxError("Node \"", _split.node, "\" could not be found in \"", filename, "\"");
-                            _next_node.MarkVisited();
+
+                            __ChangeNode(_next_node, true);
                             _next = _next_node.root_instruction;
-                            current_node = _next_node;
                         }
                         else
                         {
@@ -314,9 +314,9 @@ function __ChatterboxVMInner(_instruction)
 
                                 _next_node = FindNode(_split.node);
                                 if (_next_node == undefined) __ChatterboxError("Node \"", _split.node, "\" could not be found in \"", _split.filename, "\"");
-                                _next_node.MarkVisited();
+
+                                __ChangeNode(_next_node, true);
                                 _next = _next_node.root_instruction;
-                                current_node = _next_node;
                             }
                             else
                             {
@@ -368,9 +368,10 @@ function __ChatterboxVMInner(_instruction)
                                 __ChatterboxTrace("Error! File \"", _split.filename, "\" not found or not loaded");
                             }
 
-                            file         = _file;
-                            filename     = file.filename;
-                            current_node = _node;
+                            file     = _file;
+                            filename = _file.filename;
+
+                            __ChangeNode(_node, false);
                         }
                     break;