Module Musician.NamePlates

Adds animated notes and music icon in player nameplates.

Functions

Musician.NamePlates.AddNoteIcon (namePlate, textElement, append) Add note icon in nameplate's textElement, if needed
Musician.NamePlates.AttachNamePlate (namePlate, player, event) Attach Musician nameplate
Musician.NamePlates.CreatePlayerAnimatedNotesFrame () Create fixed animated notes frame for the current player
Musician.NamePlates.DetachNamePlate (namePlate) Detach Musician nameplate
Musician.NamePlates.InitTipsAndTricks () Initialize tips and tricks
Musician.NamePlates.OnNamePlateAdded (event, unitToken) OnNamePlateAdded
Musician.NamePlates.OnNamePlateNotesFrameUpdate (animatedNotesFrame, elapsed) OnUpdate handler for the animated notes frame
Musician.NamePlates.OnNamePlateRemoved (event, unitToken) OnNamePlateRemoved
Musician.NamePlates.OnNoteOn (event, song, track, key) Add note to the appropriate animated notes frame
Musician.NamePlates.OnPlayerRegistered (event, player) Update nameplate for player when registered
Musician.NamePlates.OnSetUIVisibility (isVisible) OnSetUIVisibility
Musician.NamePlates.OnUnitFrameUpdate (frame) OnUnitFrameUpdate
Musician.NamePlates.UpdateAll () Update all nameplates
Musician.NamePlates.UpdateNamePlate (namePlate) UpdateNamePlate
Musician.NamePlates.UpdateNamePlateCinematicMode (namePlate) Hide nameplates in cinematic mode if nameplates are not enabled in this mode
Musician.NamePlates.UpdateNoteIcon (namePlate) Update note icon next to player name
Musician.NamePlates:OnEnable () OnEnable


Functions

Musician.NamePlates.AddNoteIcon (namePlate, textElement, append)
Add note icon in nameplate's textElement, if needed

Parameters:

  • namePlate (Frame)
  • textElement (FontString)
  • append (boolean) Add note icon at the end of the string
Musician.NamePlates.AttachNamePlate (namePlate, player, event)
Attach Musician nameplate

Parameters:

  • namePlate (Frame)
  • player (string)
  • event (string)
Musician.NamePlates.CreatePlayerAnimatedNotesFrame ()
Create fixed animated notes frame for the current player
Musician.NamePlates.DetachNamePlate (namePlate)
Detach Musician nameplate

Parameters:

  • namePlate (Frame)
Musician.NamePlates.InitTipsAndTricks ()
Initialize tips and tricks
Musician.NamePlates.OnNamePlateAdded (event, unitToken)
OnNamePlateAdded

Parameters:

  • event (string)
  • unitToken (string)
Musician.NamePlates.OnNamePlateNotesFrameUpdate (animatedNotesFrame, elapsed)
OnUpdate handler for the animated notes frame

Parameters:

  • animatedNotesFrame (Frame)
  • elapsed (number)
Musician.NamePlates.OnNamePlateRemoved (event, unitToken)
OnNamePlateRemoved

Parameters:

  • event (string)
  • unitToken (string)
Musician.NamePlates.OnNoteOn (event, song, track, key)
Add note to the appropriate animated notes frame

Parameters:

  • event (string)
  • song (Musician.Song)
  • track (table)
  • key (Number)
Musician.NamePlates.OnPlayerRegistered (event, player)
Update nameplate for player when registered

Parameters:

  • event (string)
  • player (string)
Musician.NamePlates.OnSetUIVisibility (isVisible)
OnSetUIVisibility

Parameters:

  • isVisible (boolean)
Musician.NamePlates.OnUnitFrameUpdate (frame)
OnUnitFrameUpdate

Parameters:

  • frame (Frame)
Musician.NamePlates.UpdateAll ()
Update all nameplates
Musician.NamePlates.UpdateNamePlate (namePlate)
UpdateNamePlate

Parameters:

  • namePlate (Frame)
Musician.NamePlates.UpdateNamePlateCinematicMode (namePlate)
Hide nameplates in cinematic mode if nameplates are not enabled in this mode

Parameters:

  • namePlate (Frame)
Musician.NamePlates.UpdateNoteIcon (namePlate)
Update note icon next to player name

Parameters:

  • namePlate (Frame)
Musician.NamePlates:OnEnable ()
OnEnable
generated by LDoc 1.4.6 Last updated 2020-08-09 19:40:05