Making a Handynotes plugin - Cannot get function to return a value in one part.

[Nyyght]

Hello! I recently started learning to script LUA, so please forgive me if this is a simple fix/newb question. I have been searching all over the internet for almost a week and I am finally ready to admit defeat and request help from people who actually know what they're doing. Thank you in advance for your time!

My issue is that I've made several functions that all return a value which work in my other functions and even the tooltip function of my script. However, when I try to pull any functions into the the custom iterator function it keeps returning nil. Everything I try to plug in returns nil--even though it displays everywhere else fine. I'm not sure where I'm going wrong.

Here is the function I am trying to call my icon from. It works as intended when I pull it into the tooltip function. The "task_id" section decides if the achievement or quest is completed and if it is it returns "skipme", if not, it returns the criteria id or quest id.

local get_the_best_icon = function(uiMapId, coord, task_id)
local point = points[uiMapId] and points[uiMapId][coord]
if point then
local relevant_icon = point["icon_type"]
local completed_icon = "complete.tga"
local folder_dir = "Interface/AddOns/HandyNotes_EfficientSee/Icons/"

if task_id == "skipme" then
local show_icon = folder_dir..completed_icon
return show_icon
else
local show_icon = folder_dir..relevant_icon
return show_icon
end
return show_icon
end
end


Here is the part I cannot, for the life of me, get to work. This is the custom iterator and I am trying to get it to pull the icon from the get_the_best_icon function (for completed or not) to be shown for each node. All my attempts show nil here, even when working in other functions within the script.
do
local function iter(t, prestate)

if not t then return nil end
local state, value = next(t, prestate)
while state do

if value then

local icon = get_the_best_icon(value[1])
Debug("iter step", state, icon, db.icon_scale, db.icon_alpha)
return state, nil, icon, db.icon_scale, db.icon_alpha

end
state, value = next(t, state) -- Get next data
end
return nil, nil, nil, nil
end

function HLHandler:GetNodes2(uiMapId, minimap)
return iter, points[uiMapId], nil
end
end

Again, thank you so much for your time!

[Fizzlemizz]

In the iterator you:

local icon = get_the_best_icon(value[1])

In the get_the_best_icon function you

local point = points[uiMapId] and points[uiMapId][coord]

From this (unless there's something unknown not present in the code shown), it appears you're only ever passing the uiMapId arg to the function and never the coord (or task_id).

If you haven't installed them yet, I would recommend BugGrabber and Bugsack (they work together) to help with debugging.

[Nyyght]

Originally Posted by Fizzlemizz In the iterator you: local icon = get_the_best_icon(value[1]) In the get_the_best_icon function you local point = points[uiMapId] and points[uiMapId][coord] From this (unless there's something unknown not present in the code shown), it appears you're only ever passing the uiMapId arg to the function and never the coord (or task_id). If you haven't installed them yet, I would recommend BugGrabber and Bugsack (they work together) to help with debugging.

Hello, thank you so much for taking the time to help me! I really appreciate it.

I've downloaded the two debuggers you recommended and they have caught a few errors that usually didn't show. Unfortunately, I am still facing issues getting my icon function to show inside that iter function. It's really strange because I'm able to call functions into other sections (like the tooltips). I've even called the icon into the tooltips.

The tooltips are only showing for uncompleted tasks (as intended) but the icons don't show unless I add a single static link/folder. Meaning the icons are all or nothing.

Sorry about my formatting the first time. This is my first post here. I'm including the rest of the LUA, minus the initializing code, with a few entries of the data to show how I've set things up. I know I'm doing something wrong, but it's driving me up a wall that things seem to work everywhere except the iter function--even if I try to call uiMapId, coord, and task_id with the t and prestate.

local next = next
local GameTooltip = GameTooltip
local HandyNotes = HandyNotes
local GetAchievementInfo = GetAchievementInfo
local GetAchievementCriteriaInfo = GetAchievementCriteriaInfo
local GetAchievementCriteriaInfoByID = GetAchievementCriteriaInfoByID
 
local playerName = UnitName("player");
local PlayerFaction, _ = UnitFactionGroup("player")
local current_uiMapID = C_Map.GetBestMapForUnit("player")
 
---------------------------------------------------------
-- Constants
 
 
local points = {
    -- [mapfile] = { [coord] = { [achievement_id], [criteria_id], [icon_type], [point_type], [faction], [note] } }
    
    [23] = { -- Eastern Plaguelands
        [27592144] = {achieve = 771, criteria = 1101, quest_id = 0, item_id = 0, icon_type = "explore.tga", point_type = "achievement", faction = "Neutral", note = "Explore Plaguewood"}, -- 21
        -- Eastern Plaguelands Quests ( )
        [15606640] = {achieve = 0, criteria = 0, quest_id = 27367, item_id = 0, icon_type = "explore.tga", point_type = "quest", faction = "Neutral", note = "Quest End - Gidwin Goldbraids [4.2, 36.0] \n Next in Chain: Just Encased"}, -- 1
    },
 
}
 
-- Obtain the point type.
local info_for_point_type = function(uiMapId, coord)
    local point = points[uiMapId] and points[uiMapId][coord]
    if point then
        local point_type = point["point_type"]  
        return point_type
    end
end
 
-- Obtain the faction.
local info_for_faction = function(uiMapId, coord)
    local point = points[uiMapId] and points[uiMapId][coord]
    if point then
        local faction = point["faction"]    
        return faction
    end
end
 
-- Obtain the achievement IDnumber and whether the criteria is completed or not.
local info_from_coord = function(uiMapId, coord)
    local point = points[uiMapId] and points[uiMapId][coord]
    local point_type = info_for_point_type(uiMapId, coord)
    local faction = info_for_faction(uiMapId, coord)
    if point then   
        
        if(PlayerFaction == faction or faction == "Neutral") then
        
            -- If ACHIEVEMENT then decide if completed or return ID.
            if(point_type == "achievement") then
                -- Gather the achievement and criteria information. 
                local _, _, get_criteria_completed, _, _, _, _, _, _, _, _ = GetAchievementCriteriaInfoByID(point["achieve"], point["criteria"])    
                
                    if(get_criteria_completed == false) then
                        local task_id = GetAchievementInfo(point["achieve"])
                        return task_id
                    else 
                        local task_id = "skipme"
                        return task_id  
                    end
                    
            -- If QUEST then decide if completed or return ID.      
            elseif(point_type == "quest") then
                local quest_completed = C_QuestLog.IsQuestFlaggedCompleted(point["quest_id"])
                
                if(quest_completed == false) then
                    local task_id = point["quest_id"]
                    return task_id
                else 
                -- quest is the wrong faction or compelted so do not show.
                    local task_id = "skipme"
                    return task_id
                end 
            end
        return task_id
    end
end
 
 
-- Obtain the achievement name.
local info_for_achievement_name = function(uiMapId, coord)
    local point = points[uiMapId] and points[uiMapId][coord]
    local point_type = info_for_point_type(uiMapId, coord)
    local task_id = info_from_coord(uiMapId, coord)
    if point then
        -- Get achievement name
        if(point_type == "achievement" and task_id ~= "skipme") then
            local _, achievement_name = GetAchievementInfo(point["achieve"])    
            return achievement_name
        -- Get quest name
        elseif(point_type == "quest" and task_id ~= "skipme") then
            local achievement_name, _, _, _ = C_QuestLog.GetTitleForQuestID(point["quest_id"])
            return achievement_name
        else
            local achievement_name = "skipthis"
            return achievement_name 
        end
    return achievement_name
    end
end
 
-- Obtain the achievement criteria.
local info_for_criteria = function(uiMapId, coord)
    local point = points[uiMapId] and points[uiMapId][coord]
    local achievement = point["achieve"]
    local point_type = info_for_point_type(uiMapId, coord)
    if point then
        if(achievement ~= 0 ) then
        local achievement_criteria = GetAchievementCriteriaInfoByID(point["achieve"], point["criteria"])    
        return achievement_criteria
    elseif(achievement == 0 and point_type == "quest") then
        local achievement_criteria = "Quest"
        return achievement_criteria
    else 
        local achievement_criteria = "None"
        return achievement_criteria
    end
    end
end
 
-- Obtain the criteria ID.
local info_for_criteria_id = function(uiMapId, coord)
    local point = points[uiMapId] and points[uiMapId][coord]
    if point then
        local criteria_id = point["criteria"]   
        return criteria_id
    end
end
 
-- Obtain the note.
local info_for_note = function(uiMapId, coord)
    local point = points[uiMapId] and points[uiMapId][coord]
    if point then
        local note = point["note"]  
        return note
    end
end
 
-- Obtain the icon type.
local info_for_icon_type = function(uiMapId, coord)
    local point = points[uiMapId] and points[uiMapId][coord]
    if point then
        local icon_type = point["icon_type"]    
        return icon_type
    end
end
 
local get_the_best_icon = function(uiMapId, coord, task_id)
local point = points[uiMapId] and points[uiMapId][coord]
    if point then
    local relevant_icon = point["icon_type"]
    local completed_icon = "complete.tga"
    local folder_dir = "Interface/AddOns/HandyNotes_EfficientSee/Icons/"
 
        if task_id == "skipme" then
            local show_icon = folder_dir..completed_icon
            return show_icon
        else
            local show_icon = folder_dir..relevant_icon
            return show_icon
        end
    return show_icon
    end
end
 
---------------------------------------------------------
-- Plugin Handlers to HandyNotes
local HLHandler = {}
local info = {}
 
function HLHandler:OnEnter(uiMapId, coord)
    local tooltip = GameTooltip
    if ( self:GetCenter() > UIParent:GetCenter() ) then -- compare X coordinate
        tooltip:SetOwner(self, "ANCHOR_LEFT")
    else
        tooltip:SetOwner(self, "ANCHOR_RIGHT")
    end
    
    local task_id = info_from_coord(uiMapId, coord)
    local achievement_criteria = info_for_criteria(uiMapId, coord)
    local note = info_for_note(uiMapId, coord)
    local icon_type = info_for_icon_type(uiMapId, coord)
    local faction = info_for_faction(uiMapId, coord)
    local point_type = info_for_point_type(uiMapId, coord)
    local achievement_name = info_for_achievement_name(uiMapId, coord)
    local criteria_id = info_for_criteria_id(uiMapId, coord)
    local show_icon = get_the_best_icon(uiMapId, coord, task_id)
    -- show the achievement and criteria notes.
    if task_id ~= "skipme" and achievement_name ~= "skipthis" then 
        tooltip:SetText(("%s"):format(achievement_name)) -- Achievement
        tooltip:AddLine(("%s"):format(achievement_criteria)) -- Achievement Criteria
        tooltip:AddLine(("AchievementID: " .. task_id .. " CriteriaID: " .. criteria_id)) -- Achievement Note
        tooltip:AddLine(("Faction: " .. faction .. "Player Faction:" .. PlayerFaction)) -- Icon Type
        tooltip:AddLine(("Note: " .. note)) -- Achievement Note
        tooltip:AddLine(("Icon Type: " .. icon_type)) -- Icon Type
        tooltip:AddLine(("Point Type: " .. point_type)) -- Icon Type
        tooltip:AddLine(("Point Type: " .. show_icon)) -- Icon Type
        tooltip:Show()
    end
end
 
local function createWaypoint(button, uiMapId, coord)
    local x, y = HandyNotes:getXY(coord)
    local task_id = info_from_coord(uiMapId, coord)
    if TomTom then
        local persistent, minimap, world
        if temporary then
            persistent = true
            minimap = false
            world = false
        end
        TomTom:AddWaypoint(uiMapId, x, y, {
            title=achievement,
            persistent=persistent,
            minimap=minimap,
            world=world
        })
    end
end
 
do
    local currentZone, currentCoord
    local function generateMenu(button, level)
        if (not level) then return end
        for k in pairs(info) do info[k] = nil end
        if (level == 1) then
            -- Create the title of the menu
            info.isTitle      = 1
            info.text         = "HandyNotes - EfficientSee"
            info.notCheckable = 1
            UIDropDownMenu_AddButton(info, level)
 
            if TomTom then
                -- Waypoint menu item
                info.disabled     = nil
                info.isTitle      = nil
                info.notCheckable = nil
                info.text = "Create waypoint"
                info.icon = nil
                info.func = createWaypoint
                info.arg1 = currentZone
                info.arg2 = currentCoord
                UIDropDownMenu_AddButton(info, level);
            end
 
            -- Close menu item
            info.text         = "Close"
            info.icon         = nil
            info.func         = function() CloseDropDownMenus() end
            info.arg1         = nil
            info.notCheckable = 1
            UIDropDownMenu_AddButton(info, level);
        end
    end
    local HL_Dropdown = CreateFrame("Frame", "HandyNotes_EfficientSeeDropdownMenu")
    HL_Dropdown.displayMode = "MENU"
    HL_Dropdown.initialize = generateMenu
 
    function HLHandler:OnClick(button, down, uiMapId, coord)
        if button == "RightButton" and not down then
            currentZone = uiMapId
            currentCoord = coord
            ToggleDropDownMenu(1, nil, HL_Dropdown, self, 0, 0)
        end
    end
end
 
function HLHandler:OnLeave(uiMapId, coord)
    GameTooltip:Hide()
end
 
-- This is a custom iterator we use to iterate over every node in a given zone
 
do
 
local function iter(t, prestate)
    
        if not t then return nil end
        local state, value = next(t, prestate)
            while state do 
                    
                     if value then
                                                
                        local icon = get_the_best_icon(uiMapId, coord, task_id)
                            
                        Debug("iter step", state, icon, db.icon_scale, db.icon_alpha)
                        return state, nil, icon, db.icon_scale, db.icon_alpha   
                        
                    end
                    state, value = next(t, state) -- Get next data
                end
            return nil, nil, nil, nil
        end
 
function HLHandler:GetNodes2(uiMapId, minimap)
    return iter, points[uiMapId], nil
end
end

[Fizzlemizz]

I don't use HandyNotes so I don't know all the ins-n-outs.

The iterator is cycling through your points table for the current map id. (23 [EPL] in the table in your code).
for each successful

next(...)

state will be the coord id. (number eg. 27592144 or 15606640) and value will be the corresponding sub-table in points[uiMapId]

To work the function would look more like:

local get_the_best_icon = function(point) -- point is the coord sub-table
    if not point then return end -- should never happen but...
    local relevant_icon = point["icon_type"]
    local completed_icon = "complete.tga"
    local folder_dir = "Interface/AddOns/HandyNotes_EfficientSee/Icons/"
    if task_id == "skipme" then -- task_id not really usable here as it stands so a re-think needed.
            local show_icon = folder_dir..completed_icon
            return show_icon
    else
            local show_icon = folder_dir..relevant_icon -- This will prolbably be the only icon returned
            return show_icon
    end
    return show_icon -- will never get here because of the if/else nature of the stgatement above.
end

If the function is being used elsewhere you would use something like

if points[whatevertheMapIdis] and points[whatevertheMapIdis][whatevertheCoordIdis] then
    local icon = get_the_best_icon = get_the_best_icon(points[whatevertheMapIdis][whatevertheCoordIdis])
    -- do whatever with the icon
end

[Nyyght]

Originally Posted by Fizzlemizz I don't use HandyNotes so I don't know all the ins-n-outs. The iterator is cycling through your points table for the current map id. (23 [EPL] in the table in your code). for each successful next(...) state will be the coord id. (number eg. 27592144 or 15606640) and value will be the corresponding sub-table in points[uiMapId] To work the function would look more like: local get_the_best_icon = function(point) -- point is the coord sub-table     if not point then return end -- should never happen but...     local relevant_icon = point["icon_type"]     local completed_icon = "complete.tga"     local folder_dir = "Interface/AddOns/HandyNotes_EfficientSee/Icons/"     if task_id == "skipme" then -- task_id not really usable here as it stands so a re-think needed.             local show_icon = folder_dir..completed_icon             return show_icon     else             local show_icon = folder_dir..relevant_icon -- This will prolbably be the only icon returned             return show_icon     end     return show_icon -- will never get here because of the if/else nature of the stgatement above. end If the function is being used elsewhere you would use something like if points[whatevertheMapIdis] and points[whatevertheMapIdis][whatevertheCoordIdis] then     local icon = get_the_best_icon = get_the_best_icon(points[whatevertheMapIdis][whatevertheCoordIdis])     -- do whatever with the icon end

BLESS YOU AND YOUR GIANT SMART BRAIN!

It took me a little more tinkering around, but I finally got it to work thanks to your direction! I am more grateful for you taking the time to help me than I can properly express! You deserve the MOST luck ever!