Feature/lanes (#40)

this fixes #35

does not close but starts work partly on #41

Reviewed-on: #40
Co-authored-by: dutchie031 <timrorije@gmail.com>

src/classes/spearhead_events.lua

@@ -29,49 +29,44 @@ do
     end
 
     ---@class OnStageChangedListener
-    ---@field OnStageNumberChanged fun(self:OnStageChangedListener, number:integer)
+    ---@field OnStageNumberChanged fun(self:OnStageChangedListener, number:integer, laneIdentifier:string?)
 
     do -- STAGE NUMBER CHANGED
         local OnStageNumberChangedListeners = {}
         local OnStageNumberChangedHandlers = {}
         ---Add a stage zone number changed listener
-        ---@param listener OnStageChangedListener object with function OnStageNumberChanged(self, number)
+        ---@param listener OnStageChangedListener object with function OnStageNumberChanged(self, number, stageLaneIdentifier)
         SpearheadEvents.AddStageNumberChangedListener = function(listener)
+            if type(listener) ~= "table" or type(listener.OnStageNumberChanged) ~= "function" then
+                warn("Event handler not of type table/object with function OnStageNumberChanged(self, number, stageLaneIdentifier)")
+                return
+            end
             table.insert(OnStageNumberChangedListeners, listener)
         end
 
-        ---Add a stage zone number changed listener
-        ---@param handler function function(number)
-        SpearheadEvents.AddStageNumberChangedHandler = function(handler)
-            if type(handler) ~= "function" then
-                warn("Event handler not of type function, did you mean to use listener?")
-                return
-            end
-            table.insert(OnStageNumberChangedHandlers, handler)
-        end
-
         ---@class OnStageNumberChangeCompleteListener
-        ---@field OnStageNumberChangeComplete fun(self:OnStageNumberChangeCompleteListener, number:integer)
+        ---@field OnStageNumberChangeComplete fun(self:OnStageNumberChangeCompleteListener, number:integer, laneIdentifier:string?)
         
         local OnStageNumberChangeCompleteListeners = {}
         ---@param listener OnStageNumberChangeCompleteListener
         SpearheadEvents.AddStageNumberChangeCompleteListener = function(listener)
             if type(listener) ~= "table" or type(listener.OnStageNumberChangeComplete) ~= "function" then
-                warn("Event handler not of type table/object with function OnStageNumberChangeComplete(self, number)")
+                warn("Event handler not of type table/object with function OnStageNumberChangeComplete(self, number, laneIdentifier)")
                 return
             end
             table.insert(OnStageNumberChangeCompleteListeners, listener)
         end
 
         ---@param newStageNumber number
-        SpearheadEvents.PublishStageNumberChanged = function(newStageNumber)
+        ---@param laneIdentifier string?
+        SpearheadEvents.PublishStageNumberChanged = function(newStageNumber, laneIdentifier)
             pcall(function ()
-                Persistence.SetActiveStage(newStageNumber)
+                Persistence.SetActiveStage(laneIdentifier, newStageNumber)
             end)
 
             for _, callable in pairs(OnStageNumberChangedListeners) do
                 local succ, err = pcall(function()
-                    callable:OnStageNumberChanged(newStageNumber)
+                    callable:OnStageNumberChanged(newStageNumber, laneIdentifier)
                 end)
                 if err then
                     logError(err)
@@ -79,7 +74,7 @@ do
             end
 
             for _, callable in pairs(OnStageNumberChangedHandlers) do
-                local succ, err = pcall(callable, newStageNumber)
+                local succ, err = pcall(callable, newStageNumber, laneIdentifier)
                 if err then
                     logError(err)
                 end
@@ -87,7 +82,7 @@ do
 
             for _, callable in pairs(OnStageNumberChangeCompleteListeners) do
                 local succ, err = pcall(function()
-                    callable:OnStageNumberChangeComplete(newStageNumber)
+                    callable:OnStageNumberChangeComplete(newStageNumber, laneIdentifier)
                 end)
                 if err then
                     logError(err)