Home

MusicAPI V3 Function Reference

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

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

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

Useful functions

• Setting a custom jingle track, main track and end jingle for a boss
• Adding custom music to special rooms
• Adding multiple music IDs to one track
• Getting the room/floor's intended track
• Other track functions
• State functions
• Legacy functions
• Non-music related functions

Callbacks

• OnPlay
• OnTrack
• OnMusic
• Legacy