Script Functions

Functions that allow you to "communicate" between scripts and HScript.

getRunningScripts

Usage: getRunningScripts()

Returns a table with the path of all Lua Scripts running.

callScript

callScript(luaFile:String, funcName:String, ?args:Array<Dynamic> = null):Dynamic

Calls a function only in a specific Lua Script.
Returns the value returned by the function called (Could be literally anything depending on context).

luaFile - Lua Script path.
funcName - Function name to call.
args (Optional) - Optional table of arguments.

Examples:

callScript('mods/scripts/test.lua', 'customFunction', {0, 999}) - This will call customFunction(0, 999) in the script at mods/scripts/test.lua.
callScript('scripts/test', 'customFunction', {0, 999}) - Same as above, but without absolute path.

addLuaScript

addLuaScript(luaFile:String, ?ignoreAlreadyRunning:Bool = false):Void

Initializes a specific Lua Script found at the path.

luaFile - Lua Script path.
ignoreAlreadyRunning (Optional) - If true, it will allow you to run duplicates of the same script, although this might cause unexpected behavior in other functions, use it at your own risk!

Examples:

callScript('mods/scripts/disabled/test.lua') - This will initialize the script at mods/scripts/disabled/test.lua.
callScript('scripts/disabled/test') - Same as above, but without absolute path.

addHScript

addHScript(scriptFile:String, ?ignoreAlreadyRunning:Bool = false):Void

Initializes a specific HScript found at the path.

scriptFile - HScript path.
ignoreAlreadyRunning (Optional) - If true, it will allow you to run duplicates of the same script, although this might cause unexpected behavior in other functions, use it at your own risk!

Examples:

callScript('mods/scripts/disabled/test.hx') - This will initialize the script at mods/scripts/disabled/test.hx.
callScript('scripts/disabled/test') - Same as above, but without absolute path.

removeLuaScript

removeLuaScript(luaFile:String):Bool

Stops a specific Lua Script running.
Returns true if the Script was found and was running.

luaFile - Lua Script path.

Examples:

removeLuaScript('mods/scripts/test.lua') - Stops the Lua script at mods/scripts/test.lua.
removeLuaScript('scripts/test') - Same as above, but without absolute path.

removeHScript

removeHScript(scriptFile:String):Bool

Stops a specific HScript running.
Returns true if the Script was found and was running.

scriptFile - HScript path.

Examples:

removeHScript('mods/scripts/test.hx') - Stops HScript at mods/scripts/test.hx.
removeHScript('scripts/test') - Same as above, but without absolute path.

isRunning

isRunning(scriptFile:String):Bool

Checks if a specific Lua Script/HScript is running.

scriptFile - Lua Script/HScript path.

Examples:

isRunning('mods/scripts/test.lua') - For Lua Scripts.
isRunning('mods/scripts/test.hx') - For HScript.
isRunning('scripts/test') - Without absolute path, it could end up detecting any of both.

setVar

setVar(varName:String, value:Dynamic):Dynamic

Stores a variable, allowing all Lua Scripts and HScript to access it through "getVar".
Returns the value that was inserted.

varName - Variable name to save.
value - Value to save to variable.

Examples:

setVar('storedValue', 10.5) - Saves "10.5" into a variable named "storedValue".

getVar

getVar(varName:String):Dynamic

Returns the named stored variable.

varName - Variable name to get.

Examples:

getVar('storedValue') - Returns the value saved from using "setVar".

setOnScripts

setOnScripts(varName:String, value:Dynamic, ?ignoreSelf:Bool = false, ?exclusions:Array<String> = null):Void

Saves/Overwrites a global variable to all Lua Script/HScript running currently.
This differs from "setVar" because you won't need a function like "getVar" to get the variable and it will not have its value shared between scripts.

varName - Variable name to save.
value - Value to save to variable.
ignoreSelf (Optional) - Does not insert this variable into the current Script.
exclusions (Optional) - Scripts to ignore.

Examples:

setOnScripts('myCounter', 10) - This will add a global called "myCounter" with value "10".
This can be accessed in lua through if myCounter == 10 then, for example.

setOnLuas

setOnLuas(varName:String, value:Dynamic, ?ignoreSelf:Bool = false, ?exclusions:Array<String> = null):Void

Structurally identical to "setOnScripts", but it does not insert the variable into HScripts running.

setOnHScript

setOnHScript(varName:String, value:Dynamic, ?ignoreSelf:Bool = false, ?exclusions:Array<String> = null):Void

Structurally identical to "setOnScripts", but it does not insert the variable into Lua Scripts running.

callOnScripts

callOnScripts(funcName:String, ?args:Array<Dynamic> = null, ?ignoreStops:Bool = false, ?ignoreSelf:Bool = true, ?excludeScripts:Array<String> = null, ?excludeValues:Array<Dynamic> = null):Dynamic

Calls a function in all Lua Scripts and HScript running.
Returns the value returned in the function, unless you add this value to "excludeValues".

funcName - Function name to call.
args (Optional) - Optional table of arguments.
ignoreStops (Optional) - Ignore all "Function_Stop" variations.
ignoreSelf (Optional) - Does not call this function on itself, this is an infinite loop prevention in the case you accidentally call the same function that runs this.
excludeScripts (Optional) - Scripts not to call the function on.
excludeValues (Optional) - Values to ignore from returning.

Examples:

callOnScripts('customFunction', {1}) - This will call customFunction(1) on all Lua Scripts/HScript.

callOnLuas

callOnLuas(funcName:String, ?args:Array<Dynamic> = null, ?ignoreStops:Bool = false, ?ignoreSelf:Bool = true, ?excludeScripts:Array<String> = null, ?excludeValues:Array<Dynamic> = null):Dynamic

Structurally identical to "callOnScripts", but it does not call the function in HScripts.

callOnHScript

callOnHScript(funcName:String, ?args:Array<Dynamic> = null, ?ignoreStops:Bool = false, ?ignoreSelf:Bool = true, ?excludeScripts:Array<String> = null, ?excludeValues:Array<Dynamic> = null):Dynamic

Structurally identical to "callOnScripts", but it does not call the function in Lua Scripts.

runHaxeCode

runHaxeCode(codeToRun:String, ?varsToBring:Any = null, ?funcToRun:String = null, ?funcArgs:Array<Dynamic> = null):Void

Runs HScript code inside a Lua Script by initializing a HScript Interpreter for the Lua Script.

codeToRun - Variable name to save.
varsToBring (Optional) - Table with values to bring to the code.
funcToRun (Optional) - Function to run once the code is initialized.
funcArgs (Optional) - Table with arguments for the previously mentioned function.

Examples:

runHaxeCode('game.boyfriend.color = FlxColor.RED;') - Simple HScript code to make the Player get red.
runHaxeCode('game.boyfriend.scale.y = myValue;', {myValue = 1.5}) - Brings "myValue" to the Haxe Code and use it to change Player's Scale Y.

Note: Do not use "runHaxeCode" every frame! Instead, put your code in functions and call them with "runHaxeFunction" after running runHaxeCode atleast once.

runHaxeFunction

runHaxeFunction(funcToRun:String = null, ?funcArgs:Array<Dynamic> = null):Void

Calls a function inside a code ran previously with "runHaxeCode".

funcToRun - Function to run.
funcArgs (Optional) - Table with arguments for the function.

Examples:

runHaxeFunction('myFunction', {1, 999}) - Will call function myFunction(1, 999) in the Haxe Code.