Home

MusicAPI V3 Function Reference

Access API functions either by using the MusicAPI global table, or by using local MusicAPI = require("scripts.musicapi.api"). If you are using the V1 legacy functions, use the MMC global table, or by using local MMC = require("scripts.musicapi.legacy").

The docs aren't finished, so some pages haven't been written yet.

How it works (Reading these first might help with figuring out the API)

• The Music enum
• How MusicAPI tracks work
• How MusicAPI states work

Name Reference

• Track Names (Repentance)

Useful functions

• Setting a custom jingle track, main track and end jingle for a boss (TODO)
• Adding custom music IDs to tracks
• Getting the room/floor's intended track (TODO)
• Other track functions (TODO)
• State functions
• Legacy functions
• Non-music related functions

Callbacks

• What to use and when to use it
• OnPlay (TODO)
• OnTrack (TODO)
• OnMusic (TODO)
• Legacy (TODO)