Nameplate Aura Filter

[Zaqqari]

Fizzlemizz helped me with an addon a while ago to filter the nameplate auras by spell ID, and it works great. The only thing I wish I could do with it is stop it from filtering friendly nameplates. By default, friendly nameplates show all dispellable debuffs. You can't modify friendly nameplates in dungeon and raid instances, so I'd like to keep the debuffs consistent by disabling the filter on friendly nameplates.

Also, forgive my ignorance, but is there anywhere I can find a list of everything you can do with the WoW API (e.g. INCLUDE_NAME_PLATE_ONLY, Mixin, BUFF_MAX_DISPLAY, UnitIsUnit, etc.)? I'm just guessing at what these things do without much success. I'd like to learn how to write my own addons from start to finish, but I don't really know where to find good information. Most of the links I find in guides are outdated or no longer active.

local whitelist = {

	[116841] = "player",--Tiger's Lust
	[228287] = "player",--Mark of the Crane
	[115078] = "all",--Paralysis
	
}

local function newShouldShowBuff(self, name, caster, nameplateShowPersonal, nameplateShowAll, duration)
	local filter = "INCLUDE_NAME_PLATE_ONLY"
	if UnitIsUnit(self.unit, "player") then
		filter = "HELPFUL|".. filter
	else
		filter = "HARMFUL|".. filter
	end
	for i=1, BUFF_MAX_DISPLAY do 
		local spellName, _, _, _, spellDuration, _, spellCaster, _, _, spellId = UnitAura(self.unit, i, filter);
		if not spellName then break end
		if name == spellName and caster == spellCaster and duration == spellDuration then
			if (caster and whitelist[spellId] == spellCaster) or whitelist[spellId] == "all" then
				return true
			end
		end
	end
	return false
end
local function Mixin(baseFrame)
	baseFrame.UnitFrame.BuffFrame.ShouldShowBuff = newShouldShowBuff
end
local f = CreateFrame("Frame")
f:RegisterEvent("NAME_PLATE_UNIT_ADDED")
f:SetScript("OnEvent", function(_,_,unitId)
	Mixin(C_NamePlate.GetNamePlateForUnit(unitId))
end)
for _,baseFrame in pairs(C_NamePlate.GetNamePlates()) do
	Mixin(baseFrame)
end

[Fizzlemizz]

You should be able to do something like changing:

local function Mixin(baseFrame)
    baseFrame.UnitFrame.BuffFrame.ShouldShowBuff = newShouldShowBuff
end

too:

local function Mixin(baseFrame)
    if not UnitIsEnemy(baseFrame.UnitFrame.unit, "player") then return end
    baseFrame.UnitFrame.BuffFrame.ShouldShowBuff = newShouldShowBuff
end

So friendly units don't receive the filter. There may well be a better way.

For documentation, WowPedia is probably the best other than asking questions here or one of the other WoW UI focused websites like the WoW UI forum or Discord

[Zaqqari]

Thanks so much for the response. It doesn't seem to work. All auras reset to default. Also, to clarify, I'd like my personal resource display to show whitelisted auras as well. I only want to ignore non-self friendly nameplates.

I replaced that function with:

local function Mixin(baseFrame)
    if UnitIsFriend(baseFrame.UnitFrame.unit, "player") and not UnitIsUnit(baseFrame.UnitFrame.unit, "player")then return end
    baseFrame.UnitFrame.BuffFrame.ShouldShowBuff = newShouldShowBuff
end

It works for a bit, but then it starts filtering friendly nameplates again. I'm working on it, but not much luck.

[Fizzlemizz]

You want the whitelist on your character and other friendly "players".

Everyone else has no buffs or everyone else has all buffs?

[Zaqqari]

I want the whitelist to work on my personal resource display and enemy units. Because Blizzard made it so you can't modify friendly nameplates in dungeon and raid instances, I would like to ignore those units for consistency.

Self: Whitelisted buffs
Friendlies: Blizzard's default auras (ignored by the Lua script)
Enemies: Whitelisted debuffs

The script in my previous post works the way I want it to at first and then at some point begins filtering friendly nameplates. I've only tested it in random battlegrounds, if that helps.

[Kanegasi]

local whitelist = {
 
    [116841] = "player", --Tiger's Lust
    [228287] = "player", --Mark of the Crane
    [115078] = "all", --Paralysis
    
}
 
local function replacefilter(unit)
    C_NamePlate.GetNamePlateForUnit(unit).UnitFrame.BuffFrame.ShouldShowBuff=function(self,name,caster,nameplateShowPersonal,nameplateShowAll,duration)
        if name then
            local isPlayer=UnitIsUnit(self.unit,"player")
            local isEnemy=UnitCanAttack(self.unit,"player")
            local filter=isPlayer and "HELPFUL" or "HARMFUL"
            if isPlayer or isEnemy then
                for i=1,BUFF_MAX_DISPLAY do 
                    local spellName,_,_,_,spellDuration,_,spellCaster,_,_,spellId=UnitAura(self.unit,i,filter)
                    if not spellName then break end
                    if name==spellName and caster==spellCaster and duration==spellDuration then
                        if whitelist[spellId]==caster or whitelist[spellId]=="all" then
                            return true
                        end
                    end
                end
            else
                return nameplateShowAll or (nameplateShowPersonal and (caster=="player" or caster=="pet" or caster=="vehicle"))
            end
        end
        return false
    end
end
local f=CreateFrame("frame")
f:RegisterEvent("NAME_PLATE_UNIT_ADDED")
f:SetScript("OnEvent",function(_,_,unit) replacefilter(unit) end)

I had a go at reorganizing the code. Some notes:

• Filtering friendly at function replacement won't work, since all 40 nameplate frames will eventually get the replacement due to frame pooling, so you have to filter within the replacement function.
• Additionally, you don't have to worry about touching instanced friendly nameplates, separate events deal with separate secure frames while still maintaining a max of 40 nameplates active at once (e.g. FORBIDDEN_NAME_PLATE_CREATED)
• The original ShouldShowBuff has a name==nil escape, which I think should still be included.
• Since this is a usermade whitelist, INCLUDE_NAME_PLATE_ONLY should be dropped, or you may end up having an aura you want not show up if Blizzard decided it shouldn't show on nameplates.
• From my experience with a personal addon dealing with attached nameplate frames, UnitIsFriend is not consistent with neutral units, so UnitCanAttack is used instead.
• Finally, the long return line is from the original ShouldShowBuff, allowing friendly nameplates affected by this replaced function to behave as Blizzard's code intended.

NAME_PLATE_CREATED happens before UnitFrame is added, so stick with the original UNIT_ADDED event

[Zaqqari]

Hey, thanks for the help! It's not working at all. It defaults back to Blizzards nameplate auras. Here is the error report from BugGrabber:

21x ...eNameplateAuraFilter\NameplateAuraFilter-1.0.lua:1797: attempt to index field 'UnitFrame' (a nil value)
[string "@NameplateAuraFilter\NameplateAuraFilter-1.0.lua"]:1797: in function <...eNameplateAuraFilter\NameplateAuraFilter.lua:1796>
[string "@NameplateAuraFilter\NameplateAuraFilter-1.0.lua"]:1821: in function <...eNameplateAuraFilter\NameplateAuraFilter.lua:1821>
 
Locals:
nameplate = NamePlate1 {
 OnSizeChanged = <function> defined @Blizzard_NamePlates\Blizzard_NamePlates.lua:485
 GetPreferredInsets = <function> defined @Blizzard_NamePlates\Blizzard_NamePlates.lua:466
 GetAdditionalInsetPadding = <function> defined @Blizzard_NamePlates\Blizzard_NamePlates.lua:455
 ApplyOffsets = <function> defined @Blizzard_NamePlates\Blizzard_NamePlates.lua:437
 OnRemoved = <function> defined =[C]:-1
 OnAdded = <function> defined =[C]:-1
 template = "NamePlateUnitFrameTemplate"
 0 = <userdata>
 OnOptionsUpdated = <function> defined @Blizzard_NamePlates\Blizzard_NamePlates.lua:431
}
(*temporary) = nil
(*temporary) = nil
(*temporary) = "attempt to index field 'UnitFrame' (a nil value)"
whitelist = <table> {
 358259 = "all"
 22703 = "all"
 25771 = "all"
 201158 = "all"
 45334 = "all"
 202274 = "all"
 453 = "all"
 221527 = "all"
 31935 = "all"
 208618 = "all"
 206961 = "all"
 200108 = "all"
 211015 = "all"
 317589 = "all"
 202244 = "all"
 331866 = "player"
 324748 = "player"
 212540 = "all"
 118 = "all"
 202914 = "all"
 323996 = "all"
 91800 = "all"
 119611 = "player"
 217832 = "all"
 205369 = "all"
 119381 = "all"
 15487 = "all"
 324263 = "all"
 221562 = "all"
 122783 = "player"
 324867 = "player"
 323524 = "player"
 307871 = "all"
 205147 = "player"
 20066 = "all"
 125174 = "player"
 212638 = "all"
 325886 = "all"
 344021 = "player"
 287254 = "all"
 337341 = "player"
 196733 = "player"
 337571 = "player"
 10326 = "all"
 356567 = "all"
 213691 = "all"
 116680 = "player"
 207736 = "all"
 236273 = "all"
 2094 = "all"
 61305 = "all"
 161353 = "all"
 236077 = "all"
 233582 = "all"
 343294 = "all"
 115804 = "player"
 123725 = "player"
 202090 = "player"
 325190 = "player"
 161354 = "all"
 199085 = "all"
 196608 = "player"
 199845 = "all"
 31661 = "all"
 206649 = "all"
 202346 = "all"
 290512 = "player"
 117526 = "all"
 5211 = "all"
 215479 = "player"
 198819 = "all"
 132169 = "all"
 205630 = "all"
 196737 = "player"
 33395 = "all"
 334693 = "all"
 5246 = "all"
 99 = "all"
 213688 = "all"
 408 = "all"
 305485 = "all"
 247483 = "player"
 243435 = "player"
 195630 = "player"
 209584 = "player"
 89766 = "all"
 287712 = "all"
 233395 = "all"
 203337 = "all"
 87204 = "all"
 20549 = "all"
 6789 = "all"
 6358 = "all"
 5484 = "all"
 1098 = "all"
 24394 = "all"
 126819 = "all"
 6770 = "all"
 171017 = "all"
 322459 = "all"
 211881 = "all"
 30283 = "all"
 61721 = "all"
 853 = "all"
 196942 = "all"
 196741 = "player"
 325202 = "player"
 269352 = "all"
 28271 = "all"
 122278 = "player"
 323673 = "all"
 211010 = "all"
 1513 = "all"
 137639 = "player"
 353509 = "player"
 2637 = "all"
 132578 = "player"
 1833 = "all"
 19386 = "all"
 353319 = "all"
 197908 = "player"
 116095 = "player"
 196725 = "player"
 202162 = "player"
 204399 = "all"
 9484 = "all"
 197214 = "all"
 123586 = "player"
 207167 = "all"
 209749 = "all"
 277778 = "all"
 353503 = "player"
 204490 = "all"
 91807 = "all"
 118345 = "all"
 77505 = "all"
 64695 = "all"
 82691 = "all"
 212332 = "all"
 51514 = "all"
 191840 = "player"
 324382 = "all"
 162480 = "all"
 248646 = "player"
 1776 = "all"
 1330 = "all"
 212150 = "all"
 207777 = "all"
 345230 = "player"
 196364 = "all"
 41425 = "all"
 132168 = "all"
 200196 = "all"
 199042 = "all"
 277784 = "all"
 102359 = "all"
 64044 = "all"
 205290 = "all"
 179057 = "all"
 605 = "all"
 207171 = "all"
 203123 = "all"
 325216 = "player"
 233022 = "all"
 202335 = "player"
 325153 = "player"
 277787 = "all"
 204080 = "all"
 116847 = "player"
 115078 = "all"
 255941 = "all"
 202933 = "all"
 28272 = "all"
 217824 = "all"
 8122 = "all"
 332423 = "all"
 325092 = "player"
 105771 = "all"
 212337 = "all"
 116768 = "player"
 198121 = "all"
 336887 = "player"
 163505 = "all"
 201787 = "player"
 228287 = "player"
 108194 = "all"
 277792 = "all"
 105421 = "all"
 198909 = "all"
 124280 = "player"
 122470 = "player"
 228563 = "player"
 207685 = "all"
 121253 = "player"
 233759 = "all"
 107079 = "all"
 210873 = "all"
 116706 = "all"
 116189 = "player"
 354540

[Fizzlemizz]

Kanegasi makes valid points and may well be closer to best method. This is a rework of the original with just an "ignore" for non-player friendlies.
I've been scratching my head as to if/why I would have redefined Mixin like that but...

local whitelist = {
    [116841] = "player",--Tiger's Lust
    [228287] = "player",--Mark of the Crane
    [115078] = "all",--Paralysis
    
}
 
local function newShouldShowBuff(self, name, caster, nameplateShowPersonal, nameplateShowAll, duration)
    if not name then return false end
    local filter = "INCLUDE_NAME_PLATE_ONLY"
    if UnitIsUnit(self.unit, "player") then
        filter = "HELPFUL|"..filter
    elseif UnitIsFriend(self.unit, "player") then
        return true
    else
        filter = "HARMFUL|"..filter
    end
    for i=1, BUFF_MAX_DISPLAY do 
        local spellName, _, _, _, spellDuration, _, spellCaster, _, _, spellId = UnitAura(self.unit, i, filter);
        if not spellName then break end
        if name == spellName and caster == spellCaster and duration == spellDuration then
            if (caster and whitelist[spellId] == spellCaster) or whitelist[spellId] == "all" then
                return true
            end
        end
    end
    return false
end
local f = CreateFrame("Frame")
f:RegisterEvent("NAME_PLATE_UNIT_ADDED")
f:SetScript("OnEvent", function(_,_,unitId)
    C_NamePlate.GetNamePlateForUnit(unitId).UnitFrame.BuffFrame.ShouldShowBuff = newShouldShowBuff
end)
for _,baseFrame in pairs(C_NamePlate.GetNamePlates()) do
    baseFrame.UnitFrame.BuffFrame.ShouldShowBuff = newShouldShowBuff
end

[Zaqqari]

Working perfectly, Fizzlemizz! Thanks both of you for the help, this is a huge improvement for my UI.

[Zaqqari]

Sorry for re-posting, but I'm having another nameplate issue. I have a script that changes the width of nameplates, and it works as long as I'm not in combat when my interface is loaded. The nameplate settings are protected functions and cannot be modified in combat. A workaround for this might be to initiate the script whenever I leave combat in addition to when I load my interface for the first time. I'm trying to add PLAYER_LEAVE_COMBAT to PLAYER_LOGIN, but it's not working.

--Friendly/Enemy Nameplate Size--
local f = CreateFrame("Frame")
f:RegisterEvent("PLAYER_LOGIN")
f:RegisterEvent("PLAYER_LEAVE_COMBAT")
f:SetScript("OnEvent", function()
    
    nameplateSize()
 
end)
 
function nameplateSize()
    
    --Friendly Nameplate Size--
    local FRIENDLY_NAMEPLATE_WIDTH = 85 --Percentage relative to default width.
    local FRIENDLY_NAMEPLATE_HEIGHT = 100 --Percentage relative to default height.
 
 
    local FNW = 110*(FRIENDLY_NAMEPLATE_WIDTH/100)
 
    local FNH = 45*(FRIENDLY_NAMEPLATE_HEIGHT/100)
 
    C_Timer.After(1, function() C_NamePlate.SetNamePlateFriendlySize(((FNH/45/2)*2.44444)/1.22222*FNW, 45) end);
    local f = CreateFrame("Frame")
    f:RegisterEvent("NAME_PLATE_UNIT_ADDED")
    f:SetScript("OnEvent", function(self, event, unit)
    if UnitIsFriend("player", unit) then
    C_NamePlate.GetNamePlateForUnit(unit).UnitFrame:SetScale(FNH/45) --
    else
    end
    end)
 
    --Enemy Nameplate Size--
    local ENEMY_NAMEPLATE_WIDTH = 85 --Percentage relative to default width.
    local ENEMY_NAMEPLATE_HEIGHT = 100 --Percentage relative to default height.
 
 
    local FNW = 110*(ENEMY_NAMEPLATE_WIDTH/100)
 
    local FNH = 45*(ENEMY_NAMEPLATE_HEIGHT/100)
 
    C_Timer.After(1, function() C_NamePlate.SetNamePlateEnemySize(((FNH/45/2)*2.44444)/1.22222*FNW, 45) end);
    local f = CreateFrame("Frame")
    f:RegisterEvent("NAME_PLATE_UNIT_ADDED")
    f:SetScript("OnEvent", function(self, event, unit)
    if UnitIsEnemy("player", unit) then
    C_NamePlate.GetNamePlateForUnit(unit).UnitFrame:SetScale(FNH/45) --
    else
    end
    end)
    
    --Personal Nameplate Size--
    local SELF_NAMEPLATE_WIDTH = 100 --Percentage relative to default width.
    local SELF_NAMEPLATE_HEIGHT = 100 --Percentage relative to default height.
 
 
    local FNW = 110*(SELF_NAMEPLATE_WIDTH/100)
 
    local FNH = 45*(SELF_NAMEPLATE_HEIGHT/100)
 
    C_Timer.After(1, function() C_NamePlate.SetNamePlateSelfSize(((FNH/45/2)*2.44444)/1.22222*FNW, 45) end);
    local f = CreateFrame("Frame")
    f:RegisterEvent("NAME_PLATE_UNIT_ADDED")
    f:SetScript("OnEvent", function(self, event, unit)
    if UnitIsEnemy("player", unit) then
    C_NamePlate.GetNamePlateForUnit(unit).UnitFrame:SetScale(FNH/45) --
    else
    end
    end)
 
end

EDIT: I got it working with PLAYER_REGEN_ENABLED, but I'm not sure that's always going to do the trick. There must be a better way to make the nameplates 85% of their normal width.

[Kanegasi]

There's an issue with having this code happen every time you leave combat. You're creating three frames that listen to the same event every time. Eventually, over the course of a play session, you will have dozens, eventually hundreds, of triggers that lag your game every time a new nameplate appears.

Also, what is the purpose of the one second delays?

I reorganized your code so that only one frame is used. I'm assuming you want the SetScales to happen only when a nameplate appears and the three SetSizes to happen at login or end of combat. InCombatLockdown() reports true/false the status of UI combat protection, which turns on just a frame or so after PLAYER_REGEN_DISABLED and off a frame or so before PLAYER_REGEN_ENABLED.

--Friendly/Enemy Nameplate Size--
local f=CreateFrame("frame")
 
--Personal Nameplate Size--
f.SELF_NAMEPLATE_WIDTH = 100 --Percentage relative to default width.
f.SELF_NAMEPLATE_HEIGHT = 100 --Percentage relative to default height.
f.SNW = 110*(f.SELF_NAMEPLATE_WIDTH/100)
f.SNH = 45*(f.SELF_NAMEPLATE_HEIGHT/100)
 
--Enemy Nameplate Size--
f.ENEMY_NAMEPLATE_WIDTH = 85 --Percentage relative to default width.
f.ENEMY_NAMEPLATE_HEIGHT = 100 --Percentage relative to default height.
f.ENW = 110*(f.ENEMY_NAMEPLATE_WIDTH/100)
f.ENH = 45*(f.ENEMY_NAMEPLATE_HEIGHT/100)
 
--Friendly Nameplate Size--
f.FRIENDLY_NAMEPLATE_WIDTH = 85 --Percentage relative to default width.
f.FRIENDLY_NAMEPLATE_HEIGHT = 100 --Percentage relative to default height.
f.FNW = 110*(f.FRIENDLY_NAMEPLATE_WIDTH/100)
f.FNH = 45*(f.FRIENDLY_NAMEPLATE_HEIGHT/100)
 
f:RegisterEvent("PLAYER_LOGIN")
f:RegisterEvent("PLAYER_REGEN_ENABLED")
f:RegisterEvent("NAME_PLATE_UNIT_ADDED")
f:SetScript("OnEvent",function(self,event,unit)
    if not InCombatLockdown() then
        if unit then
            if UnitIsUnit(unit,"player") then
                C_NamePlate.GetNamePlateForUnit(unit).UnitFrame:SetScale(self.SNH/45) --
            elseif UnitCanAttack(unit,"player") then
                C_NamePlate.GetNamePlateForUnit(unit).UnitFrame:SetScale(self.ENH/45) --
            else
                C_NamePlate.GetNamePlateForUnit(unit).UnitFrame:SetScale(self.FNH/45) --
            end
        end
        C_NamePlate.SetNamePlateSelfSize(((self.SNH/45/2)*2.44444)/1.22222*self.SNW,45)
        C_NamePlate.SetNamePlateEnemySize(((self.ENH/45/2)*2.44444)/1.22222*self.ENW,45)
        C_NamePlate.SetNamePlateFriendlySize(((self.FNH/45/2)*2.44444)/1.22222*self.FNW,45)
    end
end)

[Zaqqari]

Perhaps I should have been more clear. I didn't write the script, and I don't even remember where I found it. I eventually got it to work using OnUpdate at 0.1s intervals, but I don't know how optimal that is. I'm just learning this stuff from scratch, so most of it goes right over my head. I tried your script, and it's not working.

From BugSack:

1x ZaqqUI\ZaqqUI-1.0.lua:7: attempt to perform arithmetic on global 'SELF_NAMEPLATE_WIDTH' (a nil value)
[string "@ZaqqUI\ZaqqUI-1.0.lua"]:7: in main chunk
 
Locals:
f = <unnamed> {
 SELF_NAMEPLATE_WIDTH = 100
 SELF_NAMEPLATE_HEIGHT = 100
 0 = <userdata>
}
(*temporary) = nil
(*temporary) = <unnamed> {
 SELF_NAMEPLATE_WIDTH = 100
 SELF_NAMEPLATE_HEIGHT = 100
 0 = <userdata>
}
(*temporary) = nil
(*temporary) = <userdata>
(*temporary) = "attempt to perform arithmetic on global 'SELF_NAMEPLATE_WIDTH' (a nil value)"

[Kanegasi]

Oops, missed some frame references to your variables that used to be local. Probably could've kept those local. My base goal with those was to put the three letter variables into indexes of the frame.

I edited my code above. I also shifted the setsizes around so that they happen every registered event.

[Zaqqari]

After testing it for a while, it's been working consistently, and it doesn't revert to default width anymore. Thanks for all your help again, and I hope this is useful to someone else as well.

[Zaqqari]

This addon has stopped working recently. It shows no auras on nameplates. BugGrabber is not getting anything.

local whitelist = {
    [SpellID] = "player",--Aura Name
    [SpellID] = "pet",--Aura Name
    [SpellID] = "all",--Aura Name
    
}
 
local function newShouldShowBuff(self, name, caster, nameplateShowPersonal, nameplateShowAll, duration)
    if not name then return false end
    local filter = "INCLUDE_NAME_PLATE_ONLY"
    if UnitIsUnit(self.unit, "player") then
        filter = "HELPFUL|"..filter
    elseif UnitIsFriend(self.unit, "player") then
        return true
    else
        filter = "HARMFUL|"..filter
    end
    for i=1, BUFF_MAX_DISPLAY do 
        local spellName, _, _, _, spellDuration, _, spellCaster, _, _, spellId = UnitAura(self.unit, i, filter);
        if not spellName then break end
        if name == spellName and caster == spellCaster and duration == spellDuration then
            if (caster and whitelist[spellId] == spellCaster) or whitelist[spellId] == "all" then
                return true
            end
        end
    end
    return false
end
local f = CreateFrame("Frame")
f:RegisterEvent("NAME_PLATE_UNIT_ADDED")
f:SetScript("OnEvent", function(_,_,unitId)
    C_NamePlate.GetNamePlateForUnit(unitId).UnitFrame.BuffFrame.ShouldShowBuff = newShouldShowBuff
end)
for _,baseFrame in pairs(C_NamePlate.GetNamePlates()) do
    baseFrame.UnitFrame.BuffFrame.ShouldShowBuff = newShouldShowBuff
end

I think this could have something to do with it(?):
https://us.forums.blizzard.com/en/wo...ations/1205007