Psych Engine Lua Script API

Psych Engine

Lua Script API

This site is highly inspired by Flixel API's site, so huge props to them.

These pages are intended for Psych Engine 1.0+, so it might not be reliable for older versions. Support for other versions has been abandoned and will not be added to these pages.

Browse Functions Back to Hub

Running a Script

There are 6 types of LUA Scripts you can run:

  • Stage Script: It will only run if the song's stage is loaded in the current chart, it should have the same name as your stage's .JSON file and should be inside mods/My-Mod/stages/.
  • Note Type Script: It will only run if the named Note Type is being used in the current chart, it should be inside mods/My-Mod/custom_notetypes/.
  • Event Script: It will only run if the said Event is being used on the chart, it should be located inside mods/My-Mod/custom_events/.
  • Song Script(s): They should be saved inside the song's chart folder, it will only run in this specific song, no matter the Difficulty, Stage or anything else.
  • Character Script: It will only be run if the specified character is used on the current Song. You can use variables dadName, boyfriendName and gfName to check the current character used's name. (if dadName == 'pico' for example), should be in mods/My-Mod/characters/.
  • General Script: It should be saved in mods/My-Mod/scripts/, it will always run in every Song as long as the Mod is loaded.

Functions

There are 22 pages available with 212 functions:

PlayState FunctionsGeneral gameplay and song flow Reflection FunctionsProperty access and method calls Spritesheet FunctionsLua sprites and animation helpers FlxAnimate FunctionsAnimate atlas helpers Text FunctionsText objects and formatting Sound FunctionsAudio playback and control Shaders FunctionsShader loading and uniforms Camera FunctionsCamera movement and effects Input FunctionsKeyboard, mouse, and gamepads Tween FunctionsMotion and value animations Timer FunctionsTiming utilities Character FunctionsCharacter state helpers File I/O FunctionsFile read and write tools Language/Translation FunctionsLocalized text support Achievements FunctionsAchievement state and unlocks Substate FunctionsSubstate lifecycle helpers Precache FunctionsAsset warmup and caching Score FunctionsScore and rating helpers Save Data FunctionsPersistent state helpers Script FunctionsScript execution utilities Discord FunctionsDiscord presence helpers Uncategorized FunctionsMiscellaneous references