Character Functions

characterPlayAnim(character:String, anim:String, forced:Bool = false)

Plays a specific character animation.

character - The character name, can be boyfriend, dad or gf.
anim - The animation name to be played.
forced - Can be either true or false, if set to true, it will force the animation to reset if the current animation is the same as the animation to play.

characterDance(character:String)

Makes character do the idle dance.

character - The name of the character, can be boyfriend, dad or gf.

setCharacterX(type:String, value:Float)

Sets the general x position of a character from the type parameter, this will also move all precached characters from the same type into the position you want.

type - The character name, can be boyfriend, dad or gf.
value - The x value of the character position.

setCharacterY(type:String, value:Float)

Sets the general y position of a character from the type parameter, this will also move all precached characters from the same type into the position you want.

type - The name of the character, can be boyfriend, dad or gf.
value - The y value of the character position.

getCharacterX(type:String)

Gets the general x position of a character from the type parameter.

type - The name of the character name, can be boyfriend, dad or gf.

getCharacterY(type:String)

Gets the general y position of a character from the type parameter.

type - The name of the character name, can be boyfriend, dad or gf.

Accuracy Bar Functions

addScore(value:Int = 0)

Adds the value parameter to the current song score total and recalculates the rating.

addMisses(value:Int = 0)

Adds the value parameter to the current song miss total and recalculates the rating.

addHits(value:Int = 0)

Adds the value parameter to the current song hit total and recalculates the rating.

addHealth(value:Float = 0)

Adds the value parameter to the current song health total and recalculates the rating.

setScore(value:Int = 0)

Sets the value parameter of the current song score total into a specified state and recalculates the rating.

setMisses(value:Int = 0)

Sets the value parameter of the current song miss total into a specified state and recalculates the rating.

setHits(value:Int = 0)

Sets the value parameter of the current song hit total into a specified state and recalculates the rating.

setHealth(value:Int = 0)

Sets the value parameter of the current song health total into a specified state and recalculates the rating.

setRatingPercent(value:Float)

Sets the rating percent in case you want to do your own rating calculation.

value - Should go from 0 to 1 but can actually be whatever value you want, but it's kinda stupid to get out of the base values.

setRatingString(value:String)

Sets the rating name to the value parameter in case you want to do your own rating calculation.

value - The rating string accuracy.

setRatingFC(value:String)

Sets the rating combo on the scoreTxt.

value - The rating combo accuracy.

getScore()

Gets the current songs score total.

getMisses()

Gets the current songs miss total.

getHits()

Gets the current songs hit total.

getHealth()

Gets the current songs health total.

Lua Object Exists

luaSpriteExists(tag:String)

Checks whether the sprite object exists in the currently playing song.

tag - The tag of the sprite object.

luaTextExists(tag:String)

Checks whether the text object exists in the currently playing song.

tag - The tag of the text object.

luaSoundExists(tag:String)

Checks whether the sound object exists in the currently playing song.

tag - The tag of the sound.

String Functions

stringStartsWith(str:String, start:String)

Checks the starting section of the string with the start parameter.

str - The string to be manipulate.
start - The start of the string.

stringEndsWith(str:String, end:String)

Checks the ending section of the string with the start parameter.

str - The string to be manipulate.
end - The end of the string.

stringSplit(str:String, split:String)

Splits a string into multiple string will turn it into a Table.

str - The string to split.
start - The seperation of the string.

Example: stringSplit('Split, This, LOL!', ', ')[1] This will print 'Split'.

stringTrim(str:String)

Removes any unnecessary large spaces from string.

str - The string to be converted.

File Functions

getTextFromFile(path:String, ?ignoreModFolders:Bool = false)

Gets the text from different files.

path - The path of the text file that you are getting.
ignoreModFolders - An optional parameter that ignores the mod folder with a Boolean.

Example: getTextFromFile('pathTotheFile/ExampleFile.txt')

directoryFileList(folder:String)

Gets the every files inside of the folder.

folder - The path to the folder

saveFile(path:String, content:String, absolute:Bool = false)

Changes the contents of file then saves it.

path - The path of the file that you are getting.
content - The contents of the file to be saved, must be surrounded by double brackets [[]].
absolute - An optional parameter that ignores the mod folder with a Boolean.

deleteFile(path:String, ignoreModFolders)

Deletes the file you want.

path - The path of the file that you are getting.
ignoreModFolders - An optional parameter that ignores the mod folder with a Boolean.

checkFileExists(filename:String, absolute:Bool = false)

Checks if the file existed, its like lua exists function but its global.

filename The path of the file that you are getting.
absolute - An optional parameter that ignores the mod folder with a Boolean.

Example: checkFileExists('mods/pathTotheFile/luafile.lua')

Scripts Functions

isRunning(luaFile:String)

Note: Put the file format name to get the file you want.

luaFile - The file that you want to detect that is running currently.

Example: isRunning('mods/pathTotheFile/luafile.lua')

getRunningScripts()

Checks multiple scripts executing currently; use generic loop to use this.

addLuaScript(path:String)

Adds a lua script into the game.

path - The path of the file that you are getting.

removeLuaScript(path:String)

Removes a lua script into the game.

path - The path of the file that you are getting.

addHaxeLibrary(libName:String, ?libPackage:String = '')

Adds a library variable into the interpreter.

libName - The name of the library name.
libPackage - The name of the library package.

Example: addHaxeLibrary('FlxTween', 'flixel.tweens')

runHaxeCode(codeToRun:String)

It executes the string as a Haxe script.

codeToRun - the haxe code to be executed, use double brackets [[]] when making the haxe code.

setGlobalFromScript(luaFile:String, global:String, val:Dynamic)

Sets the global variable with a new value from another lua script; this will not work with local variable.

luaFile - The path of the file that you are getting.
global - The variable to be chosen.
val - The new value of the variable.

getGlobalFromScript(luaFile:String, global:String)

Gets the current value of a global variable from another lua script; this does not work with local variables.

luaFile - The path of the file that you are getting.
global - The variable to be chosen.

openCustomSubstate(name:String, pauseGame:Bool = false)

Will open your custom substate. To create a custom substate click here.

name - The name of the custom substate.
pauseGame - An optional value, will pause your game when opening the custom substate.

closeCustomSubstate(name:String)

Will close your custom substate.

name - The name of the custom substate.

Randomizers

getRandomInt(min:Int, max:Int)

This will randomize a Int number. (Better than math.random())

min - The lowest value.
max - The highest value.

getRandomFloat(min:Float, max:Float)

This will randomize a Float number.

min - The lowest value.
max - The highest value.

getRandomBool(chance:Float = 50)

It randomizes the chance of it being true.

chance - The possibility of it being true.

Camera Functions

cameraShake(camera:String, intensity:Float, duration:Float)

Makes the camera shake.

camera - The current camera state, can be either camGame, camHUD or camOther.
intensity - How much intesity will the camera shake, recommended value is 0.05.
duration - How long will the shake last.

cameraSetTarget(target:String)

Makes the camera focus on the target.

target - The character type to target, can be either boyfriend or dad.

cameraFlash(camera:String, color:String, duration:Float, forced:Bool)

Makes the camera flash.

camera - The current camera state, can be either camGame, camHUD or camOther.
color - The color of the flash. (Must be a Hexadecimal Color Code)
duration - How long will the camera flash.
forced - Whether or not restart the flash.

cameraFade(camera:String, color:String, duration:Float, forced:Bool)

Makes the camera fade.

camera - The current camera state, can be either camGame, camHUD or camOther.
color - The color of the fade. (Must be a Hexadecimal Color Code)
duration - How long will the camera fade.
forced - Whether or not restart the fade.

Other Functions

triggerEvent(name:String, arg1:String, arg2:String)

Triggers an event without having to enter it into the chart editor.

name - The name of the event in the Chart editor.
arg1 - The value on the Value 1.
arg2 - The value on the Value 2.

setHealthBarColors(leftHex:String, rightHex:String)

Changes the health bar colors. (Must be a Hexadecimal Color Code)

leftHex - The opponent health bar color.
rightHex - The player health bar color.

setTimeBarColors(leftHex:String, rightHex:String)

Changes the time bar colors. (Must be a Hexadecimal Color Code)

leftHex - The color of the time bar.
rightHex - The background color of the time bar.

getColorFromHex(color:String)

Gets the color from the Hexadecimal Color Code.

Example: To get orange, you should use getColorFromHex('FF7800') or getColorFromHex('0xFFFF7800').

getSongPosition()

Returns the current song position, Shortcut to getPropertyClass('Conductor', 'songPosition').

removeFromGroup(obj:String, index:Int, dontDestroy:Bool = false)

Removes a specific note group.

obj - The strum group name on the note.
index - The member ID of the note to be tween, Opponent: 0,1,2,3 and Player: 4,5,6,7.
dontDestroy - An optional variable. Won't clear the member from memory, you will probably never ever use this.

Example: To remove the first spawned note from the group you should use removeFromGroup('notes', 0).

Debug Functions

debugPrint(text1, text2, text3, text4, text5)

This command displays a debug message in the top-left corner of the screen. All of the values are optional, and you can print up to 5 of them.

Example: debugPrint("Current boyfriend character: ", getProperty('boyfriend.curCharacter')

This will print the following message: Current boyfriend character: bf.

close()

Stops your script in the next 100 miliseconds. And must be used in a Stage script because it won't be used anymore.