Map Pins

skv1991 · 04/25/14, 10:52 AM

Hello everybody, I really want to make my first little AddOn, wich will just show Trunks and Nightshades on Map, I just need a mod.lua(logic) and modData.lua (contain array with coordinates and icon), mod.txt(manifest), and icons folder.

Can you help me?
I read Tutorial on Wiki, but I can't understand how Pins(CustomCompassPins) library works.

I never before work with Lua, but I work with many script languages =)

AddOn name: SKVTrunkMap

SKVTrunkMap.txt

Code:

## Title: SKV1991 Addon
## Version: 0.0.1
## Author: |ca200ffskv1991|r
## APIVersion: 100003
## SavedVariables: SKVTM_SavedVariables
## OptionalDependsOn: CustomCompassPins

Libs/CustomCompassPins/CustomCompassPins.lua

SKVTrunkMap.lua
SKVTrunkMap.xml

SKVTrunkMap.lua

Code:

-------------------------------------------------------------------------------
-- SKVTrunkMap v0.0.1 
-------------------------------------------------------------------------------

if SKVTM == nil then SKVTM = {} end

	
function OnLoad()
	CHAT_SYSTEM:AddMessage("AddOn started")
end

-- slash commands
	SLASH_COMMANDS["/skvtm"] = OnLoad

EVENT_MANAGER:RegisterForEvent("SKVTrunkMap_OnLoad", EVENT_ADD_ON_LOADED, OnLoad)

Custom Compass Pins

Icons

Skvtrunk.dds

Can you explain, how to work with CustomCompassPins and how to add my icons to map?
I don't want to make it like SkyShards map, only icon(s) at specific coordinates.

Help newbie become modder please!

Shinni · 04/25/14, 03:27 PM

that library creates compass pins, not mappins.
this post might help you:
http://www.esoui.com/forums/showpost...10&postcount=2

Garkin · 04/25/14, 04:08 PM

Originally Posted by skv1991

Warning: Spoiler

1) EVENT_ON_ADDON_LOADED is fired for each addon, so you have to check if loaded addon is yours -

Lua Code:

function OnLoad(eventCode, addonName)
    if addonName ~= myaddon then return end
 
    CHAT_SYSTEM:AddMessage("AddOn started")
end

"myaddon" is name of your addon, and it is usualy case-sensitive file name without .lua

2) CustomCompassPins library does not add map pins to the WorldMap, it shows markers on compass.
If you want to add pins to the WorldMap, you should use:

Lua Code:

ZO_WorldMap_AddCustomPin(pinType, pinTypeAddCallback, pinTypeOnResizeCallback, pinLayoutData, pinTooltipCreator)
ZO_WorldMap_SetCustomPinEnabled(_G[pinType], true)
ZO_WorldMap_RefreshCustomPinsOfType(_G[pinType])

where:
pinType = unique string that defines category of your pins

pinTypeAddCallback = function(pinManager) that is called every time when map is changed and should create pins for given area. Example function (CreateMapPins):

Lua Code:

local pinData = {
   ["Auridon"] = {
      { 0.500, 0.500, "Pin1" },
      { 0.250, 0.250, "Pin2" },
   },
   ["Stonefalls"] = {
      { 0.750, 0.750, "Pin3" },
      { 0.320, 0.845, "Pin4" },
   },
}
 
local function CreateMapPins(pinManager)
   local mapname = GetMapName()
 
   if pinData[mapname] == nil then return end
 
   local mydata = pinData[mapname]
 
   for _, pinTag in ipairs(mydata) do
      --pinType is the same string as used in "ZO_WorldMap_AddCustomPin(...)" function
      --pinTag can be anything unique, but it is usefull if it is table that contains information about map pin
      pinManager:CreatePin(_G[pinType], pinTag, pinTag[1], pinTag[2])
   end
end

pinTypeOnResizeCallback = function(pinManager, mapWidth, mapHeight), called every time when map is resized (zoom). Usualy not defined (nil).

pinLayoutData = table that contains:

Lua Code:

pinLayoutData  = {
   level = 40,
   textue = "MyAddon/Icons/pin.dds",
   size = 32,
}
 
--pinLayoutData = {
--   level =  ??    --required and must be >2. Pins with higher level will
--                       be drawn on the top of pins with lower level.
--                       Example:
--                          points of interests = 50,
--                          AvA objectives = 50-100
--                          quests = 110
--                          group members = 130
--                          wayshrine = 140
--                          player = 160
--   texture = ??  --requred, can be string or function. Function can return just a background texture or
--                        background, pulse and glow texture.
--                     --Examples:
--                       "YourAddon/Icons/Icon.dds"
--                       or
--                       function = GetTexture(pin)
--                          local texture1 = "YourAddon/Icons/Icon1.dds"
--                          local texture2 = "YourAddon/Icons/Icon2.dds"
--                          if pin.m_PinTag[3] == "Pin1" then 
--                             return texture1
--                          else
--                             return texture2
--                          end
--                       end
--   size = ??,     --texture will be resized to square size*size. If not
--                       specified, default value is 20.
--                       Examples:
--                          point of interest = 40
--                          quest pins = 32
--                          player = 16
--   insetX = ??,  --size of transparent texture border, used to determine
--   insetY = ??,     if mouse click hits this pin. No need to specify if
--                    you do not plan to handle mouse clicks.
--   minSize = ??, --if not specified, default value is 18.
--   minAreaSize,
--   showsPinAndArea,  --true/false
--   isAnimated,       --true/false
--}

pinTooltipCreator is a table that contains function that creates tooltip and type of tooltip you want to use.

Lua Code:

local pinTooltipCreator = {
    creator = function(pin)
        InformationTooltip:AddLine("This is my tooltip")
    end,
    tooltip = InformationTooltip,
}

For better example code check code of Shinni's HarvestMap or my LoreBooks and SkyShards.

skv1991 · 04/26/14, 03:43 AM

Guys, thank you so much for information! I will use it!

But why I can't see a text in chat, while AddOn is loaded?

txt

Code:

## Title: |cFFFFB0SKVTrunkMap|r 0.0.1 - By |ca200ffSKV1991|r
## Version: 0.0.1
## Author: skv1991
## APIVersion: 100003
## SavedVariables: SKVTM_SavedVariables

Libs/CustomCompassPins/CustomCompassPins.lua

SKVTrunkMap.lua

lua

Lua Code:

-------------------------------------------------------------------------------
-- SKVTrunkMap v0.0.1 
-------------------------------------------------------------------------------
function OnLoad(eventCode, addonName)
    if addonName ~= "SKVTrunkMap" then return end
 
    CHAT_SYSTEM:AddMessage("AddOn started")
end
 
 
EVENT_MANAGER:RegisterForEvent("SKVTrunkMap", EVENT_ADD_ON_LOADED, OnLoad)

In AddOn's menu my mod is active, where I do something wrong? Haha, thats easy but I can't get that

But if I put message in local function and call it using SLASH_COMMANDS, iI recieve message properly, whats wrong with Events?

Here another example

Lua Code:

-------------------------------------------------------------------------------
-- SKVTrunkMap v0.0.1 
-------------------------------------------------------------------------------
if SKVTM == nil then SKVTM = {} end
 
local pinType  = "SKVTMPin";
 
function OnLoad(eventCode, addonName)
    if addonName ~= "SKVTrunkMap" then return end
 
    CHAT_SYSTEM:AddMessage("AddOn started")
end
 
local function MBox(...)
    CHAT_SYSTEM:AddMessage(...)
end
 
local pinData = {
       ["Stonefalls"] = {
          { 0.750, 0.750, "Pin3" },
          { 0.320, 0.845, "Pin4" },
       },
       ["Eastmarch"] = {
          { 0.285, 0.381, "Pin3" },
       },
       ["Windhelm"] = {
          { 0.271, 0.309, "Lol" },
       },
}
 
local function CreateMapPins(pinManager)
   local mapname = GetMapName()
 
   if pinData[mapname] == nil then return end
 
   local mydata = pinData[mapname]
 
   for _, pinTag in ipairs(mydata) do
      --pinType is the same string as used in "ZO_WorldMap_AddCustomPin(...)" function
      --pinTag can be anything unique, but it is usefull if it is table that contains information about map pin
      pinManager:CreatePin(_G[pinType], pinTag, pinTag[1], pinTag[2])
   end
end
 
local pinLayoutData  = {
       level = 40,
       textue = "SKVTrunkMap/Icons/Skvtrunk.dds",
       size = 32, -- Size of icon
}
 
local pinTooltipCreator = {
    creator = function(pin)
        InformationTooltip:AddLine("This is my tooltip")
    end,
    tooltip = InformationTooltip,
}
 
local function myPosition()
    local x, y = GetMapPlayerPosition("player")
    local map = GetMapName()
    local locX = string.format("%03d", zo_round(x*1000))
    local locY = string.format("%03d", zo_round(y*1000))
    MBox(map .. ": " .. locX .. "," .. locY)
end
 
local function DoStuff()
 
    --AddMapPin("SKVTM_Pins", MapCallback, nil, pinLayoutData, pinTooltipCreator)
    
    ZO_WorldMap_AddCustomPin(pinType, pinTypeAddCallback, nil, pinLayoutData, pinTooltipCreator)
    ZO_WorldMap_SetCustomPinEnabled(_G[pinType], true)
    ZO_WorldMap_RefreshCustomPinsOfType(_G[pinType])
    
    if GetMapName() == "Windhelm" then MBox("Added") end
 
end
 
-- slash commands
    SLASH_COMMANDS["/skvmp"] = myPosition
    SLASH_COMMANDS["/skvdo"] = DoStuff
 
EVENT_MANAGER:RegisterForEvent("SKVTrunkMap", EVENT_ADD_ON_LOADED, OnLoad)

When I type /skvdo, I recieve these errors:

Shinni · 04/26/14, 04:10 AM

But why I can't see a text in chat, while AddOn is loaded?

the chat isn't initialized yet. the earliest event with a loaded chat is EVENT_PLAYER_ACTIVATED, if i'm not mistaken.
This event is fired after every loading screen, so you may want to call
EVENT_MANAGER:UnregisterForEvent("addonname", EVENT_PLAYER_ACTIVATED)
in that callback function.

Code:

ZO_WorldMap_AddCustomPin(pinType, pinTypeAddCallback, nil, pinLayoutData, pinTooltipCreator)

replace pinTypeAddCallback with CreateMapPins.

skv1991 · 04/26/14, 04:28 AM

Originally Posted by Shinni

replace pinTypeAddCallback with CreateMapPins.

Yeah, thats working! But map icon looks like white square

mistake in

lua Code:

local pinLayoutData  = {
       level = 40,
       textue = "SKVTrunkMap/Icons/Skvtrunk.dds",
       size = 32, -- Size of icon
}

textue

I replace with texture and all works!

Now I need to add more funcionality and, maybe, compass data =) BIG thanks guys, I will write code here, when I'm done =)