ESOUI - [implemented] ZO_WorldMap

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

- Wish List (https://www.esoui.com/forums/forumdisplay.php?f=177)

- - [implemented] ZO_WorldMap_SetMapById() (https://www.esoui.com/forums/showthread.php?t=9734)

[implemented] ZO_WorldMap_SetMapById()

Many maps don't have a map index but it looks like all maps have a map ID so :

ZO_WorldMap_SetMapById()

would be of a great help for map / navigation AddOns
e. g. my QuickMapNav AddOn.

There exists the api function SetMapToMapId(mapId), so you could just call the following

Lua Code:

if SetMapToMapId(mapId) == SET_MAP_RESULT_MAP_CHANGED then
    CALLBACK_MANAGER:FireCallbacks("OnWorldMapChanged")
end

Wow! Thanks I totally missed that! :banana:

I added it to the Wiki :
https://wiki.esoui.com/SetMapToMapId
:)

There is a SetMapToMapId. However, unless the user changes the map manually first, the map will reset to the on map open default after SetMapToMapId is used. Making it almost useless.

I've proposed this.

Lua Code:

function ZO_WorldMap_SetMapById(mapId)
    if WORLD_MAP_MANAGER:IsMapChangingAllowed() then
        if SetMapToMapId(mapId) == SET_MAP_RESULT_MAP_CHANGED then
            g_playerChoseCurrentMap = true
            CALLBACK_MANAGER:FireCallbacks("OnWorldMapChanged")
        end
    end
end

You see, the g_playerChoseCurrentMap must be true in order for the map to not be reset.

Lua Code:

function Update(map, currentTimeS)
        -- ... in short
 
            -- If the player is just wandering around the world, with their map open, then refresh it every so often so that
            -- it's showing the appropriate location for where they are.  If they actually picked a loction, then avoid this update.
            if not g_playerChoseCurrentMap then
                if SetMapToPlayerLocation() == SET_MAP_RESULT_MAP_CHANGED then

The alternative is to:

Lua Code:

local original_CALLBACK_MANAGER = CALLBACK_MANAGER
local function setMapById(mapId)
    -- lets prevent the callback from firing when we only want to set g_playerChoseCurrentMap to true
    CALLBACK_MANAGER = {FireCallbacks = function() end}
 
    -- Lets fire this so it will set g_playerChoseCurrentMap to true
    ZO_WorldMap_SetMapByIndex(1)
    
    -- Now reset the callback manager
    CALLBACK_MANAGER = original_CALLBACK_MANAGER
    
    -- Set map by mapId and fire callback
    if SetMapToMapId(mapId) == SET_MAP_RESULT_MAP_CHANGED then
        CALLBACK_MANAGER:FireCallbacks("OnWorldMapChanged")
    end
end

Or do things a better way and use what is already available which will be more compatible with other mods.

Code:

  local GPS = LibGPS3

  SetMapToMapId(mapId)

  GPS:SetPlayerChoseCurrentMap()

  CALLBACK_MANAGER:FireCallbacks("OnWorldMapChanged")

This can be closed.
WORLD_MAP_MANAGER:SetMapById(mapId) exists now

Closed and updated the Wiki