C_NamePlate.GetNamePlates

Main Menu
WoW API Widget API Widget scripts Lua API Events CVars XML schema Macro commands Combat Log Escape sequences API changes HOWTOs Snippets UI tech. Category nav.

→ API by Alphabet

→ API Overview

→ C_NamePlate

C_NamePlate provides two functions to return tables describing currently-visible name plates:

• GetNamePlates() returns a table containing one subtable for each of nameplate1 to nameplateN; or an empty table if there are no visible nameplates.
• GetNamePlateForUnit() returns a table for a single unitId; or nil if the given unit has no visible nameplate.

{ {nameplate1}, {nameplate2}, ... } = GetNamePlates(isSecure)
{nameplate1} = GetNamePlateForUnit(unitId, isSecure)

Arguments

isSecure 

Boolean

unitId 

String - Unit described by its UnitId

Returns

Each nameplate, beginning with nameplate1 if it exists, is described by a struct.

Details

• Despite each nameplate being a kind of Button extended by "BaseNamePlateUnitFrameTemplate", the tables returned by these functions are not the actual UIObjects.

Patch changes

• Patch 7.0.3 (2016-07-19): Added.
  [7.0.3 API changes]
  
  

External links

• GitHub FrameXML, Gethe
• Globe "wut?" Tool, Townlong-Yak