GlobalScript Awesome!!!

Author: hackx2

source/Constants.hx

@@ -40,6 +40,11 @@ class Constants
 	 */
 	public static inline final DEFAULT_DISCORD_ID:String = "1095422496473358356";
 
+	/**
+	 * Default sustain cover.
+	 * This is used when the note has a sustain, but no cover is specified.
+	 * It will use the default cover instead of the note's cover.
+	 */
 	public static inline final DEFAULT_SUSTAIN_COVER:String = "holdCovers/holdCover";
 
 	/**

source/funkin/game/objects/shaders/CustomShader.hx

@@ -2,11 +2,13 @@ package funkin.game.objects.shaders;
 
 import flixel.system.FlxAssets.FlxShader;
 
-class CustomShader extends FlxShader
+class CustomShader extends FunkinShader
 {
-	public function new(shader:String) : Void
+	public function new(?fragmentSource:String, ?vertexSource:String) : Void
 	{
-		this.glFragmentSource = shader;
+		this.glFragmentSource = fragmentSource ?? "";
+		this.glVertexSource = vertexSource ?? "	";
+
 		super();
 	}
 }

source/funkin/game/objects/shaders/FunkinShader.hx

@@ -0,0 +1,31 @@
+package funkin.game.objects.shaders;
+
+import flixel.system.FlxAssets.FlxShader;
+import rulescript.types.IRuleScriptCustomAccessor;
+
+class FunkinShader extends FlxShader implements IRuleScriptCustomAccessor
+{
+	@:dox(hide) @:noCompletion static final __instanceFields = Type.getInstanceFields(FunkinShader);
+
+	public function new(?fragmentSource:String, ?vertexSource:String):Void
+	{
+		this.glFragmentSource = fragmentSource ?? "";
+		this.glVertexSource = vertexSource ?? "	";
+
+		super();
+	}
+
+	public function setField(id:String, value:Dynamic):Dynamic
+	{
+		// TODO:
+
+		return -1;
+	}
+
+	public function getField(id:String):Dynamic
+	{
+		// TODO:
+
+		return -1;
+	}
+}

source/funkin/modding/GlobalScript.hx

@@ -1,42 +1,39 @@
 package funkin.modding;
 
-import flixel.util.FlxDestroyUtil.IFlxDestroyable;
 #if GLOBAL_SCRIPT
 import flixel.util.FlxSignal.FlxTypedSignal;
-import funkin.modding.Script.ScriptType as TScript;
+import funkin.modding.Script.ScriptType;
 import openfl.utils.Assets;
 import haxe.ds.StringMap;
 
 class GlobalScript
 {
-	//
-	// PUBLIC HELPERS
-	//
-	public static function call(event:String, ?args:Array<Dynamic>, ?scriptType:TScript):Dynamic
-		return scripts.call(event, args, scriptType);
-
-	public static function set(name:String, value:Dynamic, ?scriptType:TScript):Void
-		scripts.set(name, value, scriptType);
-
 	public static var scripts:ScriptPack;
+	
+	#if MODS_ALLOWED
 	public static var onModSwitch:FlxTypedSignal<Void->Void> = new FlxTypedSignal();
-
+	#end
+	
+	/**
+	 * [Description] Reloads the global scripts.
+	 * This will destroy the current scripts and load new ones from the shared path.
+	 * If there are no scripts to reload, it will log a message.
+	 * @return Void
+	 */
 	public static function reload():Void
 	{
-		final more : Bool = (scripts?.scripts.length > 0) ?? true;
-		Logs.log(scripts == null ? 'No global script instance reloading...' : (more ? 'Reloading global scripts...' : 'No global scripts to reload...'), YELLOW);
-		
+		final __hasScripts:Bool = (scripts?.scripts.length > 0) ?? true;
+		Logs.log(scripts == null ? 'No global script instance reloading...' : (__hasScripts ? 'Reloading global scripts...' : 'No global scripts to reload...'), YELLOW);
+
 		destroy();
 
 		scripts = new ScriptPack();
 		loadScripts(Paths.getSharedPath(), 'scripts/modules/');
 
-		if(more)
+		if (__hasScripts)
 			Logs.log('Global script successfully reloaded.', YELLOW);
 	}
 
-	static var loadedScripts : StringMap<Bool> = new StringMap<Bool>();
-
 	public static function loadScripts(path:String, fileToFind:String):Void
 	{
 		for (folderName in Mods.directoriesWithFile(path, fileToFind))
@@ -51,54 +48,63 @@ class GlobalScript
 
 				final convertedScriptPath:String = folderName + _fileName;
 
-				if (loadedScripts.exists(convertedScriptPath))
+				if (__loadedScripts.exists(convertedScriptPath))
 					continue;
-
+				trace('Loading script: ' + convertedScriptPath);
 				#if LUA_ALLOWED
 				if (Script.checkScriptExtensions(_fileName, "lua"))
 				{
 					scripts.add(new FunkinLua(convertedScriptPath));
-					loadedScripts.set(convertedScriptPath, true);
+					__loadedScripts.set(convertedScriptPath, true);
 				}
 				#end
 				#if HSCRIPT_ALLOWED
 				if (Script.checkScriptExtensions(_fileName, "haxe"))
 				{
 					scripts.add(new HScript(null, convertedScriptPath));
-					loadedScripts.set(convertedScriptPath, true);
+					__loadedScripts.set(convertedScriptPath, true);
 				}
 				#end
 
-				loadedScripts.set(convertedScriptPath, true);
+				__loadedScripts.set(convertedScriptPath, true);
 			}
 
 			var prefix = if (!folderName.endsWith("/")) folderName + "/" else folderName;
 
 			// Embedded assets
 			for (asset in Assets.list())
 			{
-				if (!asset.startsWith(prefix)) continue;
-				final relative : String = asset.substr(prefix.length);
-				if (relative.contains("/")) continue;
-				if (!Script.checkScriptExtensions(relative)) continue;
-				if (!relative.startsWith("MODULE_")) continue;
+				if (!asset.startsWith(prefix))
+					continue;
+				final relative:String = asset.substr(prefix.length);
+				if (relative.contains("/"))
+					continue;
+				if (!Script.checkScriptExtensions(relative))
+					continue;
+				if (!relative.startsWith("MODULE_"))
+					continue;
 
 				final convertedScriptPath:String = prefix + relative;
-				if (loadedScripts.exists(convertedScriptPath)) continue;
+				if (__loadedScripts.exists(convertedScriptPath))
+				{
+					continue;
+				}
+
+				trace('Loading script: ' + convertedScriptPath);
 
 				#if LUA_ALLOWED
 				if (Script.checkScriptExtensions(relative, "lua"))
 				{
 					scripts.add(new FunkinLua(convertedScriptPath));
-					loadedScripts.set(convertedScriptPath, true);
+					__loadedScripts.set(convertedScriptPath, true);
 				}
 				#end
 
 				#if HSCRIPT_ALLOWED
 				if (Script.checkScriptExtensions(relative, "haxe"))
 				{
 					scripts.add(new HScript(null, convertedScriptPath));
-					loadedScripts.set(convertedScriptPath, true);
+					__loadedScripts.set(convertedScriptPath, true);
 				}
 				#end
 			}
@@ -109,9 +115,11 @@ class GlobalScript
 
 	public static function init():Void
 	{
+		#if MODS_ALLOWED
 		onModSwitch.add(reload);
 		onModSwitch.add(() -> Logs.log('Loading global scripts...', YELLOW));
 		onModSwitch.dispatch();
+		#end
 
 		///
 
@@ -135,13 +143,14 @@ class GlobalScript
 
 		FlxG.signals.preUpdate.add(() ->
 		{
+			FlxG.watch.addQuick("Loaded Scripts", scripts.scripts.length);
+
 			scripts.call("preUpdate", [FlxG.elapsed]);
 			scripts.call("update", [FlxG.elapsed]);
 		});
 
 		FlxG.signals.postUpdate.add(() ->
 		{
-			FlxG.watch.addQuick("Loaded Scripts", scripts.scripts.length);
 			if (FlxG.keys.justPressed.F5)
 			{
 				if (scripts.scripts.length > 0)
@@ -158,15 +167,52 @@ class GlobalScript
 			}
 			scripts.call("postUpdate", [FlxG.elapsed]);
 		});
+
+		Application.current.onExit.add(_->destroy());
 	}
 
+	/**
+	 * [Description] A map of loaded scripts.
+	 * This is used to prevent loading the same script multiple times.
+	 */
+	@:dox(hide) @:noCompletion static var __loadedScripts:StringMap<Bool> = new StringMap<Bool>();
+
 	public static function destroy():Void
 	{
+		if(__loadedScripts!=null) __loadedScripts.clear();
 		if (scripts != null)
 		{
 			scripts.call('destroy');
 			scripts = FlxDestroyUtil.destroy(scripts);
 		}
 	}
+
+		//
+	// PUBLIC HELPERS
+	//
+
+	/**
+	 * [Description] calls a global script function.
+	 * @param event is the name of the function to call. 
+	 * @param args is an array of arguments to pass to the function.
+	 * @param scriptType is the type of script to call. If not provided, it defaults to `ScriptType.HSCRIPT`.
+	 * @return Dynamic return scripts.call(event, args, scriptType)
+	 */
+	public static function call(event:String, ?args:Array<Dynamic>, ?scriptType:ScriptType):Dynamic
+	{
+		return scripts.call(event, args, scriptType);
+	}
+
+	/**
+	 * [Description] sets a global script variable.
+	 * @param name is the name of the variable to set.
+	 * @param value is the value to set the variable to.
+	 * @param scriptType is the type of script to set the variable in. If not provided, it defaults to `ScriptType.HSCRIPT`.
+	 * @return Void
+	 */
+	public static function set(name:String, value:Dynamic, ?scriptType:ScriptType):Void
+	{
+		scripts.set(name, value, scriptType);
+	}
 }
 #end

source/funkin/modding/import.hx

@@ -1,5 +1,3 @@
-package funkin.modding;
-
 #if !macro
 // BASE SCRIPTING STUFF
 import funkin.modding.*;
@@ -16,7 +14,6 @@ import rulescript.parsers.*;
 import rulescript.types.Typedefs;
 import rulescript.types.ScriptedTypeUtil;
 import rulescript.scriptedClass.RuleScriptedClassUtil;
-
 import funkin.modding.hscript.*;
 #end
 #if LUA_ALLOWED