API Main

Main module

• Functions
  • Musician:OnInitialize
  • Musician:OnEnable
  • Musician.AddModule
  • Musician.InitLocale
  • Musician.GetCommands
  • Musician.Help
  • Musician.RunCommandLine
  • Musician.StopPlayerSong
  • Musician.OnSongPlayed
  • Musician.ImportSource
  • Musician.OnSourceImportSuccessful
  • Musician.OnSourceImportFailed
  • Musician.OnUpdate
  • Musician.MutePlayer
  • Musician.PlayerIsMuted
  • Musician.SetupHooks
  • Musician.AddTipsAndTricks
  • Musician.ShowTipsAndTricks

Functions

Musician:OnInitialize

OnInitialize

Musician:OnInitialize()

Musician:OnEnable

OnEnable

Musician:OnEnable()

Musician.AddModule

Add a module

Musician.AddModule(moduleName)

Arguments

• moduleName (string)

Musician.InitLocale

Initialize a locale and returns the initialized message table

msg = Musician.InitLocale(languageCode, languageName, localeCode, ...)

Arguments

• languageCode (string) Short language code (ie 'en')
• languageName (string) Locale name (ie "English")
• localeCode (string) Long locale code (ie 'enUS')
• ... (string) Additional locale codes (optional)

Returns

• msg (table) Initialized message table

Musician.GetCommands

Get command definitions

commands = Musician.GetCommands()

Returns

• commands (table)

Musician.Help

Display command-line help

Musician.Help()

Musician.RunCommandLine

Run command line

Musician.RunCommandLine(commandLine)

Arguments

• commandLine (string)

Musician.StopPlayerSong

Stop a song playing by a player

Musician.StopPlayerSong(playerName, remove)

Arguments

• playerName (string)
• remove (boolean)

Musician.OnSongPlayed

Handle playing song

Musician.OnSongPlayed(event, song)

Arguments

• event (table)
• song (Musician.Song)

Musician.ImportSource

Import song from encoded string

Musician.ImportSource(str)

Arguments

• str (string)

Musician.OnSourceImportSuccessful

Handle successful source import

Musician.OnSourceImportSuccessful(event, song, data)

Arguments

• event (string)
• song (Musician.Song)
• data (string)

Musician.OnSourceImportFailed

Handle failed source import

Musician.OnSourceImportFailed()

Musician.OnUpdate

Perform all on-frame actions

Musician.OnUpdate(frame, elapsed)

Arguments

• frame (Frame)
• elapsed (number)

Musician.MutePlayer

Mute or unmute a player

Musician.MutePlayer(playerName, isMuted)

Arguments

• playerName (string)
• isMuted (boolean)

Musician.PlayerIsMuted

Return true if the player is muted

isMuted = Musician.PlayerIsMuted(playerName)

Arguments

• playerName (string)

Returns

• isMuted (boolean)

Musician.SetupHooks

Setup hooks

Musician.SetupHooks()

Musician.AddTipsAndTricks

Add a tips and tricks callback

Musician.AddTipsAndTricks(callback, priority)

Arguments

• callback (function)
• priority (boolean) If true, add the tip to the top of the list

Musician.ShowTipsAndTricks

Show the first tips and tricks

Musician.ShowTipsAndTricks(callback)

Arguments

• callback (function)