Lua Script API: General Functions

Character Functions

characterDance(character:String)

Makes character do the idle dance.

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

setCharacterX(type:String, value:Float)

Sets the current x position value of a character to a new value. This will also move all precached characters from the same type into the position you want.

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

setCharacterY(type:String, value:Float)

Sets the current y position value of a character to a new value. This will also move all precached characters from the same type into the position you want.

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

getCharacterX(type:String)

Gets the current x position value of a character.

• type - The character name to be used, can be boyfriend, dad or gf.

getCharacterY(type:String)

Gets the current y position value of a character.

• type - The character name to be used, 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 with a new value and recalculates the rating.

setMisses(value:Int = 0)

Sets the value parameter of the current song miss total with a new value and recalculates the rating.

setHits(value:Int = 0)

Sets the value parameter of the current song hit total with a new value and recalculates the rating.

setHealth(value:Int = 0)

Sets the value parameter of the current song health total with a new value and recalculates the rating.

---

setRatingPercent(value:Float)

Sets the current rating percent to a new value, in case you want to do your own rating calculation.

• value - The new accuracy rating percent, Goes from 0 to 1.

setRatingString(value:String)

Sets the current rating name to a new value, in case you want to do your own rating calculation.

• value - The new rating string name.

setRatingFC(value:String)

Sets the current rating combo name to a new value.

• value - The new rating combo name.

---

getScore()

Gets the current songs score total current value.

getMisses()

Gets the current songs miss total current value.

getHits()

Gets the current songs hit total current value.

getHealth()

Gets the current songs health total current value.

---

Lua Object Exists

luaSpriteExists(tag:String)

Checks if the current lua sprite object exists in the currently playing song.

• tag - The tag of the lua sprite object.

luaTextExists(tag:String)

Checks if the current lua text object exists in the currently playing song.

• tag - The tag of the lua text object.

luaSoundExists(tag:String)

Checks if the current lua sound object exists in the currently playing song.

• tag - The tag of the lua sound object.

---

String Functions

stringStartsWith(str:String, start:String)

Checks the starting section of the String variable.

• str - The string variable to be used.
• start - The starting section.

stringEndsWith(str:String, end:String)

Checks the ending section of the String variable.

• str - The string variable to be used.
• end - The ending section.

stringSplit(str:String, split:String)

Note: After splitting a String it will act like a Table; example shown below for reference.

Will split the String variable into multiple Strings.

• str - The string to be split.
• start - The separation of the string.

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

stringTrim(str:String)

Will remove any unnecessary large spaces from the String variable.

• str - The string to be trimmed.

---

Randomizers

getRandomInt(min:Int, max:Int)

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

• 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)

This will randomize the chance of it being true.

• chance - The possibility of it being true.

---

File Functions

getTextFromFile(path:String)

Gets the text contents inside of the txt file.

• path - The path file to the txt file.

directoryFileList(folder:String)

Gets the file folders inside of a folder

• folder - The path to the file folder.

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

Checks if the file existed or not.

• filename - The path of the file to be checked if it exists.
• absolute - An optional parameter, It will be ignore by the mod folder directory, causing it to be outside the mod folder.

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

Changes the current file contents and then saves it.

• path - The path of the file to be changed.
• content - The file contents to be changed or modified, use double brackets [[]].
• absolute - An optional parameter, It will be ignore by the mod folder directory, causing it to be outside the mod folder.

deleteFile(path:String)

Deletes the current file.

• path - The path of the file to be deleted.

initSaveData(name:String, ?folder:String = 'psychenginemods')

Note: This function is required when using setDataFromSave() and getDataFromSave() functions.

Loads the current save date from the file but if there is no save data found it will be created. Variables values are saved in this function.

• name - The name of the save data to be used.
• folder - An optional parameter, The folder to be loaded or be created.

flushSaveData(name:String)

Deletes the save data.

• name - The name of the save data to be used.

setDataFromSave(name:String, field:String, value:Dynamic)

Sets the current variable from the save data from the file.

• name - The name of the save data to be used.
• field - The current variable to be used.
• value - The new value to be set.

getDataFromSave(name:String, field:String)

Gets the current variable from the save data from the file.

• name - The name of the save data to be used.
• field - The current variable to be used.

isRunning(luaFile:String)

Checks if any lua file are currently running in game.

• luaFile - The path of the lua file to be used.

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

getRunningScripts()

Checks if any multiple lua file are currently running in game.

---

Scripts Functions

addLuaScript(path:String, ?ignoreAlreadyRunning:Bool = false)

Adds a lua script in the game.

• path - The path of the lua file that you are getting.
• ignoreAlreadyRunning - An optional parameter, It will run again while ignoring the lua file that is currently running.

removeLuaScript(path:String)

Removes a lua script in the game.

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

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

Adds a haxe library variable into the interpreter.

• libName - The haxe library to be used.
• libPackage - An optional parameter, the haxe library package to be used.

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

runHaxeCode(codeToRun:String)

Runs haxe script inside of the lua file.

• codeToRun - The code to be run, use double brackets [[]].

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

Opens your custom substate.

• name - The name of the custom substate to be used.
• pauseGame - An optional parameter, will pause your game after the custom substate has been opened.

closeCustomSubstate()

Closes any custom substate.

---

Warning: This section of the wiki has broken functions meaning they wont work as intended.

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

Sets the current Global variable with a new value from another lua script. If you're getting a Local variable it will not work as you intened.

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

getGlobalFromScript(luaFile:String, global:String)

Gets the current Global variable current value from another lua script. If you're getting a Local variable it will not work as you intened.

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

---

Camera Functions

cameraSetTarget(target:String)

Makes the camera focus on the target.

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

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

Makes the camera shake.

• camera - The camera state to be set in, 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 camera shake last.

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

Makes the camera flash.

• camera - The camera state to be set in, Can be either camGame, camHUD or camOther.
• color - The hexadecimal color of the flash.
• duration - How long will the camera flash last.
• forced - If set to true, then the flash will be reset.

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

Makes the camera fade.

• camera - The camera state to be set in, Can be either camGame, camHUD or camOther.
• color - The hexadecimal color of the fade.
• duration - How long will the camera fade last.
• forced - If set to true, then the fade will be reset.

---

Debuging Functions

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

This will display a debug message in the top-left corner of the screen. All of the parameters are optional execept text1 parameter. The purpose of the function is to check the current value of the object or variable.

Example: debugPrint("Current boyfriend character: ", getProperty('boyfriend.curCharacter') This will get the current bf character with the getProperty() function and will print Current boyfriend character: 'bf'.

close()

Warning: You must use this inside of a Stage script, since it will not be used anywhere.

Stops your script in the next 100 milliseconds.

---

Other Functions

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

Triggers an event without having to insert the event into the chart editor.

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

setHealthBarColors(leftHex:String, rightHex:String)

Changes the health bar colors.

• leftHex - The opponent hexadecimal color of the health bar.
• rightHex - The player hexadecimal color of the health bar.

setTimeBarColors(leftHex:String, rightHex:String)

Changes the time bar colors.

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

getColorFromHex(color:String)

Gets the specific color from the Hexadecimal color. Expecially when setting/getting a specific color, really useful to be honest.

• color - The hexadecimal color to be used.

Example: If you want to get the color orange use getColorFromHex('FF7800') or getColorFromHex('0xFFFF7800').

getSongPosition()

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