Struggling with changing variable value

Wimpface · 08-24-14, 03:47 AM

I'm trying to make my oUF layout load different castbar settings depending on class and spec, and was planning on using a boolean for this but the variable I'm checking never seems to update it's value.

I get no errors, but I've added a debug print to see what isCaster returns and it always returns nil. I've tried this from multiple places in the code (inside the cbCheck function, inside the cbCheckFrame SetScript and inside the Shared function where I create the castbars) and the return is always nil.

This is where I try to change the value.
https://gist.github.com/ShredL/f00b576ae70456a971a8

Lua Code:

-- Doesn't seem to change the value of my isCaster variable
local spec = GetSpecialization()
local _, playerClass = UnitClass("PLAYER")
local isCaster
local function cbCheck()
    if playerClass == 'DRUID' or 'MONK' or 'PALADIN' or 'SHAMAN' then
        if playerClass == 'DRUID' then
            if spec == 1 or 4 then
                isCaster = true
            else
                isCaster = false
            end
        elseif playerClass == 'MONK' then
            if spec == 2 then
                isCaster = true
            else
                isCaster = false
            end
        elseif playerClass == 'PALADIN' then
            if spec == 1 then
                isCaster = true
            else
                isCaster = false
            end
        elseif playerClass == 'SHAMAN' then
            if spec == 2 then
                isCaster = false
            else
                isCaster = true
            end
        end
    elseif playerClass == 'DEATHKNIGHT' or 'HUNTER' or 'ROGUE' or 'WARRIOR' then
        isCaster = false
    else
        isCaster = true
    end
end
local cbCheckFrame = CreateFrame("Frame")
cbCheckFrame:RegisterEvent('PLAYER_SPECIALIZATION_CHANGED')
cbCheckFrame:RegisterEvent('PLAYER_ENTERING_WORLD')
cbCheckFrame:RegisterEvent('PLAYER_LOGIN')
cbCheckFrame:SetScript("OnEvent", function()
    cbCheck()
end)

This is what is in my Shared function
https://gist.github.com/ShredL/8ee3b4978b3de4498c4c

Lua Code:

-- Castbar
    if(unit=='player' or unit=='target') then
        local Castbar = CreateFrame('StatusBar', nil, self)
        local Spark = Castbar:CreateTexture(nil, 'OVERLAY')
 
        if(unit=='player') then
            if isCaster == false then
                Castbar:SetAllPoints(Health)
                Castbar:SetStatusBarTexture(statusBar)
                Castbar:SetStatusBarColor(0, 0, 0, 0)
                Castbar:SetFrameStrata('HIGH')
 
                Spark:SetSize(2, 7)
                Spark:SetTexture(1, 1, 1)
            elseif isCaster == true then
                Castbar:SetAllPoints(Health)
                Castbar:SetStatusBarTexture(statusBar)
                Castbar:SetStatusBarColor(0, 0, 0, 0)
                Castbar:SetFrameStrata('HIGH')
 
                Spark:SetSize(2, 7)
                Spark:SetTexture(1, 1, 1)
            end
        else
            Castbar:SetAllPoints(Health)
            Castbar:SetStatusBarTexture(statusBar)
            Castbar:SetStatusBarColor(0, 0, 0, 0)
            Castbar:SetFrameStrata('HIGH')
 
            Spark:SetSize(2, 20)
            Spark:SetTexture(1, 1, 1)
        end
 
        self.Castbar = Castbar
        Castbar.Spark = Spark
 
    end

And here is the entire code if needed
https://gist.github.com/ShredL/59b138b727ca3a818299

It is probably something super simple that I'm overlooking, but I cannot seem to figure out how to change the value of isCaster. Any help is appreciated as always.

Malakahh · 08-24-14, 07:24 AM

Some of your if statements are a bit odd to say the least, as they will always be true. The ones I'm talking about are lines 6, 8, and 32 of the first block of code you posted. Try changing it to

Lua Code:

-- Doesn't seem to change the value of my isCaster variable
local spec = GetSpecialization()
local _, playerClass = UnitClass("PLAYER")
local isCaster
local function cbCheck()
    if playerClass == 'DRUID' or playerClass == 'MONK' or playerClass == 'PALADIN' or playerClass == 'SHAMAN' then
        if playerClass == 'DRUID' then
            if spec == 1 or spec == 4 then
                isCaster = true
            else
                isCaster = false
            end
        elseif playerClass == 'MONK' then
            if spec == 2 then
                isCaster = true
            else
                isCaster = false
            end
        elseif playerClass == 'PALADIN' then
            if spec == 1 then
                isCaster = true
            else
                isCaster = false
            end
        elseif playerClass == 'SHAMAN' then
            if spec == 2 then
                isCaster = false
            else
                isCaster = true
            end
        end
    elseif playerClass == 'DEATHKNIGHT' or playerClass == 'HUNTER' or playerClass == 'ROGUE' or playerClass == 'WARRIOR' then
        isCaster = false
    else
        isCaster = true
    end
end
local cbCheckFrame = CreateFrame("Frame")
cbCheckFrame:RegisterEvent('PLAYER_SPECIALIZATION_CHANGED')
cbCheckFrame:RegisterEvent('PLAYER_ENTERING_WORLD')
cbCheckFrame:RegisterEvent('PLAYER_LOGIN')
cbCheckFrame:SetScript("OnEvent", function()
    cbCheck()
end)

Wimpface · 08-24-14, 02:11 PM

Ofcourse, silly me. Fixing the if statements fixed it... sorta. The castbar now gets disabled when reloading UI (EDIT: or rather, it always did and I just didn't know). I'm assuming this has to do with the event calls. Is there another event I should be checking?

Lua Code:

local function cbCheck()
    if playerClass == 'DRUID' or playerClass == 'MONK' or playerClass == 'PALADIN' or playerClass == 'SHAMAN' then
        if playerClass == 'DRUID' then
            if spec == 1 or spec == 4 then
                isCaster = true
            else
                isCaster = false
            end
        elseif playerClass == 'MONK' then
            if spec == 2 then
                isCaster = true
            else
                isCaster = false
            end
        elseif playerClass == 'PALADIN' then
            if spec == 1 then
                isCaster = true
            else
                isCaster = false
            end
        elseif playerClass == 'SHAMAN' then
            if spec == 2 then
                isCaster = false
            else
                isCaster = true
            end
        end
    elseif playerClass == 'DEATHKNIGHT' or playerClass == 'HUNTER' or playerClass == 'ROGUE' or playerClass == 'WARRIOR' then
        isCaster = false
    elseif playerClass == 'MAGE' or playerClass == 'PRIEST' or playerClass == 'WARLOCK' then
        isCaster = true
    end
end

I've been trying it out on Monk, Mage, Warlock, and Shaman (caster) so far. Reloading kills it every time.

EDIT: Perhaps it should be noted it's only the player castbar that disappears when reloading. Using a Mage teleport spell did not make it disappear, taking a portal did.

Phanx · 08-24-14, 11:29 PM

Your current method:

Code:

local spec = GetSpecialization()
local _, playerClass = UnitClass("PLAYER")
local isCaster
local function cbCheck()
    -- stuff here
end

local cbCheckFrame = CreateFrame("Frame")
cbCheckFrame:RegisterEvent('PLAYER_SPECIALIZATION_CHANGED')
cbCheckFrame:RegisterEvent('PLAYER_ENTERING_WORLD')
cbCheckFrame:RegisterEvent('PLAYER_LOGIN')
cbCheckFrame:SetScript("OnEvent", function()
    cbCheck()
end)

... may as well not listen for events at all, since you only check the player's spec once in the main chunk. Your cbCheck function will run the same logic every time it's run, even if the player's spec changes during play or isn't available yet in the main chunk (eg. on a fresh login GetSpecialization() is probably always nil).

You need to check the spec [b]inside[/i] the function. Also, defining a function outside of the OnEvent handler offers no benefit, and has the non-insignifcant downside of adding an extra function call, which is pretty much the slowest thing you can do in Lua. Just move all that code directly into the OnEvent handler or, if you really want to have a variable pointing to your function, set the cbCheck function as the OnEvent handler directly.

Code:

local isCaster
local _, playerClass = UnitClass("player")

local cbCheckFrame = CreateFrame("Frame")
cbCheckFrame:RegisterEvent('PLAYER_SPECIALIZATION_CHANGED')
cbCheckFrame:RegisterEvent('PLAYER_ENTERING_WORLD')
cbCheckFrame:RegisterEvent('PLAYER_LOGIN')
cbCheckFrame:SetScript("OnEvent", function()
    local spec = GetSpecialization()
    -- stuff here
end)

(On a side note, the proper capitalization for unit tokens is lowercase, so it should be "player", not "PLAYER". The API will auto-correct values you pass into it, but you should be in the habit of using the correct capitalization, not only because it's, well, correct, but also because if you're ever performing comparisons on values returned by the API, you'll have to write your comparison correctly, or waste time calling string.upper on the returned value.)

Wimpface · 08-25-14, 01:55 AM

Thanks Phanx, you're the best as always.

I moved the code and the spec variable into the OnEvent handler. I had no idea function calls were slow, I should probably re-do some of my other addons...

Forgive my ignorance, but is the reason I don't need to check for events at all because I need to reload anyway for my castbar to change, even if the variable value changes when PLAYER_SPECIALIZATION_CHANGED fires? I'm fairly sure it won't be dynamic in it's current incarnation. If I'm correct, that means I can just make a function and call it whenever the code loads because I'll need a reload anyway. Would this be more efficient or not, given what I've learned about function calls being slow?
EDIT: Ofcourse it won't be dynamic. Zz

Also, would I not run into troubles with GetSpecialization() not being available until PLAYER_ENTERING_WORLD? How would I go about finding this out?
I read in an old thread from 2011 in which you replied to that GetPrimaryTalentTree() isn't available until after PLAYER_ALIVE fires. Perhaps I should just check for that event? Assuming GetSpecialization() follows the same rules it's predecessor did.

This is the state my code is in right now, I'm going to try out some of the stuff in this post and see where it gets me. The castbar still disappears on reload with this code.

Lua Code:

local isCaster
local cbCheckFrame = CreateFrame("Frame")
cbCheckFrame:RegisterEvent('PLAYER_SPECIALIZATION_CHANGED')
cbCheckFrame:RegisterEvent('PLAYER_ENTERING_WORLD')
cbCheckFrame:RegisterEvent('PLAYER_LOGIN')
cbCheckFrame:SetScript("OnEvent", function()
    local spec = GetSpecialization()
 
    if playerClass == 'DRUID' or playerClass == 'MONK' or playerClass == 'PALADIN' or playerClass == 'SHAMAN' then
        if playerClass == 'DRUID' then
            if spec == 1 or spec == 4 then
                isCaster = true
            else
                isCaster = false
            end
        elseif playerClass == 'MONK' then
            if spec == 2 then
                isCaster = true
            else
                isCaster = false
            end
        elseif playerClass == 'PALADIN' then
            if spec == 1 then
                isCaster = true
            else
                isCaster = false
            end
        elseif playerClass == 'SHAMAN' then
            if spec == 2 then
                isCaster = false
            else
                isCaster = true
            end
        end
    elseif playerClass == 'DEATHKNIGHT' or playerClass == 'HUNTER' or playerClass == 'ROGUE' or playerClass == 'WARRIOR' then
        isCaster = false
    elseif playerClass == 'MAGE' or playerClass == 'PRIEST' or playerClass == 'WARLOCK' then
        isCaster = true
    end
 
    print(isCaster)
end)

Finally, I've been doing "PLAYER" for years and saw you mention something similar in a thread yesterday. Can't believe it's something I've never thought about twice, even though I've looked up UnitClass, UnitName, UnitRace and so forth about a million times. Bad habits die hard I suppose.

EDIT#2: I took events out of it altogether, and just did a function that I call once when the code fires. It now works correctly, but maybe it isn't the best way of doing it? Is this different than running a SetScript on a frame? If not, I have no idea what handler to use as OnEvent seems wasteful. Maybe OnLoad?

Lua Code:

local isCaster
local cbCheck = function()
    local spec = GetSpecialization()
 
    if playerClass == 'DRUID' or playerClass == 'MONK' or playerClass == 'PALADIN' or playerClass == 'SHAMAN' then
        if playerClass == 'DRUID' then
            if spec == 1 or spec == 4 then
                isCaster = true
            else
                isCaster = false
            end
        elseif playerClass == 'MONK' then
            if spec == 2 then
                isCaster = true
            else
                isCaster = false
            end
        elseif playerClass == 'PALADIN' then
            if spec == 1 then
                isCaster = true
            else
                isCaster = false
            end
        elseif playerClass == 'SHAMAN' then
            if spec == 2 then
                isCaster = false
            else
                isCaster = true
            end
        end
    elseif playerClass == 'DEATHKNIGHT' or playerClass == 'HUNTER' or playerClass == 'ROGUE' or playerClass == 'WARRIOR' then
        isCaster = false
    elseif playerClass == 'MAGE' or playerClass == 'PRIEST' or playerClass == 'WARLOCK' then
        isCaster = true
    end
 
    print(isCaster)
end
 
cbCheck()

p3lim · 08-25-14, 02:46 AM

You could also simplify the isCaster check a bit

Lua Code:

local cbCheck = function()
    local _, playerClass = UnitClass('player')
    local spec = GetSpecialization()
 
    local isCaster = false
    if(playerClass == 'DRUID' and (spec == 1 or spec == 4)) then
        isCaster = true
    elseif(playerClass == 'MONK' and spec == 2) then
        isCaster = true
    elseif(playerClass == 'PALADIN' and spec == 1) then
        isCaster = true
    elseif(playerClass == 'SHAMAN' and spec == 2) then
        isCaster = true
    elseif(playerClass == 'MAGE' or playerClass == 'PRIEST' or playerClass == 'WARLOCK') then
        isCaster = true
    end
end

Also, you need the events to delay the check, on init the spec is not available yet, and will return nil.

Phanx · 08-25-14, 02:50 AM

Originally Posted by Wimpface

I had no idea function calls were slow, I should probably re-do some of my other addons...

Well, function calls are still effectively instant in terms of human perception, it's just that they're significantly slower than everything else you can do in Lua, such as looking up values in tables. This is why I always suggest doing things like "r, g, b = t[1], t[2], t[3]" instead of "r, g, b = unpack(t)" or "for i = 1, #t do local v = t[i]" instead of "for i, v in ipairs(t)" -- wherever you can achieve the same result without calling a function, you're probably better off doing so.

Originally Posted by Wimpface

... is the reason I don't need to check for events at all because I need to reload anyway for my castbar to change, even if the variable value changes when PLAYER_SPECIALIZATION_CHANGED fires?

Information about spells, talents, etc. is available immediately when you reload the UI because you're only reloading the UI; you're not actually disconnecting and reconnecting from the server. Your character and all information about it remain loaded in the client.

Functions like UnitGUID don't return useful values right away on a fresh login, and most likely GetSpecialization doesn't either. You can easily test this by logging out to the character screen and logging back in, with the following code in the main chunk:

Code:

print("Current spec is:", GetSpecialization())

On an actual login I suspect it will report "nil", though it will report the correct value on a UI reload.

Originally Posted by Wimpface

This is the state my code is in right now, ... The castbar still disappears on reload with this code.

There's nothing in the code you posted that does anything with any castbar, so I can't really help you with that.

Originally Posted by Wimpface

I took events out of it altogether, and just did a function that I call once when the code fires. It now works correctly, but maybe it isn't the best way of doing it? Is this different than running a SetScript on a frame? If not, I have no idea what handler to use as OnEvent seems wasteful. Maybe OnLoad?

It won't work on a fresh login; see above.

OnLoad doesn't fire for frames created in Lua, and doesn't need to, as it's the same as just writing the code directly after the CreateFrame call.

If you're not using oUF:Factory already, I'd recommend you switch to it, as it will delay creating your frames until PLAYER_LOGIN, at which time information about things like your spec should be available, even on a fresh login.