Module Musician.Registry
Player registry
Functions
Functions
- Musician.Registry.ExtractVersionAndProtocol (versionAndProtocol)
-
Extract version and protocol from received version string
Parameters:
- versionAndProtocol (string)
Returns:
- version (string)
- protocol (number)
- Musician.Registry.FetchPlayers ()
- Fetch the connected players
- Musician.Registry.GetPlayerGUID (player)
-
Return player GUID
Parameters:
- player (string)
Returns:
-
guid (string)
- Musician.Registry.GetPlayerTooltipText (player)
-
Return player tooltip text
Parameters:
- player (string)
Returns:
-
infoText (string)
- Musician.Registry.GetPlayerVersion (player)
-
Return version and protocol for player
Parameters:
- player (string)
Returns:
- version (string)
- protocol (number)
- Musician.Registry.GetVersionString ()
-
Get full version string
Version string contains actual addon version and protocol version
Returns:
-
versionAndProtocol (string)
- Musician.Registry.Init ()
- Initialize registry
- Musician.Registry.NotifyNewVersion (otherVersion)
-
Display a message if a new version of the addon is available
Parameters:
- otherVersion (string)
- Musician.Registry.OnHello (prefix, version, distribution, player)
-
Receive Hello message
Parameters:
- prefix
- version
- distribution
- player
- Musician.Registry.OnQuery (prefix, version, distribution, player)
-
Receive Query message
Parameters:
- prefix
- version
- distribution
- player
- Musician.Registry.PlayerIsInLoadingRange (player)
-
Return true if the player is in loading range
Parameters:
- player (string)
Returns:
-
isInLoadingRange (boolean)
- Musician.Registry.PlayerIsInRange (player)
-
Return true if the player is in listening range
Parameters:
- player (string)
Returns:
-
isInRange (boolean)
- Musician.Registry.PlayerIsRegistered (player)
-
Return true if this player has Musician
Parameters:
- player (string)
Returns:
-
isRegistered (boolean)
- Musician.Registry.PlayerIsRegisteredWithNoVersion (player)
-
Return true if this player has Musician but with unknown version number
Parameters:
- player (string)
Returns:
-
isRegisteredWithNoVersion (boolean)
- Musician.Registry.PlayerIsRegisteredWithVersion (player)
-
Return true if this player has Musician with version number
Parameters:
- player (string)
Returns:
-
isRegisteredWithVersion (boolean)
- Musician.Registry.RegisterPlayer (player)
-
Add player to registry
Parameters:
- player (string)
- Musician.Registry.SendHello ()
- Send a Hello to the channel
- Musician.Registry.SetPlayerVersion (player, version)
-
Set player version
Parameters:
- player (string)
- version (string)
- Musician.Registry.UnregisterPlayer (player)
-
Remove player from registry
Parameters:
- player (string)
- Musician.Registry.UpdatePlayerPositionAndGUID (player, posY, posX, posZ, instanceID, guid)
-
Update player's position and GUID
Parameters:
- player (string)
- posY (number)
- posX (number)
- posZ (number)
- instanceID (string)
- guid (string)
- Musician.Registry.UpdatePlayerTooltip (player)
-
Update player tooltip to add missing Musician client version, if applicable.
Parameters:
- player (string)
- Musician.Registry.UpdateTooltipInfo (tooltip, player, fontSize)
-
Update missing Musician client version in tooltip, if applicable.
Parameters:
- tooltip (table)
- player (string)
- fontSize (int)