CustomCompassPins: What am I doing wrong?

SnowmanDK · 04/26/15, 03:59 PM

I am trying to add color to my compass pins, to accomodate my recent changes to Destinations.

I would have thought I should do somthing like this (by adding additionalLayout):

Lua Code:

local pinLayout_QuestsDone = {
    maxDistance = savedVariables.pinTextureQuestsDone.maxDistance,
    level = savedVariables.pinTextureQuestsDone.level,
    texture = pinTextures.Quests[savedVariables.pinTextureQuestsDone.type],
    size = savedVariables.pinTextureQuestsDone.size,
    tint = ZO_ColorDef:New(unpack(savedVariables.pinTextureQuestsDone.tint)),
    additionalLayout = {
        function(pin)
            pin:GetNamedChild("Background"):SetColor(unpack(savedVariables.pinTextureQuestsDone.tint))
        end,
    },
}
 
LMP:AddPinType(PINS_QUESTS_DONE, Quests_Done_pinTypeCallback, nil, pinLayout_QuestsDone, pinTooltipCreator)
COMPASS_PINS:AddCustomPin(PINS_QUESTS_DONE, Quests_CompassPins, pinLayout_QuestsDone)
COMPASS_PINS:RefreshPins(PINS_QUESTS_DONE)

but it generates this:

Code:

user:/AddOns/SkyShards/Libs/CustomCompassPins/CustomCompassPins.lua:227: function expected instead of nil
stack traceback:
	user:/AddOns/SkyShards/Libs/CustomCompassPins/CustomCompassPins.lua:227: in function 'CompassPinManager:ResetPin'
	user:/AddOns/SkyShards/Libs/CustomCompassPins/CustomCompassPins.lua:178: in function 'CompassPinManager:GetNewPin'
	user:/AddOns/SkyShards/Libs/CustomCompassPins/CustomCompassPins.lua:252: in function 'CompassPinManager:Update'
	user:/AddOns/SkyShards/Libs/CustomCompassPins/CustomCompassPins.lua:158: in function 'COMPASS_PINS:Update'
	user:/AddOns/SkyShards/Libs/CustomCompassPins/CustomCompassPins.lua:41: in function '(anonymous)'

I just KNOW it's my additionalLayout that fails. I even tried to look at how other addons do it, but can't find the difference.
I am probably just overlooking something...

**Baertram** · 04/26/15, 04:25 PM

Lua Code:

function CompassPinManager:ResetPin(pin)
   for _, layout in pairs(COMPASS_PINS.pinLayouts) do
      if layout.additionalLayout then
         layout.additionalLayout[2](pin)
      end
   end
end

COMPASS_PINS.pinLayouts should be for your current case COMPASS_PINS["PINS_QUESTS_DONE"] I think?

The ResetPin(pin) function tries to call the layout callback function that you have defined beyond "pinLayout_QuestsDone.additionalLayout" at index [2].
But there does not seeem to be an index [2] in your definition.

I think you need to define it like this then:

Lua Code:

local pinLayout_QuestsDone = {
    maxDistance = savedVariables.pinTextureQuestsDone.maxDistance,
    level = savedVariables.pinTextureQuestsDone.level,
    texture = pinTextures.Quests[savedVariables.pinTextureQuestsDone.type],
    size = savedVariables.pinTextureQuestsDone.size,
    tint = ZO_ColorDef:New(unpack(savedVariables.pinTextureQuestsDone.tint)),
    additionalLayout = {
"Hello World for index 1", 
        function(pin)
            pin:GetNamedChild("Background"):SetColor(unpack(savedVariables.pinTextureQuestsDone.tint))
        end -- index 2 now,
    },
}

EDIT:
I just saw that in the function CompassPinManager:Update() there is another call to the addiitonal layouts and there is used the index [1]:

Lua Code:

if layout.additionalLayout then
                  layout.additionalLayout[1](pin, angle, normalizedAngle, normalizedDistance)
               end

So index [1] seems to be a function too, with the parameters pin, angle, normalizedAngle, normalizedDistance

SnowmanDK · 04/26/15, 05:17 PM

The odd thing is Garkin makes it work without reference to any index. This is a copy directly from "PublicDungeonChampions":

Lua Code:

additionalLayout = {
         function(pin)
            if savedVariables.pinTexture.type == 1 then
               pin:GetNamedChild("Background"):SetColor(unpack(savedVariables.incompleteColor))
            end
         end,
         function(pin)
            pin:GetNamedChild("Background"):SetColor(1,1,1,1)
         end,
      },

I tried doing as he does:

Lua Code:

additionalLayout = {
         function(pin)
            pin:GetNamedChild("Background"):SetColor(unpack(savedVariables.pinTextureQuestsDone.tint))
         end,
         function(pin)
            pin:GetNamedChild("Background"):SetColor(1,1,1,1)
         end,
      },

but that fails too.

Originally Posted by Baertram

Lua Code:

function CompassPinManager:ResetPin(pin)
   for _, layout in pairs(COMPASS_PINS.pinLayouts) do
      if layout.additionalLayout then
         layout.additionalLayout[2](pin)
      end
   end
end

COMPASS_PINS.pinLayouts should be for your current case COMPASS_PINS["PINS_QUESTS_DONE"] I think?

The ResetPin(pin) function tries to call the layout callback function that you have defined beyond "pinLayout_QuestsDone.additionalLayout" at index [2].
But there does not seeem to be an index [2] in your definition.

I think you need to define it like this then:

Lua Code:

local pinLayout_QuestsDone = {
    maxDistance = savedVariables.pinTextureQuestsDone.maxDistance,
    level = savedVariables.pinTextureQuestsDone.level,
    texture = pinTextures.Quests[savedVariables.pinTextureQuestsDone.type],
    size = savedVariables.pinTextureQuestsDone.size,
    tint = ZO_ColorDef:New(unpack(savedVariables.pinTextureQuestsDone.tint)),
    additionalLayout = {
"Hello World for index 1", 
        function(pin)
            pin:GetNamedChild("Background"):SetColor(unpack(savedVariables.pinTextureQuestsDone.tint))
        end -- index 2 now,
    },
}

EDIT:
I just saw that in the function CompassPinManager:Update() there is another call to the addiitonal layouts and there is used the index [1]:

Lua Code:

if layout.additionalLayout then
                  layout.additionalLayout[1](pin, angle, normalizedAngle, normalizedDistance)
               end

So index [1] seems to be a function too, with the parameters pin, angle, normalizedAngle, normalizedDistance

Garkin · 04/26/15, 05:52 PM

Library description says:

The layout table
The layout table must have the following keys:
maxDistance the maximal distance (in normalized map units) for the pin to be visible (it will slowly fade out, when the pin gets close to the maxDistance)
texture the filepath to the texture

optional keys:
FOV the field of view in radians. eg 2pi will result in the pin being always visible, pi means the pin is visible as long it is not behind the player.
sizeCallback a function which receives the pin, the angle between the player and the pin, the normalized angle (-1 = left border of the compass, 1 = right border of the compass, 0 = center of the compass), normalizedDistance (0 = same position as player, 1 = pin is at maxDistance)
This function can modify the size of the pin via pin:SetDimension(width, height)
If no function is given, the pin has a size of 32x32 and will become smaller if abs(normalizedAngle) > 0.25
additionalLayout another table with 2 components, each one needs to be a function.
The first one receives the same parameters as the sizeCallback function. It can be used to implement additional visual effects. eg: you could do something like pin:SetColor(1,0,0,1) to make the pin red.
The second function receives only a pin as parameter. As the pins are pooled (saved to be used again), the additional modifications of the pin need to be cleared again. So in the previous example this function should call pin:SetColor(1,1,1,1) to make the pin white again.

So what you are doing wrong is that your "additionalLayout" table doesn't contain two functions (set function/reset function)

Originally Posted by SnowmanDK

The odd thing is Garkin makes it work without reference to any index. This is a copy directly from "PublicDungeonChampions":

Array is indexed automatically, so you can use both definitions to get the same array:

Lua Code:

local array = {
    function() end,
    function() end,
}
 
local array = {
    [1] = function() end,
    [2] = function() end,
}

SnowmanDK · 04/27/15, 01:48 PM

Thanks for the replies

I was sure I tried it, but I guess I made some mistake...
This is the solution (using my first code example as template):

Lua Code:

local pinLayout_QuestsDone = {
    maxDistance = savedVariables.pinTextureQuestsDone.maxDistance,
    level = savedVariables.pinTextureQuestsDone.level,
    texture = pinTextures.Quests[savedVariables.pinTextureQuestsDone.type],
    size = savedVariables.pinTextureQuestsDone.size,
    tint = ZO_ColorDef:New(unpack(savedVariables.pinTextureQuestsDone.tint)),
    additionalLayout = {
        function(pin)
            pin:GetNamedChild("Background"):SetColor(unpack(savedVariables.pinTextureQuestsDone.tint))
        end,
        function(pin)
            pin:GetNamedChild("Background"):SetColor(1,1,1,1)
        end,
    },
}
 
LMP:AddPinType(PINS_QUESTS_DONE, Quests_Done_pinTypeCallback, nil, pinLayout_QuestsDone, pinTooltipCreator)
COMPASS_PINS:AddCustomPin(PINS_QUESTS_DONE, Quests_CompassPins, pinLayout_QuestsDone)
COMPASS_PINS:RefreshPins(PINS_QUESTS_DONE)

Case closed