Sorting auras in oUF 1.6.0

Rainrider · 02-13-12, 06:33 PM

Hello,

I'm porting my layout to oUF 1.6.0 and have some issues with sorting auras by remaining duration. Auras are not sorted correctly and gaps appear between them. My code works with the stable oUF version. Here is a stripped down code snippet from what I use for buffs:

lua Code:

local FormatTime = function(seconds)
    local day, hour, minute = 86400, 3600, 60
    if (seconds >= day) then
        return format("%dd", floor(seconds/day + 0.5)), seconds % day
    elseif (seconds >= hour) then
        return format("%dh", floor(seconds/hour + 0.5)), seconds % hour
    elseif (seconds >= minute) then
        if (seconds <= minute * 5) then
            return format("%d:%02d", floor(seconds/60), seconds % minute), seconds - floor(seconds)
        end
        return format("%dm", floor(seconds/minute + 0.5)), seconds % minute
    elseif (seconds >= minute / 12) then
        return floor(seconds + 0.5), (seconds * 100 - floor(seconds * 100)) / 100
    end
    return format("%.1f", seconds), (seconds * 100 - floor(seconds * 100)) / 100
end
 
local CreateAuraTimer = function(self, elapsed)
    if (self.timeLeft) then
        self.elapsed = (self.elapsed or 0) + elapsed
        if (self.elapsed >= 0.1) then
            if (not self.first) then
                self.timeLeft = self.timeLeft - self.elapsed
            else
                self.timeLeft = self.timeLeft - GetTime()
                self.first = false
            end
            if (self.timeLeft > 0) then
                local time = FormatTime(self.timeLeft)
                    self.remaining:SetText(time)
                if (self.timeLeft < 5) then
                    self.remaining:SetTextColor(0.69, 0.31, 0.31)
                else
                    self.remaining:SetTextColor(0.84, 0.75, 0.65)
                end
            else
                self.remaining:Hide()
                self:SetScript("OnUpdate", nil)
            end
            self.elapsed = 0
        end
    end
end
 
local SortAuras = function(a, b)
    if (a and b and a.timeLeft and b.timeLeft) then
        return a.timeLeft > b.timeLeft
    end
end
 
local PostCreateIcon = function(Icons, icon)
    -- remove OmniCC and CooldownCount timers
    icon.cd.noOCC = true
    icon.cd.noCooldownCount = true
    
    icon.count:SetPoint("BOTTOMRIGHT", 1, 1.5)
    icon.count:SetFont(ns.media.FONT, 8, "OUTLINE")
    icon.count:SetTextColor(0.84, 0.75, 0.65)
    icon.count:SetJustifyH("RIGHT")
    
    icon.icon:SetTexCoord(0.1, 0.9, 0.1, 0.9)
 
    icon.overlay:SetTexture(ns.media.BTNTEXTURE)
    icon.overlay:SetPoint("TOPLEFT", -3.5, 3.5)
    icon.overlay:SetPoint("BOTTOMRIGHT", 3.5, -3.5)
    icon.overlay:SetTexCoord(0, 1, 0, 1)
    
    icon.remaining = PutFontString(icon, ns.media.FONT, 8, "OUTLINE", "LEFT")
    icon.remaining:SetPoint("TOP", 0, 1)
end
 
local PreSetPosition = function(Auras)
    table.sort(Auras, SortAuras)
end
 
local PostUpdateIcon
do
    local playerUnits = {
        player = true,
        pet = true,
        vehicle = true,
    }
 
    PostUpdateIcon = function(icons, unit, icon, index, offset)
        local _, _, _, _, _, duration, expirationTime, caster, _ = UnitAura(unit, index, icon.filter)
        
        if (not playerUnits[caster]) then
            if ((UnitCanAttack("player", unit) and icon.isDebuff)
                    or (UnitIsFriend("player", unit) and not icon.isDebuff)) then
                icon.icon:SetDesaturated(true)
                icon.overlay:SetVertexColor(0.5, 0.5, 0.5)
            end
        end
        
        if (duration and duration > 0) then
            icon.remaining:Show()
            icon.timeLeft = expirationTime
            icon:SetScript("OnUpdate", CreateAuraTimer)
        else
            icon.remaining:Hide()
            icon.timeLeft = math.huge
            icon:SetScript("OnUpdate", nil)
        end
 
        icon.first = true
    end
end
 
local AddBuffs = function(self, unit)
    self.Buffs = CreateFrame("Frame", self:GetName().."_Buffs", self)
    self.Buffs.spacing = 6
    self.Buffs.size = (230 - 9 * self.Buffs.spacing) / 10
    self.Buffs.disableCooldown = true
    self.Buffs.showType = true
    self.Buffs.onlyShowPlayer = ns.cfg.onlyShowPlayerBuffs
    self.Buffs.PreSetPosition = PreSetPosition  -- sort auras by time remaining
    self.Buffs.PostCreateIcon = PostCreateIcon  -- set overlay, cd, count, timer font
    self.Buffs.PostUpdateIcon = PostUpdateIcon  -- set icon saturation and update timer
    
    if (unit == "player" or unit == "target") then
        self.Buffs:SetSize(self.Buffs.size * 10 + 9 * self.Buffs.spacing, 4 * self.Buffs.size + 3 * self.Buffs.spacing)
        self.Buffs["growth-y"] = "DOWN"
        
        if (unit == "player") then
            self.Buffs:SetPoint("TOPRIGHT", self, "TOPLEFT", -9, -1)
            self.Buffs.initialAnchor = "TOPRIGHT"
            self.Buffs["growth-x"] = "LEFT"
        else
            self.Buffs:SetPoint("TOPLEFT", self, "TOPRIGHT", 9, -1)
            self.Buffs.initialAnchor = "TOPLEFT"
            self.Buffs["growth-x"] = "RIGHT"
        end
    end
    
    if (unit == "pet") then
        self.Buffs:SetPoint("RIGHT", self.Debuffs, "LEFT", -5, 0)
        self.Buffs.num = 6
        self.Buffs:SetSize(self.Buffs.num * self.Buffs.size + (self.Buffs.num - 1) * self.Buffs.spacing, self.Buffs.size)
        self.Buffs.initialAnchor = "RIGHT"
        self.Buffs["growth-x"] = "LEFT"
    end
    
    if (unit:match("boss%d")) then
        self.Buffs:SetPoint("TOPLEFT", self, "TOPRIGHT", 15, 0)
        self.Buffs.num = 6
        self.Buffs:SetSize(self.Buffs.num * self.Buffs.size + (self.Buffs.num - 1) * self.Buffs.spacing, self.Buffs.size)
        self.Buffs.initialAnchor = "LEFT"
        self.Buffs["growth-x"] = "RIGHT"
    end
end
ns.AddBuffs = AddBuffs

Full code can be found at https://github.com/Rainrider/oUF_Rai..._functions.lua

Here a screen of what happens:

Green area is for buffs, red for debuffs. The upper part is the result of buffing myself with Mark of the Wild and Thorns and switching to bear form. The lower part is after Thorns ticked out. The standart buff display is showing the buffs sorted by index.

Is this an error on my part or is it a bug in oUF?

haste · 02-14-12, 02:02 AM

Looks like the issue on oUF's side. I'll going to push a fix for this and a small API change when I get home later today.

The change will be that :PreSetPosition() can return two values, which tell oUF what range of auras it needs to re-position. It currently attempts to re-position them on every try, but it uses the default range.

Rainrider · 02-14-12, 08:38 PM

It works now. I return 0 and #auras. Haven't been able to test whether there is any difference between say #buffs and buffs.visibleBuffs, but there is a problem if the layout returns toRange greater than the current number of auras (tested this with returning the max number of auras that you pass to PreSetPosition. Maybe you could safe guard this by breaking the loop in SetPosition if not button). You also forgot to make the change for buffs and debuffs.

And another one I wasn't able to understand: Your range in SetPosition is from 0 (anchoredIcons) to the number of created icons. In Update you call SetPosition with a range form 1 to createdIcons. SetPosition would then start to anchor from the second aura and leave a gap of 1 button at the start, wouldn't it?

haste · 02-17-12, 02:47 PM

Originally Posted by Rainrider

It works now. I return 0 and #auras. Haven't been able to test whether there is any difference between say #buffs and buffs.visibleBuffs,

You probably meant buffs.createdIcons and #buffs, those two should never be different, but there isn't too much hassle keeping the variable around. It also saves Lua from having to traverse the table to figure out the number of elements.

Originally Posted by Rainrider

but there is a problem if the layout returns toRange greater than the current number of auras (tested this with returning the max number of auras that you pass to PreSetPosition. Maybe you could safe guard this by breaking the loop in SetPosition if not button). You also forgot to make the change for buffs and debuffs.

I'll make :SetPosition bail once it doesn't find a button. Also added the missing :PreSetPosition returns. Thanks

Originally Posted by Rainrider

And another one I wasn't able to understand: Your range in SetPosition is from 0 (anchoredIcons) to the number of created icons. In Update you call SetPosition with a range form 1 to createdIcons. SetPosition would then start to anchor from the second aura and leave a gap of 1 button at the start, wouldn't it?

That's a bug. The code path is only used when someone wants to force the aura element to re-position the icons. I should probably change :SetPosition to work from 1 and up instead, it makes a lot more sense from a common Lua perspective. Thanks again

Rainrider · 02-18-12, 10:53 AM

Originally Posted by haste

You probably meant buffs.createdIcons and #buffs, those two should never be different, but there isn't too much hassle keeping the variable around. It also saves Lua from having to traverse the table to figure out the number of elements.

I want to return the lowest possible range in order to spare table traversion and reanchoring, which means I would only want to sort and reanchor what's visible. If I read this right, you increment createdIcons in createAuraIcon before calling customFilter, meaning createdIcons >= visible{Auras|Buffs|Debuffs}. If #{auras|buffs|debuffs} == createdIcons, then I return a higher range than I need to and thus do SetPosition on icons I don't see. So I don't quite get it why we run SetPosition up to createdIcons and not visible{Auras|Buffs|Debuffs}. And because there are no gaps after SetPosition I believe the function only does this for the visible icons and not the created ones (I have to admit I haven't tested this with CustomFilter yet). Or I just messed the whole thing up and don't understand your code properly.

haste · 02-19-12, 05:52 AM

I changed the default :SetPosition() to only anchor icons that it hasn't anchored before. This works great as long as you don't sort the auras, which is why :PreSetPosition() needs to return ranges to :SetPosition().

This does mean that visible{Auras,{B,Deb}uffs is equal to createdIcons when oUF runs :SetPosition() for a certain range, which also is equal to #icons.

If we have two units, one with 1 buff and one with 5 buffs. If I target the one with 1 buff first, oUF will run :SetPosition() for the range 1 to 1. If I then target the unit with 5 buffs, oUF will run :SetPostion() for the range 2 to 5. If I target the unit with 1 buff again, oUF won't run :SetPosition().

The above is true as long as :PreSetPosition() doesn't return a range.

:SetPosition() is currently 0-based, which it really shouldn't be. I honestly don't know why I ended up writing it that way, but it's something I'd like to fix.