-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Lua Script API
ShadowMario edited this page Jul 26, 2023
·
55 revisions
It's highly recommended for you to install it, as it makes everything easier for you to code in LUA as you don't have to memorize the functions.
Made by Held_der_Zeit with DotZZ's Lua Script API, huge props to them (We are not associated).
There's six types of LUA Scripts you can run:
- A Stage Script, it will only run if the song's stage has been set to the same as its name, it should have the same name as your stage's .json file and should be located inside mods/stages/
- A Note Type Script, it will only run if the said Note Type is being used on the chart, it should be located inside mods/custom_notetypes/
- An Event Script, it will only run if the said Event is being used on the chart, it should be located inside mods/custom_events/
- Song's Script(s), they should be saved inside the song's chart folder, it will only run on this specific song, no matter the difficulty, stage or whatever else.
- Character Script, it will only be run if the specified character is used on the current song. You can use variables
dadName
,boyfriendName
andgfName
to check the current character used's name. (if dadName == 'pico'
for example) - Global Script, it should be saved in mods/Your-Mod-Name/scripts/, it will run in all songs/difficulties, with no exceptions.
- Variables
- General Functions
- Tweens and Timers
- Value Setting and Getting Functions
- Functions for Dialogues and Cutscenes
- Custom Sprites/Objects
- Precaching Stuff
- Template Script with all Callbacks explained
-
Template Mod FolderNow's already included insidemods/modTemplate.zip
of your Psych Engine build
- Video/Dialogue Example - Video and Dialogue on Bopeebo (Story Mode)
- Drag 'n' Drop Dialogue Script (Story Mode) - Put it inside your chart's folder