interrupt lockout duration display

[zin99]

hi, i want to do a script that displays the lockout duration on target/focus when an interrupt hit them. as i am not too confident in my lua knowledge i deciede to make a post on this forums and hope to find some help.

my main problem is, i don't really know how to implement the arguments of COMBAT_LOG _EVENT_UNFILTERED properly for this purpose.

as of now i use:

t=CreateFrame("Frame")
t:SetPoint("CENTER",0,-100)
t:SetSize(40,40)
t.c=CreateFrame("Cooldown","cd1")
t.c:SetAllPoints(t)
t.t=t:CreateTexture(nil,"BORDER")
t.t:SetAllPoints()
t.t:SetTexture("Interface\\Icons\\ability_kick")


t:RegisterEvent("COMBAT_LOG_EVENT_UNFILTERED")
t:SetScript("OnEvent", function(...) local a,_,_,d = select(4, ...)
if (a == "SPELL_INTERRUPT"and d == UnitName("Player"))
then CooldownFrame_SetTimer(cd1,GetTime(),5,1)end end)

this basically tracks my own interrupts and was created mainly by try and error, copy pasting elements from other scripts. i understand that i will have to create to frames for target and focus and the corresponding destName argument, but couldn't get the code done.
the next step would be to take ANY interrupt spell into account and determining the different lockout duration depending on what interrupt hit the target/focus (ExtraSpellID argument i believe?)
eg: "1766" = 5, -- Kick
"2139"= 8, -- Counterspell

and the final adjustment i'd like to do would be for the icon(s) to only show when they are actually counting down (is cooldown spiral shown = true or sth, really no clue sorry )

any help would be greatly appreciated, thank you for your patience with a lua noob in advance.

[zin99]

ok i got it in a working condition. im am sure the code is anything but pretty, but well it really is the third time im trying to do anything in lua. i basically have a lot of if/elseif stuff for any combination of SpellID und destUnit and its working so far.

now my question is: how can i hide the icon frame displaying the cooldown if it isn't actually counting, and have it pop only if an interrupt hits aka the cooldown spiral is shown on the icon.

[Phanx]

Originally Posted by zin99 ok i got it in a working condition. ... how can i hide the icon frame displaying the cooldown if it isn't actually counting, and have it pop only if an interrupt hits aka the cooldown spiral is shown on the icon.

Without seeing your code, we'd basically be writing all new code for you from the ground up, and I don't know about anyone else, but I have no desire to spend that much time helping you, when I know you already have 90% of the code written.

As has been stated hundreds of times in basically every thread on these forums:

If you want help fixing, changing, cutting down, or adding to your code, post your code.

[zin99]

ok sorry phanx, here it is. i am ready to get laughed at for this code:

 local addon, addonName = ...

 local frame = CreateFrame("Frame")
 local onEvent = function(self, event, ...)
   if event == "COMBAT_LOG_EVENT_UNFILTERED" then
        local timestamp, subevent, hideCaster, sourceGUID, sourceName, sourceFlags, sourceRaidFlags, destGUID, destName, destFlags, destRaidFlags,
        spellID, spellName, spellSchool, extraSpellID, extraSpellName  = ...;
            if (subevent == "SPELL_INTERRUPT") then
            interruptgo(destName, spellID)
     end
   end
 end
 
 frame:SetScript("OnEvent", onEvent)
 frame:RegisterEvent("COMBAT_LOG_EVENT_UNFILTERED")
 
target=CreateFrame("Frame")
target:SetPoint("CENTER", TargetFrame, "CENTER",-130,0)
target:SetSize(40,40)
target.c=CreateFrame("Cooldown","cd1")
target.c:SetAllPoints(target)
target.t=target:CreateTexture(nil,"BORDER")
target.t:SetAllPoints()
target.t:SetTexture("Interface\\Icons\\ability_kick")

focus=CreateFrame("Frame")
focus:SetPoint("CENTER", FocusFrame, "CENTER",-130,0)
focus:SetSize(40,40)
focus.c=CreateFrame("Cooldown","cd2")
focus.c:SetAllPoints(focus)
focus.t=focus:CreateTexture(nil,"BORDER")
focus.t:SetAllPoints()
focus.t:SetTexture("Interface\\Icons\\ability_kick")
 
 function interruptgo(destName, spellID)
 
 if spellID == 1766 and destName == (UnitName("target")) then 
 CooldownFrame_SetTimer(cd1,GetTime(),5,1)
 target.t:SetTexture("Interface\\Icons\\ability_kick")
 elseif spellID == 1766 and destName == (UnitName("focus")) then 
 CooldownFrame_SetTimer(cd2,GetTime(),5,1)
 focus.t:SetTexture("Interface\\Icons\\ability_kick")
 
 elseif spellID == 1766 and destName == (UnitName("target")) then 
 CooldownFrame_SetTimer(cd1,GetTime(),4,1)
 target.t:SetTexture("Interface\\Icons\\spell_holy_rebuke")
 elseif spellID == 1766 and destName == (UnitName("focus")) then 
 CooldownFrame_SetTimer(cd2,GetTime(),4,1)
 focus.t:SetTexture("Interface\\Icons\\spell_holy_rebuke")
 
-- and so on for all interrupt spells...


 end
 end

would it be better to do the SpellID and icons textures as arguments of a table so that i can just get the duration and texture by adressing say "kick" in that table? if so i don't know how

but as is said, my main goal now is to not have the icons shown always but only if they are actually counting. is there a way to determine if there is actually an animation running on the CooldownFrame cd1 or cd2, or do i have to do it with an OnUpdate GetTime thingy.

thanx for helping me!

[Phanx]

First, some general suggestions for your code:

1. Don't create global variables. Not only are they slower to access than local variables, but they can easily be overwritten by other addons, especially when they have generic names like target.

2. Use a table for spell data instead of a long if-else chain. You already mentioned this; see below to see how to implement it.

3. Don't create one-use functions. In your code, the interruptgo function is only called once, from inside the onEvent function. Function closures cost memory, so it's more efficient to just move the contents of the interruptgo function into the onEvent function. If you were going to call the interruptgo function from different places (eg. more than one frame would call it from its event handler), then factoring out that code into its own function would be a good idea, but that's not the case here.

4. Use consistent, proper indentation. This will make your code much easier to read.

Second, to hide the icon when it's not displaying anything, hook the cooldown object's :Hide() method.

Here is your code with the above optimizations and changes applied, plus lots of comments to help you understand what's going on, and print statements to help you see what's going on in-game. You'll want to comment out the print statements once you know it's working.

I've also attached a copy in Lua file form to this post, so you don't have to copy and paste (and deal with the extra blank lines that are inserted when you copy from highlighted code blocks on this forum).

local addon, addonName = ...
 
------------------------------------------------------------------------
--  1. Define a list of spells to track:
------------------------------------------------------------------------
 
local spellData = {
    [2139] = { -- Counterspell
        duration = 7,
        texture = "Interface\\Icons\\spell_frost_iceshock",
    },
    [1766] = { -- Kick
        duration = 5,
        texture = "Interface\\Icons\\ability_kick",
    },
    [47528] = { -- Mind Freeze
        duration = 4,
        texture = "Interface\\Icons\\spell_deathknight_mindfreeze",
    },
    [6522] = { -- Pummel
        duration = 4,
        texture = "Interface\\Icons\\inv_gauntlets_04",
    },
    [96231] = { -- Rebuke
        duration = 4,
        texture = "Interface\\Icons\\spell_holy_rebuke",
    },
    [80964] = { -- Skull Bash (Bear Form)
        duration = 4,
        texture = "Interface\\Icons\\inv_misc_bone_taurenskull_01",
    },
    [80965] = { -- Skull Bash (Cat Form)
        duration = 4,
        texture = "Interface\\Icons\\inv_bone_skull_04",
    },
    [57994] = { -- Wind Shear
        duration = 2,
        texture = "Interface\\Icons\\spell_nature_cyclone",
    },
}
 
------------------------------------------------------------------------
--  2. Create the icons to display:
------------------------------------------------------------------------
 
--  2.1. Create a table to hold the icons:
local unitIcons = {}
 
--  2.2. Create a function that makes an icon:
local newIcon
do
    -- Use scoping to keep variables limited to where they are useful.
    -- The following two functions are only used by the following third
    -- function, and do not need to be accessible anywhere else.
 
    local function icon_OnDragStart(self, mouseButton)
        -- Only allow the icon to be moved if the Alt key is pressed.
        if IsAltKeyDown() then
            self:StartMoving()
        end
    end
 
    local function cooldown_OnHide(self)
        -- Hide the icon when the cooldown ends.
        local icon = self:GetParent()
        icon.texture:SetTexture("")
        icon:Hide()
    end
 
    function newIcon(unit, parentFrame)
        print("newIcon:", unit, parentFrame:GetName())
 
        local icon = CreateFrame("Frame", "$parentInterruptIcon", parentFrame)
        icon:SetPoint("CENTER", parentFrame, -130, 0)
        icon:SetSize(40, 40)
        icon:EnableMouse(true)
        icon:RegisterForDrag("LeftButton")
        icon:SetScript("OnDragStart", icon_OnDragStart)
        icon:SetScript("OnDragStop", icon.StopMovingOrSizing)
        icon:SetScript("OnHide", icon.StopMovingOrSizing)
        -- The OnHide script is needed so the icon doesn't get stuck to
        -- the cursor if it gets hidden while it's being dragged.
 
        local texture = icon:CreateTexture(nil, "ARTWORK")
        texture:SetAllPoints(true)
        icon.texture = texture
 
        local cooldown = CreateFrame("Cooldown", "$parentCooldown", icon)
        cooldown:SetAllPoints(true)
        cooldown:HookScript("OnHide", cooldown_OnHide)
        icon.cooldown = cooldown
 
        icon.unit = unit
        unitIcons[unit] = icon
 
        return icon
    end
end
 
--  2.3. Create the icons you want.
newIcon("target", TargetFrame)
newIcon("focus", FocusFrame)
 
--  You could easily extend this to, for example, add an icon to the
--  arena enemy frames, the boss frames, or even the player frame and
--  party frames to see when your allies were interrupted!
--  The newIcon function returns the icon created, in addition to adding
--  it to the unitIcons table, so you could easily apply custom points
--  or other attributes to a specific icon, eg:
 
--  local playerIcon = newIcon("player", PlayerFrame)
--  playerIcon:ClearAllPoints()
--  playerIcon:SetPoint("LEFT", PlayerFrame, "RIGHT", 40, 0)
 
------------------------------------------------------------------------
--  3. Watch the combat log for interrupts:
------------------------------------------------------------------------
 
--  3.1. Create a frame to listen for combat log events:
local eventFrame = CreateFrame("Frame")
 
--  3.2. Tell the frame which event to listen for:
eventFrame:RegisterEvent("COMBAT_LOG_EVENT_UNFILTERED")
 
--  3.3. Tell the frame what to do when the event happens:
eventFrame:SetScript("OnEvent", function(self, event, timestap, combatEvent, hideCaster, sourceGUID, sourceName, sourceFlags, sourceRaidFlags, destGUID, destName, destFlags, destRaidFlags, spellID, spellName, spellSchool, extraSpellID, extraSpellName, ...)
    --  3.3.1. Check the combat event:
    if combatEvent ~= "SPELL_INTERRUPT" then
        -- We don't care about this combat event.
        return
    end
 
    --  3.3.2. Check the spell:
    local spell = spellData[spellID]
    if not spell then
        -- We don't care about this spell.
        return
    end
 
    print("event:", combatEvent, "spell:", spellName)
 
    --  3.3.3. Look for an icon for this unit:
    for unit, icon in pairs(unitIcons) do
        print("unit:", unit, "destGUID:", destGUID, "unitGUID:", UnitGUID(unit))
        if destGUID == UnitGUID(unit) then
            -- We found the icon for the affected unit.
            print("Found an icon!")
 
            -- Show the icon:
            icon:Show()
            -- Set the icon's texture:
            icon.texture:SetTexture(spell.texture)
            -- Show the icon's cooldown:
            icon.cooldown:Show()
            -- Start the cooldown animation:
            icon.cooldown:SetCooldown(GetTime(), spell.duration)
 
            -- Done!
            return
        end
    end
 
    --  3.3.4. If we get here, that means we couldn't find an icon.
    --  At this point you don't need to do anything, but if you later
    --  wanted to do something when this happens, you'd do it here.
    print("Could not find icon for unit!")
end)

[zin99]

thank you so much phanx, especially for the explanations, really helps me a lot to understand lua better.

you should consider releasing this as an addon i guarantee a lot of people would appreciate it if they don't find or expect to find it in the forums.

edit: maybe as a plugin for losecontrol, the two would be a perfect fit

[Phanx]

I probably won't release an addon like this, since publishing an addon I don't personally use is just too much of a hassle to try to maintain and support. I will never notice when a patch breaks it, for example, or when something doesn't work right, or when something needs to be added.

However, you (or anyone else) are free to turn it into an addon or publish it. I absolutely don't care what anyone does with my code, either code I've posted on the forums, or code from my addons; the main restriction in the license I use for my addons is that you have to pick your own name for the addon (eg. if you copy code from my addon PhanxChat and use it in your own addon, you can't call your addon PhanxChatPlus). The reasons for this are that (a) I don't want anyone coming to me to get help with your addon, and (b) if your addon sucks, I don't want people thinking I had anything to do with it.