oUF - ClassIcons

[jeAz_]

Let me apologize that I'm writing multiple threads within a short term

So, here's my new questions.

I was trying to create "ClassIcon Bar" with "ClassIcon" element.

However, there was few problems with this.

Have a look at the code first:

A.CreateClassIcons = function(f, unit)
    local _, Class = UnitClass(unit);
    local MaxPower;
    local ClassIcons = {};
    local ClassIconName = {
        Monk = "ChiOrb",
        Paladin = "HolyPower",
        Priest = "ShadowOrb",
        Warlock = "SoulShard",
    };
    local ClassIconColor = {
        Monk = {
            r = 0.52,
            g = 0.90,
            b = 0.50,
        },
 
        Paladin = {
            r = 1.00,
            g = 0.70,
            b = 0.85,
        },
 
        Priest = {
            r = 1.00,
            g = 1.00,
            b = 1.00,
        },
        Warlock = {
            r = 0.65,
            g = 0.40,
            b = 1.00,
        },
    };
 
    if (Class == "MONK") then
        MaxPower = UnitPowerMax(unit, SPELL_POWER_CHI);
    end
 
    local lowerClass = A.FirstToUpper(Class);
 
    for i = 1, 6 do
        local ClassIcon = CreateFrame("Frame", ("YUI_" .. ClassIconName[lowerClass] .. i), f);
    
        ClassIcon:SetBackdrop({
            bgFile = BACKDROP,
            tile = true,
            tileSize = 16,
        });
        ClassIcon:SetBackdropColor(0.1, 0.1, 0.1, 1);
        ClassIcon:SetWidth((G[unit]["width"] - (MaxPower - 1)) / MaxPower);
        ClassIcon:SetHeight(16);
 
        if i == 1 then
            ClassIcon:SetPoint("TOPLEFT", f, "BOTTOMLEFT", 0, -2);
        else
            ClassIcon:SetPoint("LEFT", ClassIcons[i - 1], "RIGHT", 1, 0);
        end
 
        local texture = ClassIcon:CreateTexture(nil, "OVERLAY");
        texture:SetTexture(COMBO_POINT);
        texture:SetVertexColor(ClassIconColor[lowerClass]["r"], ClassIconColor[lowerClass]["g"], ClassIconColor[lowerClass]["b"], 1);
        texture:SetWidth(ClassIcon:GetWidth() - 4);
        texture:SetHeight(ClassIcon:GetHeight() - 4);
        texture:SetPoint("CENTER");
 
        ClassIcon.texture = texture;
        ClassIcons[i] = ClassIcon;
    end
 
    f.ClassIcons = ClassIcons;
end

The first issue with this code is that when I enter the game, "UnitPowerMax(unit, SPELL_POWER_CHI)" returns 0 and only returns the proper value when I reload the game.

The next issue is that since I'm using my own textures for Chi, I have to update the size and position of icon if I select "Ascension (Monk Talent: 3/2)" which increases max number of chi by 1. However, it seems not working as I expected ...

Lastly, instead of utilizing default "ClassIcons" element, I was trying to create my own element module for each classes, Monk, Warlock, Priest and Paladin. So, I've attempted to interpret the original "ClassIcons" module, but as a newbie, it was pretty complex to understand what each function performs.

Could anyone please help me with interpreting this module

[zork]

I did my own classbars for oUF_Diablo. They can be found under modules.
https://github.com/zorker/rothui/tre...Diablo/modules

Example for Harmony:
https://github.com/zorker/rothui/blo...UF_Harmony.lua

On top of that make sure to check out the wow api changes for legion regarding that topic:
http://www.wowinterface.com/forums/s...ad.php?t=53140

Taking a look at rClassBars may help out aswell.
http://www.wowinterface.com/download...ClassBars.html

[jeAz_]

Originally Posted by zork I did my own classbars for oUF_Diablo. They can be found under modules. https://github.com/zorker/rothui/tre...Diablo/modules Example for Harmony: https://github.com/zorker/rothui/blo...UF_Harmony.lua On top of that make sure to check out the wow api changes for legion regarding that topic: http://www.wowinterface.com/forums/s...ad.php?t=53140 Taking a look at rClassBars may help out aswell. http://www.wowinterface.com/download...ClassBars.html

Hi zork,

Thank you for those nice references, and let me ask step by step.


About Default "classicon.lua":

1. On default oUF's default "classicon.lua" there is "PreUpdate" and "PostUpdate" functions. I understand when they are triggered, but ain't sure of what they actually process. Could you please explain me, if you know about them?


About your "oUF_Harmony.lua":

2. On your "oUF_Harmony.lua", it contains the following codes:

local w = 64*(max+2)
bar:SetWidth(w)
for i = 1, bar.maxOrbs do
  local orb = self.Harmony[i]
  if i > max then
     if orb:IsShown() then orb:Hide() end
  else
    if not orb:IsShown() then orb:Show() end
  end
end
for i = 1, max do
  local orb = self.Harmony[i]
  local full = num/max
  if(i <= num) then
    if full == 1 then
      orb.fill:SetVertexColor(1,0,0)
      orb.glow:SetVertexColor(1,0,0)
    else
      orb.fill:SetVertexColor(bar.color.r,bar.color.g,bar.color.b)
      orb.glow:SetVertexColor(bar.color.r,bar.color.g,bar.color.b)
    end
    orb.fill:Show()
    orb.glow:Show()
    orb.highlight:Show()
  else
    orb.fill:Hide()
    orb.glow:Hide()
    orb.highlight:Hide()
  end
end

If I'm going set the appearance of "Chi Orbs" outside of this module, do I still have to have

local w = 64*(max+2)
bar:SetWidth(w)

and

second "for" loop?

3. Where does "bar.maxOrbs" come from?

4. How does "ForceUpdate" and "Path" functions work?

5. On "ForceUpdate" function and "Enable" function, there is "element.__owner". Does "__" mean something special in Lua when you are indexing an element from table?




Please excuse me if I'm asking too many questions.

[zork]

1. Pre and Postupdate are hook functions. They let you manipulate values in case you need to do that to make the function process data correctly. Example you can change the color PostUpdate.
2. My chi bar has textures that are left and right of the orbs. Orbs number is dynamic depending on talents and what not. Thus I need to make sure that if the number of orbs changes the final bar still looks good. See 3.
3. My max orb value is hardcoded upon bar creation. That number could have been 10 or 100, but you know. The less frames you create the better.
https://github.com/zorker/rothui/blo.../bars.lua#L204
4. When the visibility changes a force update is needed to trigger the power update. You are right that I may have not needed the Path function but it gives you the ability to define a an Override function for a specific element. Like...you spawn 2 chi orb bars for example and want one to behave differently on update. That is where override is needed.
5. Nothing special. Just a prefix haste was using for the root element. (each bar is anchored to a root frame aka owner)

[jeAz_]

Originally Posted by zork 1. Pre and Postupdate are hook functions. They let you manipulate values in case you need to do that to make the function process data correctly. Example you can change the color PostUpdate. 2. My chi bar has textures that are left and right of the orbs. Orbs number is dynamic depending on talents and what not. Thus I need to make sure that if the number of orbs changes the final bar still looks good. See 3. 3. My max orb value is hardcoded upon bar creation. That number could have been 10 or 100, but you know. The less frames you create the better. https://github.com/zorker/rothui/blo.../bars.lua#L204 4. When the visibility changes a force update is needed to trigger the power update. You are right that I may have not needed the Path function but it gives you the ability to define a an Override function for a specific element. Like...you spawn 2 chi orb bars for example and want one to behave differently on update. That is where override is needed. 5. Nothing special. Just a prefix haste was using for the root element. (each bar is anchored to a root frame aka owner)

2. So, the purpose of following lines of code in "oUF_Harmony.lua":

local w = 64*(max+2)
bar:SetWidth(w)

and

for i = 1, max do
  local orb = self.Harmony[i]
  local full = num/max
  if(i <= num) then
    if full == 1 then
      orb.fill:SetVertexColor(1,0,0)
      orb.glow:SetVertexColor(1,0,0)
    else
      orb.fill:SetVertexColor(bar.color.r,bar.color.g,bar.color.b)
      orb.glow:SetVertexColor(bar.color.r,bar.color.g,bar.color.b)
    end
    orb.fill:Show()
    orb.glow:Show()
    orb.highlight:Show()
  else
    orb.fill:Hide()
    orb.glow:Hide()
    orb.highlight:Hide()
  end
end

is to re-size the bar's width when there is a update on talent or spec which affects the max number of chi.

Am I getting it right?


6. Also, I still don't get why I can't get a "UnitPowerMax("player", SPELL_POWER_CHI)" doesn't work on Player Login...

I have read through about Legion's API Change that you wrote, but since that is being applied from Legion, I don't think this issue is related to that yet.

7.(???) Did you make those textures by yourself?

They look so cool !!

[zork]

2. Yes
6. I had some issues with ouf element registration aswell. That is why I am doing nasty things like this
https://github.com/zorker/rothui/blo...armony.lua#L90
Not sure why the event is not firing properly for the element.
7. Yes, I made the textures myself in the process of creating Roth UI. Some of them are based on Blizzard art, some of them are made from scratch.

[jeAz_]

Originally Posted by zork 2. Yes 6. I had some issues with ouf element registration aswell. That is why I am doing nasty things like this https://github.com/zorker/rothui/blo...armony.lua#L90 Not sure why the event is not firing properly for the element. 7. Yes, I made the textures myself in the process of creating Roth UI. Some of them are based on Blizzard art, some of them are made from scratch.

6. I actually tried this outside oUF (created another lua file) and it had same issues. Like what you did, I had to create a helper frame to get the value from UnitPowerMax("player", SPELL_POWER_CHI).

However, the problem is that I don't know how I should pull out the value that I got from event function.

Here's what it currently looks like.

local Helper = CreateFrame("Frame");
local _, Class = UnitClass("player");
 
PowerMax = nil;
PowerType = {
    Paladin = SPELL_POWER_HOLY_POWER,
    Monk = SPELL_POWER_CHI,
    Priest = SPELL_POWER_SHADOW_ORBS,
    Warlock = SPELL_POWER_SOUL_SHARDS,
};
 
D.A["RegEvent"](Helper, "PLAYER_LOGIN");
 
Helper:SetScript("OnEvent", function(self, event, ...)
    if (event == "PLAYER_LOGIN") then
        PowerMax = UnitPowerMax("player", PowerType[D.A.FirstToUpper(Class)]);
    end
end);

Since those two PowerMax variables have different scope, it is not working as I expectd

[zork]

Well. If I had to write a unified class bar element today I would probably start with sth like this.

config.lua

--addonName, addonTable (namespace)
local an, at = ...
 
--------------------------
--CONFIG
--------------------------
 
at.cfg = at.cfg or {}
 
at.cfg.monk_windwalker = {
  class = "MONK",
  power_type_token = "CHI",
  power_type_index = SPELL_POWER_CHI,
  req_spec = SPEC_MONK_WINDWALKER,
  req_spell = nil,
  width = 100,
  height = 10,
  scale = 1,
  texture = "Interface\\AddOns\\etc\\pp",
  point = {"CENTER",0,0}
  color = {1,0.5,0,1}
}

core.lua

--addonName, addonTable (namespace)
local an, at = ...
 
--------------------------
--CORE
--------------------------
 
at.core = at.core or {}
at.core.playerClass = select(2, UnitClass("player"))
 
--------------------------
--FUNCTIONS
--------------------------
 
--update func
local function Update(...)
 
  local bar,event,unit,token = ...
 
  if not bar:IsShown() then return end
  if not unit or (unit and unit ~= bar.unit) then return end
  if powerType and powerType ~= bar.cfg.power_type_token then return end
 
  bar.upc1 = UnitPower(unit, bar.cfg.power_type_index)
  bar.upc2 = UnitPower(unit, bar.cfg.power_type_index, true)
  bar.upm1 = UnitPowerMax(unit, bar.cfg.power_type_index)
  bar.upm2 = UnitPowerMax(unit, bar.cfg.power_type_index, true)
 
  bar:SetMinMaxValues(0, bar.upm2)
  bar:SetValue(bar.upc2)
 
  if bar.PostUpdate then
    bar.PostUpdate(...)
  end
 
end
 
--event func
local function Event(...)
  local bar, event = ...
  if event == "UNIT_POWER_FREQUENT" then
    Update(...)
  else
    --has spell?
    if bar.cfg.req_spell then
      if IsPlayerSpell(bar.cfg.req_spell) then
        bar:Show()
      else
        bar:Hide()
      end
    --has spec?
    elseif bar.cfg.req_spec then
      if GetSpecialization() ==  bar.cfg.req_spec then
        bar:Show()
      else
        bar:Hide()
      end
    end
    Update(bar,event,bar.unit,bar.cfg.power_type_token)
  end
end
 
--create func
local function Create(cfg)
 
  if at.core.playerClass ~= cfg.class then return end
 
  local bar = CreateFrame("StatusBar", name, UIParent)
  bar.cfg = cfg
 
  bar.unit = "player"
  bar:RegisterUnitEvent("UNIT_POWER_FREQUENT", bar.unit)
  bar:RegisterUnitEvent("UNIT_DISPLAYPOWER", bar.unit)
  bar:RegisterEvent("SPELLS_CHANGED")
  bar:SetScript("OnEvent", Event)
 
  return bar
 
end
 
at.core.Create = Create

chibar.lua

--addonName, addonTable (namespace)
local an, at = ...
--------------------------
--CALL for Windwalker Monk
--------------------------
 
local cfg = at.cfg.monk_windwalker
 
if at.core.playerClass == cfg.class then
 
  --create the bar
  local bar = at.core.Create(cfg)
 
  --chibar PostUpdate
 
  local function ChiBarPostUpdate(...)
    print("ChiBarPostUpdate",...)
  end
 
  --style the bar
  bar:SetWidth(cfg.width)
  bar:SetHeight(cfg.height)
  bar:SetScale(cfg.scale)
  bar:SetStatusBarTexture(cfg.texture)
  bar:SetPoint(unpack(cfg.point))
  bar:SetStatusBarColor(unpack(cfg.color))
 
  bar.PostUpdate = ChiBarPostUpdate
 
end

Basically you have 3 core functions for creation, eventHandling and updating. Additionally those functions only handle the events and leave the styling out. Thus you can do any styling later on via PostUpdate. You can even add orbs or stuff like that later on by creating them as a child of the bar element and create them on the fly via PostUpdate.

[p3lim]

Originally Posted by zork 6. I had some issues with ouf element registration aswell. That is why I am doing nasty things like this https://github.com/zorker/rothui/blo...armony.lua#L90 Not sure why the event is not firing properly for the element.

All elements are updated with the event "OnShow" during PLAYER_LOGIN, and is also updated on "PLAYER_ENTERING_WORLD".

[jeAz_]

Originally Posted by zork Basically you have 3 core functions for creation, eventHandling and updating. Additionally those functions only handle the events and leave the styling out. Thus you can do any styling later on via PostUpdate. You can even add orbs or stuff like that later on by creating them as a child of the bar element and create them on the fly via PostUpdate.

That's amazing!!

Now I can study more about lua with what you just provided

I actually gotta go and have some rest now since I have been staring at monitor for about 12 hours...

I'll have a look at it tomorrow and see how I go with your example

Thank you!

[sezz]

PostUpdate tells you when max power has changed:

https://github.com/haste/oUF/blob/ma...classicons.lua

--[[ :PostUpdate(cur, max, hasMaxChanged, event)
     Called after the element has been updated
     Arguments
     self          - The ClassIcons element
     cur           - The current amount of power
     max           - The maximum amount of power
     hasMaxChanged - Shows if the maximum amount has changed since the last
                     update
     event         - The event, which the update happened for
    ]]

local PostUpdateClassIcons = function(self, cur, max, oldMaxChanged)
    if (oldMaxChanged) then
        -- resize/move/whatever
    end
end
 
yourClassIcons.PostUpdate = PostUpdateClassIcons

If you don't want to use PostUpdate, I use ACTIVE_TALENT_GROUP_CHANGED, UNIT_MAXPOWER and PLAYER_TALENT_UPDATE to determine if max power has changed in my power bars addon. And also PLAYER_LEAVING_WORLD and PLAYER_ENTERING_WORLD, because while zoning UnitPowerMax sometimes returns 0 (atleast it did 2 years ago). But it's propably easier to just use the PostUpdate hook, because it's already there and works fine.