ESOUI - Is there a global public function to safely update the map?

ESOUI (https://www.esoui.com/forums/index.php)

- General Authoring Discussion (https://www.esoui.com/forums/forumdisplay.php?f=174)

- - Is there a global public function to safely update the map? (https://www.esoui.com/forums/showthread.php?t=8233)

Is there a global public function to safely update the map?

I'd like to replace the use of ZO_WorldMap_UpdateMap() in my Addon to something public if available.

reference function https://esoapi.uesp.net/100025/src/i....lua.html#6073

I highly doubt you want to update the whole map all the time.
I think you are looking for

Code:

ZO_WorldMap_RefreshCustomPinsOfType(pinType)

or for more control:

Code:

ZO_WorldMap_GetPinManager()

Thanks! That's precisely what I'm looking for. Just want to update the pin.

My custom pin is declared in Pointer.lua. Here's the abbreviated file, showing only snippets of code that is relevant here.

lua Code:

local Pointer = {}
ZGV.Pointer = Pointer
 
Pointer.Icons = {
    default =   "ESOdot",
    ESOdot =    { icon=ZGV.DIR.."/Arrows/Stealth/arrow-error.dds", size=40, minisize=25, rotates=false, edgeicon=ZGV.DIR.."\\Skins\\minimaparrow-green-edge", edgesize=60, spinner=true, onminimap=always },
}

The ZGV:SetWaypoint function is found in GuideHandling.lua and responsible for setting the pin on the map when the guide moves to the next or previous steps. I put the following snippet there.

lua Code:

for k,v in pairs(ZGV.Pointer.Icons) do 
    if type(v) == "table" then 
        if k == "ESOdot" then
            print(k)
            ZO_WorldMap_RefreshCustomPinsOfType(k)
        end
    end 
end

The good news is the print statement returns "ESOdot." However, ZO_WorldMap_RefreshCustomPinsOfType(k) doesn't update the pin on the map. For a brief moment the only time I see the pin change locations is when I close the map (or enable ZO_WorldMap_UpdateMap, which I want to move away from).

Is ESOdot not the required pinType?

Any ideas, thoughts, sage advice? :)

Quote:

Originally Posted by Hydra9268 (Post 36799)

Is ESOdot not the required pinType?

Any ideas, thoughts, sage advice? :)

No. pinType is the integer identifier you got from ZO_WorldMap_AddCustomPin(). Which is _G[k] in your case.

Quote:

Originally Posted by votan (Post 36800)

No. pinType is the integer identifier you got from ZO_WorldMap_AddCustomPin(). Which is _G[k] in your case.

That makes more sense. Thanks!

Can't wait to try it after work.

I see what the problem is. Zygor isn't using the LibGPS. They created their own metatable overload! Which means ZO_WorldMap_RefreshCustomPinsOfType(_G[pinType]) doesn't work. WTF Zygor? Oh, and all the crap below ESOdot isn't used. Looks like they were doing something with marching ants?

lua Code:

Pointer.Icons = {
    default =   "ESOdot",
    ESOdot =    { icon=ZGV.DIR.."/Arrows/Stealth/arrow-error.dds", size=40, minisize=25, rotates=false, edgeicon=ZGV.DIR.."\\Skins\\minimaparrow-green-edge", edgesize=60, spinner=true, onminimap=always },
    greendot =  { icon=ZGV.DIR.."\\Skins\\minimaparrow-green-dot", size=40, minisize=25, rotates=false, edgeicon=ZGV.DIR.."\\Skins\\minimaparrow-green-edge", edgesize=60, spinner=true, onminimap=always },
    graydot =   { icon=ZGV.DIR.."\\Skins\\minimaparrow-green-dot", size=40, minisize=25, rotates=false, edgeicon=ZGV.DIR.."\\Skins\\minimaparrow-green-edge", edgesize=60, spinner=true, desat=1, onminimap=always },
    arrow =     { icon=ZGV.DIR.."\\Skins\\minimaparrow-path", size=70, minisize=60, rotates=true, edgeicon=ZGV.DIR.."\\Skins\\minimaparrow-path", edgesize=50 },
    ant =       { icon=ZGV.DIR.."\\Skins\\minimaparrow-ant", alpha=0.8, size=30, minisize=25, rotates=false, edgeicon=nil, edgesize=1 },
    ant_g =     { icon=ZGV.DIR.."\\Skins\\minimaparrow-ant", r=0.4, g=1, b=0, alpha=0.8, size=30, minisize=25, rotates=false, edgeicon=nil, edgesize=1 },
    ant_b =     { icon=ZGV.DIR.."\\Skins\\minimaparrow-ant", r=0, g=0.7, b=1, alpha=0.8, size=30, minisize=25, rotates=false, edgeicon=nil, edgesize=1 },
    ant_p =     { icon=ZGV.DIR.."\\Skins\\minimaparrow-ant", r=0.8, g=0.3, b=1, alpha=0.8, size=30, minisize=25, rotates=false, edgeicon=nil, edgesize=1 },
    ant_y =     { icon=ZGV.DIR.."\\Skins\\minimaparrow-ant", r=1, g=0.8, b=0, alpha=0.8, size=30, minisize=25, rotates=false, edgeicon=nil, edgesize=1 },
    none =      { icon="", alpha=0.0, size=1, minisize=1, rotates=false, edgeicon=nil, edgesize=1 },
 
    ant_g_default = { r=0.4, g=1, b=0, alpha=0.8 },
    ant_b_default = { r=0, g=0.7, b=1, alpha=0.8 },
    ant_p_default = { r=0.8, g=0.3, b=1, alpha=0.8 },
    ant_y_default = { r=1, g=0.8, b=0, alpha=0.8 },
    ant_default = { r=1, g=1, b=1, alpha=0.8 },
}
 
setmetatable(Pointer.Icons,{__index=function(k) return Pointer.Icons[Pointer.Icons.default] end})
for k,v in pairs(Pointer.Icons) do if type(v)=="table" then __CLASS[v]="PointerIcon_"..k end end

And here's how they get the pin.

lua Code:

function Pointer:GetMapMarker (m,f,x,y,data)
    if not m and not f then
        m,f = self:GetMapTex(),0
    end
 
    if not m or not f or not x or not y then
        Pointer:Debug("GetMapMarker bailing out; map=%s/%d %.2f %.2f",m,f or -1,x or -99,y or -99)
        return
    end
 
    local waypoint = self:GetUnusedMarker()
    waypoint.m = m
    waypoint.f = f
    waypoint.x = x
    waypoint.y = y
 
    ZGV.Utils.table_join(waypoint,data)
    return waypoint
end

The code is gross! This whole time I thought they were using LibGPS. It looks like they loaded the library into the txt file and never bothered to use it.

Well, I guess that's good news. It means I can rip out all their bull**** and move to LibsGPS and hopefully make this Addon more friendly with other Addons like Bandit's mini-map. I'm not at that level of LUA scripting but I need to give it go out of necessity. Hopefully, it's not too too complicated with one pin. There's also this awesome HOW-TO guide by Garkin. I hope it is still relevant in 2018.

If you know of a updated guide or a better guide please let me know. I'll take all the guidance I can get.

Based on Garkin's awesome script (Big kudos).

lua Code:

-- Based on Garkin's Guide 
-- [url]https://www.esoui.com/forums/showthread.php?t=1557[/url]
 
local ZGESO = {}
 
-- Pin's unique ID
ZGESO.pinType = "MyMapPin"
 
-- Pin Data
ZGESO.pinLayoutData = {
    { level = 50, texture = "/Arrows/Stealth/arrow-error.dds", size = 40 },
}
 
-- Unit test sample data
ZGESO.pinData = {
    ["alikr"] = {
        ["sentinel_base"] = {
            { x = 0.130820446, y = 0.378319359 },
        },
    },
}
 
-- Tooltip Creator
ZGESO.pinTooltipCreator = {
    creator = function(pin)
        local x, y = pin:GetNormalizedPosition()
        InformationTooltip:AddLine( zo_strformat( "Position of my pin is: <<1>>,<<2>>", x*1000, y*1000 ) )
    end,
    tooltip = InformationTooltip,
}
 
-- Add a Callback Function
function ZGESO.pinTypeAddCallback(pinManager)
    -- Do not create pins if your pinType is not enabled
    if not ZO_WorldMap_IsCustomPinEnabled(_G[ZGESO.pinType]) then return end
   
    -- Do not create pins on world, alliance and cosmic maps
    if (GetMapType() > MAPTYPE_ZONE) then return end
 
    -- Okay to continue
    local textureName = GetMapTileTexture()
    textureName = string.lower(textureName)
    local _,_,_,zone,subzone = string.find(textureName, "(maps/)([%w%-]+)/([%w%-]+_%w+)")
    local pins
    print(zone, subzone)
 
    if ZGESO.pinData[zone] and ZGESO.pinData[zone][subzone] then
        pins = ZGESO.pinData[zone][subzone]
    else
        return  -- Return if there's no current map data
    end
 
    for _, pinInfo in ipairs(pins) do
        -- ZO_WorldMapPins:CreatePin(pinTypeId, pinTag, locX, locY, areaRadius)
        -- pinTag can be anything, but I recommend using table or string with additional info about pin, you can use it later in code
        pinManager:CreatePin(_G[ZGESO.pinType], pinInfo, pinInfo.x, pinInfo.y)
   end
end
 
-- Resize callback function (usualy just nil)
function ZGESO.pinTypeOnResizeCallback(pinManager, mapWidth, mapHeight)
    local visibleWidth, visibleHeight = ZO_WorldMapScroll:GetDimensions()
    local currentZoom = mapWidth / visibleWidth
   
    if currentZoom < 1.5 then
        ZO_WorldMap_SetCustomPinEnabled(_G[ZGESO.pinType], false)
    else
        ZO_WorldMap_SetCustomPinEnabled(_G[ZGESO.pinType], true)
    end
 
   ZO_WorldMap_RefreshCustomPinsOfType(_G[ZGESO.pinType])
end
 
function OnLoad(eventCode, name)
    -- The name of this addon
    if name ~= "ZGESO" then return end
 
   -- Initialize map pins
   ZO_WorldMap_AddCustomPin(ZGESO.pinType, ZGESO.pinTypeAddCallback, ZGESO.pinTypeOnResizeCallback, ZGESO.pinLayoutData, ZGESO.pinTooltipCreator)
   
   -- Custom pins are disabled by default, you have to enable them
   ZO_WorldMap_SetCustomPinEnabled(_G[ZGESO.pinType], true)
   
   -- Force refresh pins to call pinTypeAddCalback for the current map
   ZO_WorldMap_RefreshCustomPinsOfType(_G[ZGESO.pinType])
 
   EVENT_MANAGER:UnregisterForEvent("ZGESO_OnLoad", EVENT_ADD_ON_LOADED)
end
 
EVENT_MANAGER:RegisterForEvent("ZGESO_OnLoad", EVENT_ADD_ON_LOADED, OnLoad)

It looks like the code works but there's a problem with the level value in ZO_MapPin.SetData?
https://esodata.uesp.net/100025/src/....lua.html#3347

lua Code:

bad argument #1 to 'math.max' (number expected, got nil)
stack traceback:
[C]: in function 'math.max'
EsoUI/Ingame/Map/WorldMap.lua:3347: in function 'ZO_MapPin:SetData'
    <Locals> self = tbl, pinType = 206, pinTag = tbl, control = ud, labelControl = ud, singlePinData = tbl, overlayControl = ud, highlightControl = ud </Locals>    
EsoUI/Ingame/Map/WorldMap.lua:3687: in function 'ZO_WorldMapPins:CreatePin'
    <Locals> self = tbl, pinType = 206, pinTag = tbl, xLoc = 0.130820446, yLoc = 0.378319359, pin = tbl, pinKey = 71 </Locals>  
user:/AddOns/ZGESO/Pointer.lua:181: in function 'ZGESO.pinTypeAddCallback'
    <Locals> pinManager = tbl, textureName = "art/maps/alikr/sentinel_bas...", _ = 5, _ = 28, _ = "maps/", zone = "alikr", subzone = "sentinel_base", pins = tbl, _ = 1, pinInfo = tbl </Locals>    
EsoUI/Ingame/Map/WorldMap.lua:3667: in function 'ZO_WorldMapPins:RefreshCustomPins'
    <Locals> self = tbl, pinTypeId = 206, pinData = tbl </Locals>   
EsoUI/Ingame/Map/WorldMap.lua:6100: in function 'ZO_WorldMap_UpdateMap'
    <Locals> zoneName = "Sentinel", mapTitle = "Sentinel" </Locals> 
user:/AddOns/ZGESO/Viewer/GuideViewerFrame.lua:1095: in function 'Viewer:HandleActionLayer'
    <Locals> self = tbl, isActive = [C]:-1 </Locals>    
user:/AddOns/ZGESO/Viewer/GuideViewerFrame.lua:1133: in function 'Viewer:EVENT_ACTION_LAYER_POPPED'
    <Locals> self = tbl, event = 65553, layerIndex = 7, activeLayerIndex = 2 </Locals>  
user:/AddOns/ZGESO/Events.lua:58: in function 'EventHandler'
    <Locals> event = 65553, self = tbl, eventString = "EVENT_ACTION_LAYER_POPPED", _ = 1, hand = tbl, func = user:/AddOns/ZGESO/Viewer/GuideViewerFrame.lua:1131, funcSelf = tbl </Locals>

Extra information:

1. The pinLayoutData array has a value for level.

2. The print(zone, subzone) on line 45 splits out what appears to be an endless list of zone, subzone. My conclusion is there needs to be a max value to stop it from overloading ZO_MapPin.SetData. Is that causing the problem?

3. An observational finding https://i.imgur.com/SpnGhqf.png

The LUA error is caused because your ZGESO.pinLayoutData is a table inside a table.
You want to use one of the following two:

Code:

ZGESO.pinLayoutData = { level = 50, texture = "/Arrows/Stealth/arrow-error.dds", size = 40 }

Code:

ZO_WorldMap_AddCustomPin(ZGESO.pinType, ZGESO.pinTypeAddCallback, ZGESO.pinTypeOnResizeCallback, ZGESO.pinLayoutData[0], ZGESO.pinTooltipCreator)

Also please note the following:
The ZGESO.pinTypeOnResizeCallback is called every time that scaling of the map changes. For example if you scroll your mouse wheel on the map, then this function will be called every single frame until the zoom animation finishes.
Your pinTypeOnResizeCallback calls ZO_WorldMap_RefreshCustomPinsOfType. The function ZO_WorldMap_RefreshCustomPinsOfType will remove all your pins and then call ZGESO.pinTypeAddCallback to re-create your pins.
Re-creating all your pins every single frame will cause tons of performance issues for you.
Also this is probably also the reason why line 45 is executed so often.

Great insights and info. I'll review all your points. Thanks, Shinni!

Is there a more efficient way to handle pinTypeOnResizeCallback?