Module Musician
Main module
Functions
| AddModule (moduleName) | Add a module |
| AddTipsAndTricks (callback, priority) | Add a tips and tricks callback |
| GetCommands () | Get command definitions |
| Help () | Display command-line help |
| ImportSource (str) | Import song from encoded string |
| MutePlayer (playerName, isMuted) | Mute or unmute a player |
| OnEnable () | OnEnable |
| OnInitialize () | OnInitialize |
| OnSongPlayed (event, song) | Handle playing song |
| OnSourceImportFailed () | Handle failed source import |
| OnSourceImportSuccessful (event, song, data) | Handle successful source import |
| OnUpdate (frame, elapsed) | Perform all on-frame actions |
| PlayerIsMuted (playerName) | Return true if the player is muted |
| RunCommandLine (commandLine) | Run command line |
| SetupHooks () | Setup hooks |
| ShowTipsAndTricks (callback) | Show the first tips and tricks |
| StopPlayerSong (playerName, remove) | Stop a song playing by a player |
Functions
- AddModule (moduleName)
-
Add a module
Parameters:
- moduleName (string)
- AddTipsAndTricks (callback, priority)
-
Add a tips and tricks callback
Parameters:
- callback (function)
- priority (boolean) If true, add the tip to the top of the list
- GetCommands ()
-
Get command definitions
Returns:
-
commands (table)
- Help ()
- Display command-line help
- ImportSource (str)
-
Import song from encoded string
Parameters:
- str (string)
- MutePlayer (playerName, isMuted)
-
Mute or unmute a player
Parameters:
- playerName (string)
- isMuted (boolean)
- OnEnable ()
- OnEnable
- OnInitialize ()
- OnInitialize
- OnSongPlayed (event, song)
-
Handle playing song
Parameters:
- event (table)
- song (Musician.Song)
- OnSourceImportFailed ()
- Handle failed source import
- OnSourceImportSuccessful (event, song, data)
-
Handle successful source import
Parameters:
- event (string)
- song (Musician.Song)
- data (string)
- OnUpdate (frame, elapsed)
-
Perform all on-frame actions
Parameters:
- frame (Frame)
- elapsed (number)
- PlayerIsMuted (playerName)
-
Return true if the player is muted
Parameters:
- playerName (string)
Returns:
-
isMuted (boolean)
- RunCommandLine (commandLine)
-
Run command line
Parameters:
- commandLine (string)
- SetupHooks ()
- Setup hooks
- ShowTipsAndTricks (callback)
-
Show the first tips and tricks
Parameters:
- callback (function)
- StopPlayerSong (playerName, remove)
-
Stop a song playing by a player
Parameters:
- playerName (string)
- remove (boolean)