Efficient way to change text color based on duration of aura

Layback_ · 05-23-17, 06:26 AM

Hi all,

I am using CooldownFrameTemplate for my aura tracker addon to show the remaining duration and trying to alter text color when the duration goes below certain amount for better visibility.

I've considered using OnUpdate as shown below, but when I checked a CPU usage, it was inefficient.

Lua Code:

local cd = button.cd;
if duration and duration > 0 then
    cd:SetCooldown(expires - duration, duration);
 
    cd:SetScript("OnUpdate", function(self, elapsed)
        local startTime, duration = self:GetCooldownTimes();
 
        if ((startTime + duration) / 1000) - GetTime() < 3 then
            cd:GetRegions():SetTextColor(1, 0, 0);
 
            cd:SetScript("OnUpdate", nil);
        end
    end);
    
    cd:Show();
else
    cd:SetScript("OnUpdate", nil);
    cd:GetRegions():SetTextColor(1, 1, 1);
 
    cd:Hide();
end

I should have considered of putting outer 'if' statement, one that you limit updates based on time elapsed, but pretty sure there will be slight inaccuracy of time where it alters text color. However, imagining over 10 different frames doing the same thing also makes my head dizzy

Kanegasi · 05-23-17, 07:23 AM

Counting elapsed is standard to throttle OnUpdates. Put the following line right below the "OnUpdate",function line:

Code:

self.e=self.e and self.e+elapsed or 0 if self.e<0.5 then return else self.e=0 end

This throttles the OnUpdate to every half a second. Change the 0.5 to whatever you want your throttle, in seconds.

Aftermathhqt · 05-23-17, 07:41 AM

Heres my code for CooldownFrameTemplate and i guess this the best way to to do it.

Lua Code:

local function UpdateCooldownFrame(self)
    local Now, Start, Duration = GetTime(), self:GetCooldownTimes()
    local Elapsed = Now - Start/1000
    local TimeLeft = Duration/1000 - Elapsed
 
    local NumRegions = self:GetNumRegions()
    for i = 1, NumRegions do
        local Region = select(i, self:GetRegions())
        if (Region.GetText) then
            if (TimeLeft <= 10) then
                Region:SetTextColor(unpack(C.Cooldowns.ExpireColor))
            elseif (TimeLeft <= 30) then
                Region:SetTextColor(unpack(C.Cooldowns.SecondsColor))
            elseif (TimeLeft <= 60) then
                Region:SetTextColor(unpack(C.Cooldowns.SecondsColor2))
            else
                Region:SetTextColor(unpack(C.Cooldowns.NormalColor))
            end
        end
    end
end
 
hooksecurefunc("CooldownFrame_Set", function(self, start, duration, enable, forceShowDrawEdge, modRate)
    local CooldownCount = GetCVar("countdownForCooldowns")
        
    if (CooldownCount and not self.IsCooldownEdited) then
        local NumRegions = self:GetNumRegions()
        self:SetFrameStrata("HIGH")
    
        for i = 1, NumRegions do
            local Region = select(i, self:GetRegions())
            if (Region.GetText) then
                Region:Point("CENTER", 1, 1)
                Region:SetFontTemplate(C.Media.Font2, C.Cooldowns.FontSize)
                
                self:HookScript("OnUpdate", UpdateCooldownFrame)
            end
        end
 
        self.IsCooldownEdited = true
    end
end)

Aftermathhqt · 05-23-17, 07:46 AM

And heres an "minimal" version of tullaCC aka OmniCC if it's something you wanna use, because i used the CooldownFrameTemplate but it doesn't work exactly everything unfortune

Lua Code:

A.FormatTime = function(Seconds)
    local Day, Hour, Minutes = 0, 0, 0
    
    if (Seconds >= 86400) then
        Day = Seconds / 86400
        Seconds = Seconds % 86400
    end
 
    if (Seconds >= 3600) then
        Hour = Seconds / 3600
        Seconds = Seconds % 3600
    end
    
    if (Seconds >= 60) then
        Minutes = Seconds / 60
        Seconds = Seconds % 60
    end
    
    if (Day > 0) then
        return format("%.2d:%.2d", Day, Hour)
    elseif (Hour > 0) then
        return format("%.2d:%.2d", Hour, Minutes)
    elseif (Minutes > 0) then
        return format("%.1d:%.2d", Minutes, Seconds)
    else
        if (Seconds < 10) then
            return format("%.1f", Seconds) 
        else
            return format("%d", Seconds)
        end
    end
end
 
local ICON_SIZE = 36
local MIN_SCALE = 0.5
local MIN_DURATION = 1.5
 
local floor = math.floor
local GetTime = GetTime
 
local function TimerStop(self)
    self.Enabled = nil
    self:Hide()
end
 
local function TimerForceUpdate(self)
    self.NextUpdate = 0
    self:Show()
end
 
local function TimerOnSizeChanged(self, Width)
    local FontScale = floor(Width +.5) / ICON_SIZE
    if FontScale == self.FontScale then
        return
    end
    
    self.FontScale = FontScale
 
    if FontScale < MIN_SCALE then
        self:Hide()
    else
        self.Text:SetFontTemplate(C.Media.Font2, FontScale * C.Cooldowns.FontSize)
 
        if self.Enabled then
            TimerForceUpdate(self)
        end
    end
end
 
local function TimerOnUpdate(self, Elapsed)
    if (self.NextUpdate > 0) then
        self.NextUpdate = self.NextUpdate - Elapsed
        return
    end
    
    local TimeLeft = self.Duration - (GetTime() - self.Start)
 
    if (TimeLeft > 0.05) then
        if (self.FontScale * self:GetEffectiveScale() / UIParent:GetScale()) < MIN_SCALE then
            self.Text:SetText("")
            self.NextUpdate = 500
        else
            local TimeText = A.FormatTime(TimeLeft)
            self.Text:SetText(TimeText)
        end
    
        if (TimeLeft <= 10) then
            self.Text:SetTextColor(unpack(C.Cooldowns.ExpireColor))
        elseif (TimeLeft <= 30) then
            self.Text:SetTextColor(unpack(C.Cooldowns.SecondsColor))
        elseif (TimeLeft <= 60) then
            self.Text:SetTextColor(unpack(C.Cooldowns.SecondsColor2))
        else
            self.Text:SetTextColor(unpack(C.Cooldowns.NormalColor))
        end
    else
        TimerStop(self)
    end
end
 
local function TimerCreate(self)
    local Scaler = CreateFrame("Frame", nil, self)
    Scaler:SetAllPoints(self)
 
    local Timer = CreateFrame("Frame", nil, Scaler) 
    Timer:Hide()
    Timer:SetAllPoints(Scaler)
    Timer:SetFrameStrata("HIGH")
    Timer:SetScript("OnUpdate", TimerOnUpdate)
 
    local Text = Timer:CreateFontString(nil, "OVERLAY")
    Text:Point("CENTER", Timer, 1, 0)
    Timer.Text = Text
 
    TimerOnSizeChanged(Timer, Scaler:GetSize())
    Scaler:SetScript("OnSizeChanged", function(self, ...) 
        TimerOnSizeChanged(Timer, ...) 
    end)
 
    self.Timer = Timer
    return Timer
end
 
local function TimerStart(self, Start, Duration)
    if (self.noOCC) then 
        return 
    end
    
    if (Start > 0 and Duration > MIN_DURATION) then
        local Timer = self.Timer or TimerCreate(self)
        Timer.Start = Start
        Timer.Duration = Duration
        Timer.Enabled = true
        Timer.NextUpdate = 0
        
        if Timer.FontScale >= MIN_SCALE then 
            Timer:Show() 
        end
    else
        local Timer = self.Timer
        if (Timer) then
            TimerStop(Timer)
        end
    end
end
hooksecurefunc(getmetatable(ActionButton1Cooldown).__index, "SetCooldown", TimerStart)
 
local Active = {}
 
local function CooldownOnShow(self)
    Active[self] = true
end
 
local function CooldownOnHide(self)
    Active[self] = nil
end
 
local function CooldownShouldUpdateTimer(self, Start, Duration)
    local Timer = self.Timer
    if not (Timer) then return true end
    return Timer.Start ~= Start
end
 
local function CooldownUpdate(self)
    local Button = self:GetParent()
    local Start, Duration, Enable = GetActionCooldown(Button.action)
 
    if CooldownShouldUpdateTimer(self, Start, Duration) then
        TimerStart(self, Start, Duration)
    end
end
 
local EventWatcher = CreateFrame("Frame")
EventWatcher:RegisterEvent("ACTIONBAR_UPDATE_COOLDOWN")
EventWatcher:SetScript("OnEvent", function(self, event)
    for Cooldown in pairs(Active) do
        CooldownUpdate(Cooldown)
    end
end)
 
local function ActionButtonRegister(frame)
    local Cooldown = frame.cooldown
 
    if not (Cooldown.IsHooked) then
        Cooldown:HookScript("OnShow", CooldownOnShow)
        Cooldown:HookScript("OnHide", CooldownOnHide)
        Cooldown.IsHooked = true
    end
end
 
if _G["ActionBarButtonEventsFrame"].frames then
    for i, frame in pairs(_G["ActionBarButtonEventsFrame"].frames) do
        ActionButtonRegister(frame)
    end
end
hooksecurefunc("ActionBarButtonEventsFrame_RegisterFrame", ActionButtonRegister)

jeruku · 05-23-17, 08:13 AM

In the snippet provided there are a few things you could improve upon, you will find them below. I have included many notes of which I have found to work while working on JamPlates Auras in the early stages of development(On a computer so old that CPU and RAM were precious resources.).

Lua Code:

local cd = button.cd;
if duration and duration > 0 then
    cd:SetCooldown(expires - duration, duration);
 
    --  Upvalue to the nearest required scope that is outside the OnUpdate to improve performance
    local GetTime = GetTime
    local startTime, duration = self:GetCooldownTimes(); -- these aren't changing anytime soon so put them in the outer scope
 
    -- Or to improve performance further add it into the frames table; though the performance gain is insignificant and trades CPU for RAM, which when dealing with multiplicative
    --   auras may begin churning memory affecting CPU anyway
    --cd.GetTime = GetTime
    --cd.startTime = startTime
    --cd.duration = duration
    
    --cd.timer = cd:GetRegions() -- see notes below
 
    -- cd.elapsed = 0
    cd:SetScript("OnUpdate", function(self, elapsed)
        --self.elapsed = self.elapsed + elapsed -- in testing I have found throttling to be almost negligible when things are scoped properly;
        --  letting the function end allows better CPU and RAM stability, returns don't do that
        --if self.elapsed > 0.5 then 
            if ((startTime + duration) / 1000) - GetTime() < 3 then
 
                --  It's all about scope
                --  In this case you were calling the local outer var 'cd' when you can use the inner 'self'
                self:GetRegions():SetTextColor(1, 0, 0); -- if you can get this region before the OnUpdate put it outside and use a table reference like self.timer
 
                self:SetScript("OnUpdate", nil);
            end
        --end
    end);
    
    cd:Show();
else
    cd:SetScript("OnUpdate", nil);
    cd:GetRegions():SetTextColor(1, 1, 1);
 
    cd:Hide();
end

Layback_ · 05-23-17, 11:12 PM

Originally Posted by Kanegasi

Counting elapsed is standard to throttle OnUpdates. Put the following line right below the "OnUpdate",function line:

Code:

self.e=self.e and self.e+elapsed or 0 if self.e<0.5 then return else self.e=0 end

This throttles the OnUpdate to every half a second. Change the 0.5 to whatever you want your throttle, in seconds.

Hi Kanegasi,

I've also considered counting elapsed, but the problem is that there's slight inaccuracy on altering text color because of that 0.x second which kinda annoys me

Layback_ · 05-23-17, 11:13 PM

Originally Posted by Game92

Heres my code for CooldownFrameTemplate and i guess this the best way to to do it.

Originally Posted by Game92

And heres an "minimal" version of tullaCC aka OmniCC if it's something you wanna use, because i used the CooldownFrameTemplate but it doesn't work exactly everything unfortune

Hi Game92,

Whoa! That's pretty long haha!!

I'll definitely have a look at it

Thank you

Layback_ · 05-23-17, 11:23 PM

Originally Posted by jeruku

In the snippet provided there are a few things you could improve upon, you will find them below. I have included many notes of which I have found to work while working on JamPlates Auras in the early stages of development(On a computer so old that CPU and RAM were precious resources.).

Hi jeruku,

Made all modifications based on your advice!

Thank you for detailed explanation