New AuraUtil Functions

[thomasjohnshannon]

The following functions got added today (7/2) in a new file called AuraUtil.lua in the FrameXML folder. I haven't had time to test them out but I figured I would post this so other people can check them out.

AuraUtil = {};
 
local function FindAuraRecurse(predicate, unit, filter, auraIndex, predicateArg1, predicateArg2, predicateArg3, ...)
    if ... == nil then
        return nil; -- Not found
    end
    if predicate(predicateArg1, predicateArg2, predicateArg3, ...) then
        return ...;
    end
    auraIndex = auraIndex + 1;
    return FindAuraRecurse(predicate, unit, filter, auraIndex, predicateArg1, predicateArg2, predicateArg3, UnitAura(unit, auraIndex, filter));
end
 
-- Find an aura by any predicate, you can pass in up to 3 predicate specific parameters
-- The predicate will also receive all aura params, if the aura data matches return true
function AuraUtil.FindAura(predicate, unit, filter, predicateArg1, predicateArg2, predicateArg3)
    local auraIndex = 1;
    return FindAuraRecurse(predicate, unit, filter, auraIndex, predicateArg1, predicateArg2, predicateArg3, UnitAura(unit, auraIndex, filter));
end
 
do
    local function NamePredicate(auraNameToFind, _, _, auraName)
        return auraNameToFind == auraName;
    end
 
    -- Finds the first aura that matches the name
    -- Notes:
    --      aura names are not unique!
    --      aura names are localized, what works in one locale might not work in another
    --          consider that in English two auras might have different names, but once localized they have the same name, so even using the localized aura name in a search it could result in different behavior
    --      the unit could have multiple auras with the same name, this will only find the first
    function AuraUtil.FindAuraByName(auraName, unit, filter)
        return AuraUtil.FindAura(NamePredicate, unit, filter, auraName);
    end
end