feat: Scoped Modules

Author: AbnormalPoof

source/funkin/modding/module/Module.hx

@@ -39,16 +39,27 @@ class Module implements IPlayStateScriptedClass implements IStateChangingScripte
     return value;
   }
 
+  /**
+   * The state this module is associated with.
+   * If set, this module will only receive events when the game is in this state.
+   */
+  public var state:Null<Class<Dynamic>> = null;
+
   /**
    * Called when the module is initialized.
    * It may not be safe to reference other modules here since they may not be loaded yet.
    *
    * NOTE: To make the module start inactive, call `this.active = false` in the constructor.
    */
-  public function new(moduleId:String, priority:Int = 1000):Void
+  public function new(moduleId:String, priority:Int = 1000, state:Null<Class<Dynamic>> = null):Void
   {
     this.moduleId = moduleId;
     this.priority = priority;
+
+    if (state != null)
+    {
+      this.state = state;
+    }
   }
 
   public function toString()

source/funkin/modding/module/ModuleHandler.hx

@@ -6,6 +6,7 @@ import funkin.modding.events.ScriptEvent;
 import funkin.modding.events.ScriptEventDispatcher;
 import funkin.modding.module.Module;
 import funkin.modding.module.ScriptedModule;
+import flixel.FlxG;
 
 /**
  * Utility functions for loading and manipulating active modules.
@@ -145,6 +146,14 @@ class ModuleHandler
       // The module needs to be active to receive events.
       if (module != null && module.active)
       {
+        if (module.state != null)
+        {
+          // Only call the event if the current state is what the module's state is.
+          if (!(Type.getClass(FlxG.state) == module.state) && !(Type.getClass(FlxG.state?.subState) == module.state))
+          {
+            continue;
+          }
+        }
         ScriptEventDispatcher.callEvent(module, event);
       }
     }