Music module

Functions

  • trx.music.get_track()

    Returns current playing track ID, or nil if none.
  • trx.music.play(id[, opts])

    Plays specified track. opts.mode selects a play mode constant. Errors if the track ID or mode is invalid.
    Examples:
    • trx.music.play(1)

      Plays track 1 once.
    • trx.music.play(2, { mode = trx.music.PlayMode.LOOPED })

      Plays track 2 as a looped track.
  • trx.music.pause()

    Pauses the music.
  • trx.music.unpause()

    Resumes paused music.
  • trx.music.stop()

    Stops all music.

Play mode constants

  • trx.music.PlayMode.ALWAYS
    Plays the track once; after it finishes, any active looped track resumes.
  • trx.music.PlayMode.LOOPED
    Plays the track in looped mode continuously. This track becomes the ambient track.
  • trx.music.PlayMode.TRACKED
    Plays the track once but prevents retriggering if it's already playing.
  • trx.music.PlayMode.DELAYED
    Schedules the track for later playback without starting it immediately.