oUF_Kygo, a few tips wanted

Kygo · 07-07-14, 02:22 PM

Heya!
Just a bit of a FYI, this might be long post, I'm really new when it comes to LUA.
After a little absence from WoW I'm back , and I got the idea to create my own layout for my AddOn comp which is currently using oUF_Phanx. (http://www.wowinterface.com/download...-oUFPhanx.html)

Been trying to put something really simple togheter first, but so far no luck at all. Or the lack of skills might be the correct word.
All I've managed to get working is this:

Lua Code:

local _, ns = ...
local _, playerClass = UnitClass("player")
local colors = oUF.colors
local config
 
ns.frames, ns.headers, ns.objects, ns.fontstrings, ns.statusbars = {}, {}, {}, {}, {}
 
-- Frames
local function Spawn(frame, unit, isSingle)
    frame:SetPoint("CENTER", UIParent)
    frame:SetSize(100, 25)
 
    local bg = frame:CreateTexture(nil, "BACKGROUND")
    bg:SetAllPoints(true)
    bg:SetTexture(0, 0, 0, 0.5)
    frame.bg = bg
    
    local name = frame:CreateFontString(nil, "OVERLAY", "GameFontNormal")
    name:SetPoint("BOTTOM", frame, "TOP")
    self:Tag(name, "[name]")
    frame.Name = name
end

It does not do a whole lot more than a small black box in the middle of the screen (Thats what it's supposed to do).
And it throws a LUA error which has caused me to scratch my head a whole lot. Line 27 is "self:Tag(name, "[name]").

Lua Code:

Message: Interface\AddOns\oUF_Kygo\Frames.lua:27: attempt to index global 'self' (a nil value)
Time: 07/07/14 22:15:18
Count: 1
Stack: Interface\AddOns\oUF_Kygo\Frames.lua:27: in function `styleFunc'
Interface\AddOns\oUF\ouf.lua:262: in function <Interface\AddOns\oUF\ouf.lua:192>
(tail call): ?
Interface\AddOns\oUF\ouf.lua:552: in function `Spawn'
Interface\AddOns\oUF_Kygo\Frames.lua:63: in main chunk
 
Locals: frame = oUF_KygoPlayer {
 0 = <userdata>
 bg = <unnamed> {
 }
 style = "Kygo"
 UNIT_EXITED_VEHICLE = <function> defined @Interface\AddOns\oUF\ouf.lua:38
 UNIT_ENTERED_VEHICLE = <function> defined @Interface\AddOns\oUF\ouf.lua:38
 PLAYER_ENTERING_WORLD = <function> defined @Interface\AddOns\oUF\ouf.lua:149
 __elements = <table> {
 }
 unit = "player"
}
unit = "player"
isSingle = true
bg = <unnamed> {
 0 = <userdata>
}
name = <unnamed> {
 0 = <userdata>
}
(*temporary) = nil
(*temporary) = nil
(*temporary) = "BOTTOM"
(*temporary) = oUF_KygoPlayer {
 0 = <userdata>
 bg = <unnamed> {
 }
 style = "Kygo"
 UNIT_EXITED_VEHICLE = <function> defined @Interface\AddOns\oUF\ouf.lua:38
 UNIT_ENTERED_VEHICLE = <function> defined @Interface\AddOns\oUF\ouf.lua:38
 PLAYER_ENTERING_WORLD = <function> defined @Interface\AddOns\oUF\ouf.lua:149
 __elements = <table> {
 }
 unit = "player"
}
(*temporary) = "TOP"
(*temporary) = "attempt to index global 'self' (a nil value)"

Been trying to use diffrent variants of Healthbar and powerbar code snippets (Everything from Zork's oUF_Simple to oUF_Phanx) but when I start WoW back up with the new code in place , it's only showing the standard Blizzard UnitFrames.
The code I've been trying to make it work is this:

Lua Code:

-- Health bar
    local Health = CreateFrame("FRAME", nil, self)
    Health:SetHeight(14)
--  Health:SetStatusBarTexture(_TEXTURE)
 
    Health:SetPoint("TOP", 0, -8)
    Health:SetPoint("LEFT", 8, 0)
    Health:SetPoint('RIGHT', -90, 0)
 
    Health.frequentUpdates = true
    Health.colorDisconnected = true
    Health.colorTapping = true
    Health.colorSmooth = true
 
    Health.PostUpdate = PostUpdateHealth
 
    self.Health = health
 
    local HealthPoints = Health:CreateFontString(nil, "OVERLAY", "GameFontNormal")
    HealthPoints:SetPoint("LEFT", Health, "RIGHT", 2, -1)
    HealthPoints:SetPoint("RIGHT", self, -6, -1)
    HealthPoints:SetJustifyH"CENTER"
    HealthPoints:SetFont(GameFontNormal:GetFont(), 10)
    HealthPoints:SetTextColor(1, 1, 1)
 
    self:Tag(HealthPoints, '[dead][offline][classic:health]')
 
    Health.value = HealthPoints

If this code is out of date or just plain wrong, no need to sugar coat it!

Phanx · 07-09-14, 07:09 AM

In your first snippet (the one giving you an error):

Code:

local _, ns = ...
local _, playerClass = UnitClass("player")
local colors = oUF.colors
local config
-- ^ Your code doesn't use any of these variables, so you can remove them,
-- though if you plan to extend your code across multiple files in the future
-- then you might want to keep the first one. In particular, the "config" variable
-- is specific to the inner workings of oUF_Phanx, so it's unlikely your layout
-- will use it.

ns.frames, ns.headers, ns.objects, ns.fontstrings, ns.statusbars = {}, {}, {}, {}, {}
-- ^ Your code doesn't use any of these tables, which are specific to the internal
-- workings of oUF_Phanx. You can just remove this whole line.

-- Frames

local function Spawn(frame, unit, isSingle)
    frame:SetPoint("CENTER", UIParent)
    frame:SetSize(100, 25)
 
    local bg = frame:CreateTexture(nil, "BACKGROUND")
    bg:SetAllPoints(true)
    bg:SetTexture(0, 0, 0, 0.5)
    frame.bg = bg
    
    local name = frame:CreateFontString(nil, "OVERLAY", "GameFontNormal")
    name:SetPoint("BOTTOM", frame, "TOP")
    self:Tag(name, "[name]")
    -- ^ This line triggers the error because you are using a variable "self"
    -- which you didn't define anywhere. You probably meant "frame" to
    -- refer to the unit frame you are currently working with.
    frame.Name = name
end

I don't see anything wrong in your second block, but there are a few "bad habits" you should try to avoid when writing your own code (and should also correct when copying from other people's sloppy code, for consistency):

Code:

    local Health = CreateFrame("FRAME", nil, self)

Frame types are not written in all-caps. The API will auto-correct the capitalization for values that you pass in, but you should use correct capitalization anyway, both because it's correct, and because Lua itself is case sensitive, so if you're ever comparing values to the values returned by API functions like frame:GetFrameType(), your "FRAME" will not match the returned "Frame".

Code:

    Health:SetPoint("TOP", 0, -8)
    Health:SetPoint("LEFT", 8, 0)
    Health:SetPoint('RIGHT', -90, 0)

Pick one style of string quoting and stick with it. Don't randomly use "double quotes" on one line, and 'single quotes' the next. I'd suggest using "double quotes" since it's more likely you'll want to use an apostrophe inside a string than a quotation mark, and that way you won't have to escape things as often.

----------

Overall I'd say you're on the right track with your first snippet -- start with the most basic thing (the base frame) and add one thing at a time, making sure you understand each piece rather than copying and pasting a bunch of stuff at once and trying to figure it out afterward. You'll be a lot less frustrated along the way, and end up knowing a lot more.

Kygo · 07-09-14, 09:46 AM

Thank you so much Phanx for the explination of my errors and corrected me!
I will learn to use the correct capitalization in my code!

The code snippets I found inside oUF_Phanx , I thought those were requiered for the code to run, for instance that the "local _, ns = ..." told oUF the code to oUF so it knew what to run?

Great! Got the name working, did play around with the settings for size, alpha and color!

Now I've been trying to make the healthbar appear and work, did as you said, swapped out ' for " on a few places, and did swap out "self" for "Frame" due to because I have not defined "self" anywhere.
How the health code looks right now:
(Did add "local function Spawn(Frame, unit, isSingle) because without it threw a error, can post it aswell if needed/wanted)

Lua Code:

-- Health bar
local function Spawn(Frame, unit, isSingle)
    Frame:SetPoint("CENTER", UIParent)
    Frame:SetSize(100, 25)
    
    local Health = CreateFrame("Frame", nil, self)
    Health:SetHeight(25)
--  Health:SetStatusBarTexture(_TEXTURE)
 
    Health:SetPoint("TOP", 0, -8)
    Health:SetPoint("LEFT", 8, 0)
    Health:SetPoint("RIGHT", -90, 0)
    
 
    Health.frequentUpdates = true
    Health.colorDisconnected = true
    Health.colorTapping = true
    Health.colorSmooth = true
 
    Health.PostUpdate = PostUpdateHealth
 
    Frame.Health = Health
    
    local HealthPoints = Health:CreateFontString(nil, "OVERLAY", "GameFontNormal")
    HealthPoints:SetPoint("LEFT", Health, "RIGHT", 2, -1)
    HealthPoints:SetPoint("RIGHT", self, -6, -1)
    --HealthPoints:SetJustify("CENTER")
    HealthPoints:SetFont(GameFontNormal:GetFont(), 10)
    HealthPoints:SetTextColor(1, 1, 1)
 
    Frame:Tag(HealthPoints,"[dead][offline]")
    
 
    Health.value = HealthPoints
end

But now is that code throwing a diffrent error. The LUA error that code throws:
Got a LUA error saying that [classic:Health] is invalid so i did just remove that part for now.
And my black box with my name on top of it did disappear :S But I did not get a standard Blizzard Unitframe for the player!

Code:

Message: Interface\AddOns\oUF\elements\health.lua:99: attempt to call method 'SetMinMaxValues' (a nil value)
Time: 07/09/14 17:33:36
Count: 1
Stack: Interface\AddOns\oUF\elements\health.lua:99: in function <Interface\AddOns\oUF\elements\health.lua:91>
(tail call): ?
Interface\AddOns\oUF\ouf.lua:158: in function <Interface\AddOns\oUF\ouf.lua:149>
(tail call): ?

Locals: self = oUF_KygoPlayer {
 0 = <userdata>
 __tags = <table> {
 }
 PLAYER_ENTERING_WORLD = <function> defined @Interface\AddOns\oUF\ouf.lua:149
 UNIT_FACTION = <function> defined @Interface\AddOns\oUF\elements\health.lua:147
 unit = "player"
 UNIT_CONNECTION = <function> defined @Interface\AddOns\oUF\elements\health.lua:147
 UNIT_EXITED_VEHICLE = <function> defined @Interface\AddOns\oUF\ouf.lua:38
 style = "Kygo"
 Health = <unnamed> {
 }
 UNIT_HEALTH_FREQUENT = <function> defined @Interface\AddOns\oUF\elements\health.lua:147
 UNIT_MAXHEALTH = <function> defined @Interface\AddOns\oUF\elements\health.lua:147
 __elements = <table> {
 }
 UNIT_ENTERED_VEHICLE = <function> defined @Interface\AddOns\oUF\ouf.lua:38
}
event = "PLAYER_ENTERING_WORLD"
unit = "player"
health = <unnamed> {
 __owner = oUF_KygoPlayer {
 }
 colorSmooth = true
 colorTapping = true
 ForceUpdate = <function> defined @Interface\AddOns\oUF\elements\health.lua:151
 value = <unnamed> {
 }
 0 = <userdata>
 frequentUpdates = true
 colorDisconnected = true
}
min = 154
max = 154
disconnected = false
(*temporary) = nil
(*temporary) = <unnamed> {
 __owner = oUF_KygoPlayer {
 }
 colorSmooth = true
 colorTapping = true
 ForceUpdate = <function> defined @Interface\AddOns\oUF\elements\health.lua:151
 value = <unnamed> {
 }
 0 = <userdata>
 frequentUpdates = true
 colorDisconnected = true
}
(*temporary) = 0
(*temporary) = 154
(*temporary) = "attempt to call method 'SetMinMaxValues' (a nil value)"

Did look through the health.lua inside \oUF\elements to see if I could find arguments or what to call them that looks like those I already have inside the code, but could not find any. (Could have missed them, will look through the code again)

http://pastebin.com/u/Kygo , the full code and errors.

Rainrider · 07-10-14, 01:44 AM

There are different types of frames and the elements in oUF require a specific one in order to use their internal update process. Depending on the type of the widget it has certain methods available. A good overview of the widget hierarchy could be found on wowprogramming.com. Usually there is some documentation in the top part of the element file that states the required widget. So, the health element requires you to define a key entry Health (i.e. Frame.Health) of the UI widget type "StatusBar". At Line 6 in your posted code snippet you define it as a simple "Frame", to which the SetMinMaxValues method, called in the elements internal update method, is not available.

Kygo · 07-10-14, 08:57 AM

Made a few changes to the code. Got textures for 3 units ( only player, target and pet spawned).
Name is visible aswell, but now the HealthPoints tag wont work. Been trying to fix it on my own with various names and variables changed.

@Rainrider, I did fiddle around with the examples inside "oUF\\elements\\health.lua" , did not make it any better. Only made me more confused and annoyed when it threw a bunch of errors at me.
Right now, I don't get any errors with

Lua Code:

--SB:Tag(HealthPoints, "[dead][curhp]")
    --SB.value = HealthPoints

commented out. But then again, no current HP tag is visible either.

And also, why does the "target" texture show even tho I don't have a target?
Been trying to make a statusbar that "moves" or what to call it when the HP decrease and/or increase, without any progress.

The full code that I'm using right now is here -> http://pastebin.com/VKyVvR5c . It's messy right now with a bunch commented out, but it's only for testing purposes.

Here are a few screenshots with the frames.

http://imgur.com/a/063Rs

Rainrider · 07-10-14, 10:48 AM

It seems to me you are a bit confused about the structure of your layout and that you are copying stuff from somewhere else without fully understanding it. Let's try it step by step.

Widgets in World of Warcraft are just tables to Lua. So you just attach oUF elements to the table you create for a certain unit.

The function you use to describe the look of your frames (the one you called Spawn at line 10 in your pastebin) is your style function and it is run by oUF for every unit you spawn through oUF:Spawn.

The style function receives 3 arguments:

the unit button - that is what you called Frame at line 10. Technically this is a frame of type "Button" (so that mouse interaction is possible for it), that's why it is called a unit button. Remember, to Lua this is still just a table.
unit - a string identifying the unit corresponding to the unit button. In your case it will be either "player", "target" or "pet".
isSingle - a boolean telling you whether you get a header or a single unit. You are currently only creating single units, so just leave this be for the moment.

So let's start empty and try to style the player frame (the unit button for the player unit), add a health bar and a health value to it.

lua Code:

local function Style(frame, unit, isSingle)
    frame:SetSize(100, 25)
 
    -- create a background for the frame
    local frameBG = frame:CreateTexture(nil, "BACKGROUND")
    frameBG:SetAllPoints()
    frameBG:SetTexture(0, 0, 0, 0.5)
 
    -- define the health element
    local health = CreateFrame("StatusBar", nil, frame)
    health:SetSize(100, 15)
    health:SetPoint("TOPLEFT", frame, "TOPLEFT", 0, 0)
    -- let oUF handle coloring
    -- the key names matter!
    health.colorReaction = true
    health.colorClass = true
 
    -- create a background for the health bar
    local healthBG = health:CreateTexture(nil, "BACKGROUND")
    healthBG:SetAllPoints()
    healthBG:SetTexture("Interface\\ChatFrame\\ChatFrameBackground")
    -- make the background inherit the color of the status bar and be darker
    healthBG.multiplier = 0.3
    -- attach the background to the health bar table
    -- the table key has to be named bg
    health.bg = healthBG
 
    -- register it with oUF
    -- this means you create a table key named Health
    frame.Health = health
 
    -- create the health text
    -- the health bar is the parent of the fontstring
    -- because we want it to appear on the health bar
    local healthText = health:CreateFontString(nil, "OVERLAY", GameFontNormal)
    healthText:SetPoint("RIGHT", health, "RIGHT")
    frame:Tag(healthText, "[dead][curhp]")
end

Beware the order in that we define things. The unit button is passed as an argument to the Style function, that is the reason I can use it right away. You generally can't use stuff that hasn't been defined yet. So if you want to create a background for your health bar, you have to create the health bar first.

So what did I do and why:
I created a background for the unit button so that you can have a visual representation for it and can better see how it is used to hold the other stuff we apply to the frame.

Then I created the health bar and a background texture for it, so that you can see how the health bar sits on top of the frame and how it looks when it depletes.

Then I created a tag to hold the current health value and display "Dead" before it, if the unit is dead.

Beware that I didn't position the frame. In your code you used a single statement for positioning regardless of what frame your Style function is being called for. Thus all your spawned frames appear on top of each other and you have to move them with oUF_MovableFrames. Let's position them properly:

lua Code:

oUF:RegisterStyle("Kygo", Style)
oUF:SetActiveStyle("Kygo")
local player = oUF:Spawn("player")
player:SetPoint("CENTER", UIParent, "CENTER", 0, 0)
 
local target = oUF:Spawn("target")
target:SetPoint("LEFT", player, "RIGHT", 20, 0)
 
local pet = oUF:Spawn("pet")
pet:SetPoint("BOTTOMLEFT", player, "TOPLEFT", 0, 20)

The above goes at the end of you file. Beware that we now call our style function Style. I changed the name so that you differentiate it from Spawn, which is a function oUF provides. Now the target frame is positioned 20px right to the player frame, and the pet frame is 20px above the player. Those settings will be overridden by oUF_MovableFrames with the values you set previously by moving your frames around.

I hope you now see how oUF looks for certain table keys attached to your frames and does it's magic based on their existence. Please note that the code provided is dry coded and might not function

Phanx · 07-10-14, 11:19 AM

Rainrider already explained most of it, but:

Originally Posted by Kygo

The code snippets I found inside oUF_Phanx , I thought those were requiered for the code to run, for instance that the "local _, ns = ..." told oUF the code to oUF so it knew what to run?

Well, those lines are required for oUF_Phanx to run, because other code inside oUF_Phanx expects those variables to exist, and uses them to pass information around between various functions across multiple files. They are not required for oUF, or for addons in general. oUF "knows" what to run because you tell it what to run, eg. oUF:Spawn("player").

You will see a line like "local _, ns = ..." in a lot of addons, but it has nothing to do with oUF. See this post for an explanation of what this line does.

Kygo · 07-10-14, 04:22 PM

Wow, thank you Rainrider! Some how it made a little more sense to me!
I have to admit that the layout in the code I used was quite confusing.
I did find code snippets inside a few oUF layouts , more those were more to see how other people did and what functions etc they did use to make things work.

Really well written explination aswell, made me as a complete beginner understand a bit more!
Thanks!

@Phanx
I see! Learning something new everyday!

That you and Rainrider is helping me out (and possibly others reading this thread?) and having the patience and for that I'm grateful!

Cheers for the link to that post!

Update:
Added powerbar with text and portrait to player unit.
But now for some reason , using powerText:SetSize only affects the width , but not the height?
Might be the wrong syntax for the task or is it because I've set it to parent with the powerbar itself?

Solved the problem above by adding powerText:SetFont("Interface\\AddOns\\oUF_Kygo\\Media\\ExpresswayRg.ttf", 10)
Thought that SetFont made sense afterall :P So did try it out and it worked!

Updated code is here -> http://pastebin.com/U5JH0ten

How would you add a border to your frames?
I did it this way:
If I wouldnt use the ", -2" in the borderf:SetPoint syntax it would missing 2 or 3 px at the bottom.
And without the "borderf:SetSize(116,32)" it does not fill out the frame :S Most likley doing it wrong!

Lua Code:

--border
    local borderf = health:CreateTexture(nil, "BACKGROUND", health)
    borderf:SetPoint("CENTER", frame, "CENTER", 0, -2)
    borderf:SetSize(116, 32)
    borderf:SetTexture("Interface\\ChatFrame\\ChatFrameBorder")
    
    health.borderf = borderf

Kygo · 07-12-14, 05:52 AM

Hey again! Thought I'd update this thread today!
Did add a border with a small amount of backdrop to my frames using this:

Lua Code:

--border
    local borderf = CreateFrame("Frame", nil, health)
    borderf:SetPoint("RIGHT", 5, -2.6)
    borderf:SetSize(159, 34.5)
    
    borderf:SetBackdrop({
        bgFile = "Interface\\AddOns\\oUF_Kygo\\Media\\backdrop", tile = false,
        edgeFile = "Interface\\AddOns\\oUF_Kygo\\Media\\backdrop_edge", edgeSize = 5,
        insets = { left = 1, right = 1 , top = 1, bottom = 1 }
    })
    borderf:SetBackdropColor(0, 0, 0, .1)
    borderf:SetBackdropBorderColor(0, 0, 0, 1)
    
    health.borderf = borderf

It looks alright, still some tweaking for a bit more depth on the backdrop!

Got a few questions that I hope someone could answer!

If I want to make the healthbars in custom colors , how do I do that? Did try to disable ".colorClass" and add ":SetStatusbarColor" and "SetStatusbarTexture" (not at the same time tho) with (0, 0, 0, .5) (that color just to test!) but it came back saying that both of the syntaxes is returning a nil value.

If I want to add another file that contains referencses / links to the textures and fonts etc or even define custom colors so that the Frames.lua file can use those variables like to replace this >
"Interface\\AddOns\\oUF_Kygo\\Media\\neuropol.ttf" with this > config.healthTextFont or something similar (not completly sure on the syntax that needs to be used)

Like a small push just to get started would be really nice!

Updated code (updated today) > http://pastebin.com/U5JH0ten if you wanna look at it!