API Registry

Player registry

• Functions
  • Musician.Registry.Init
  • Musician.Registry.DisplayPlayerCount
  • Musician.Registry.FetchPlayers
  • Musician.Registry.UpdatePlayerPositionAndGUID
  • Musician.Registry.PlayerIsInLoadingRange
  • Musician.Registry.PlayerIsInRange
  • Musician.Registry.GetPlayerGUID
  • Musician.Registry.GetDetailedPlayerTooltipText
  • Musician.Registry.GetPlayerTooltipText
  • Musician.Registry.FormatPlayerTooltipVersion
  • Musician.Registry.UpdateTooltipInfo
  • Musician.Registry.UpdatePlayerTooltip
  • Musician.Registry.SendHello
  • Musician.Registry.SetPlayerVersion
  • Musician.Registry.OnHello
  • Musician.Registry.OnQuery
  • Musician.Registry.RegisterPlayer
  • Musician.Registry.UnregisterPlayer
  • Musician.Registry.PlayerIsRegistered
  • Musician.Registry.PlayerIsRegisteredWithNoVersion
  • Musician.Registry.PlayerIsRegisteredWithVersion
  • Musician.Registry.GetVersionString
  • Musician.Registry.ExtractVersionAndProtocol
  • Musician.Registry.GetPlayerVersion
  • Musician.Registry.NotifyNewVersion

Functions

Musician.Registry.Init

Initialize registry

Musician.Registry.Init()

Musician.Registry.DisplayPlayerCount

Displays the number of other online players with Musician in the chat window.

Musician.Registry.DisplayPlayerCount()

Musician.Registry.FetchPlayers

Fetch the connected players

Musician.Registry.FetchPlayers()

Musician.Registry.UpdatePlayerPositionAndGUID

Update player's position and GUID

Musician.Registry.UpdatePlayerPositionAndGUID(player, posY, posX, posZ, instanceID, guid)

Arguments

• player (string)
• posY (number)
• posX (number)
• posZ (number)
• instanceID (string)
• guid (string)

Musician.Registry.PlayerIsInLoadingRange

Return true if the player is in loading range

isInLoadingRange = Musician.Registry.PlayerIsInLoadingRange(player)

Arguments

• player (string)

Returns

• isInLoadingRange (boolean)

Musician.Registry.PlayerIsInRange

Return true if the player is in listening range

isInRange = Musician.Registry.PlayerIsInRange(player)

Arguments

• player (string)

Returns

• isInRange (boolean)

Musician.Registry.GetPlayerGUID

Return player GUID

guid = Musician.Registry.GetPlayerGUID(player)

Arguments

• player (string)

Returns

• guid (string)

Musician.Registry.GetDetailedPlayerTooltipText

Return detailed player tooltip text, including plugin information

infoText = Musician.Registry.GetDetailedPlayerTooltipText(player, noDetail)

Arguments

• player (string)
• noDetail (boolean) Don't include plugin information when true

Returns

• infoText (string)

Musician.Registry.GetPlayerTooltipText

Return player tooltip text, without plugin information

infoText = Musician.Registry.GetPlayerTooltipText(player)

Arguments

• player (string)

Returns

• infoText (string)

Musician.Registry.FormatPlayerTooltipVersion

Format player tooltip version text

infoText = Musician.Registry.FormatPlayerTooltipVersion(playerVersion, playerPlugins)

Arguments

• playerVersion (string)
• playerPlugins (string) Space-separated list of plugins and their version (PluginName=version)

Returns

• infoText (string)

Musician.Registry.UpdateTooltipInfo

Update missing Musician client version in tooltip, if applicable.

Musician.Registry.UpdateTooltipInfo(tooltip, player, fontSize, r, g, b)

Arguments

• tooltip (table)
• player (string)
• fontSize (int) (default=nil)
• r (number) (default=1)
• g (number) (default=1)
• b (number) (default=1)

Musician.Registry.UpdatePlayerTooltip

Update player tooltip to add missing Musician client version, if applicable.

Musician.Registry.UpdatePlayerTooltip(player)

Arguments

• player (string)

Musician.Registry.SendHello

Send a Hello to the channel

Musician.Registry.SendHello()

Musician.Registry.SetPlayerVersion

Set player version

Musician.Registry.SetPlayerVersion(player, version)

Arguments

• player (string)
• version (string)

Musician.Registry.OnHello

Receive Hello message

Musician.Registry.OnHello()

Musician.Registry.OnQuery

Receive Query message

Musician.Registry.OnQuery()

Musician.Registry.RegisterPlayer

Add player to registry

Musician.Registry.RegisterPlayer(player)

Arguments

• player (string)

Musician.Registry.UnregisterPlayer

Remove player from registry

Musician.Registry.UnregisterPlayer(player)

Arguments

• player (string)

Musician.Registry.PlayerIsRegistered

Return true if this player has Musician

isRegistered = Musician.Registry.PlayerIsRegistered(player)

Arguments

• player (string)

Returns

• isRegistered (boolean)

Musician.Registry.PlayerIsRegisteredWithNoVersion

Return true if this player has Musician but with unknown version number

isRegisteredWithNoVersion = Musician.Registry.PlayerIsRegisteredWithNoVersion(player)

Arguments

• player (string)

Returns

• isRegisteredWithNoVersion (boolean)

Musician.Registry.PlayerIsRegisteredWithVersion

Return true if this player has Musician with version number

isRegisteredWithVersion = Musician.Registry.PlayerIsRegisteredWithVersion(player)

Arguments

• player (string)

Returns

• isRegisteredWithVersion (boolean)

Musician.Registry.GetVersionString

Get full version string

Version string contains actual addon version and protocol version

versionAndProtocol = Musician.Registry.GetVersionString()

Returns

• versionAndProtocol (string)

Musician.Registry.ExtractVersionAndProtocol

Extract version and protocol from received version string

version, protocol, plugins = Musician.Registry.ExtractVersionAndProtocol(versionString)

Arguments

• versionString (string)

Returns

• version (string)
• protocol (number)
• plugins (string) Space-separated list of plugins and their version (PluginName=version)

Musician.Registry.GetPlayerVersion

Return version and protocol for player

version, protocol, plugins = Musician.Registry.GetPlayerVersion(player)

Arguments

• player (string)

Returns

• version (string)
• protocol (number)
• plugins (string) Space-separated list of plugins and their version (PluginName=version)

Musician.Registry.NotifyNewVersion

Display a message if a new version of the addon is available

Musician.Registry.NotifyNewVersion(otherVersion)

Arguments

• otherVersion (string)