Module Musician.CrossRP
Enables cross realm and cross faction communication through the CrossRP add-on.
Functions
Functions
- Musician.CrossRP.GetAdverseBand ()
-
Return player's adverse band (ie 537H for EU-KirinTor Alliance)
Returns:
-
(string)
- Musician.CrossRP.GetBroadcastDestination ()
-
Return CrossRP destination for broadcast, based on the presence of nearby foreign players
Returns:
-
(array)
- Musician.CrossRP.GetFactionId (faction)
-
Return faction ID from faction name
Parameters:
- faction (string) (Horde, Alliance or Neutral)
Returns:
-
(string) (H, A or N)
- Musician.CrossRP.GetHelloString ()
-
Return data string for CrossRP Hello/Query messages
Returns:
-
(string)
- Musician.CrossRP.GetUnitDestination (unit)
-
Return destination string for targetted unit
Parameters:
- unit (string)
Returns:
-
(string)
- Musician.CrossRP.Init ()
- Init
- Musician.CrossRP.InitTipsAndTricks ()
- Initialize tips and tricks
- Musician.CrossRP.OnHelloOrQuery (source, message, complete)
-
Process a received version number from a Hello or a Query message
Parameters:
- source (string)
- message (string)
- complete (boolean)
- Musician.CrossRP.OnSongChunk (source, message, complete)
-
Process a received music chunk
Parameters:
- source (string)
- message (string)
- complete (boolean)
- Musician.CrossRP.OnSongStop (source, message, complete)
-
Process a received music stop
Parameters:
- source (string)
- message (string)
- complete (boolean)
- Musician.CrossRP.RegisterPlayerFromSource (source[, guid])
-
Register player from its source string
Parameters:
- source (string)
- guid (string) (optional)
- Musician.CrossRP.SendHello ([destination="all"])
-
Send a Hello message
Parameters:
- destination (string) (default "all")
- Musician.CrossRP.StopSong ()
- Stop song
- Musician.CrossRP.StreamCompressedSongChunk (compressedChunk)
-
Send a compressed chunk
Parameters:
- compressedChunk (string)
- Musician.CrossRP:OnEnable ()
- OnEnable