Compass Events

[unLeashed3k]

Is there such a thing as compass events?

I've been desperately attempting to figure out a way to access the compass pins (quests, POI, anything and all) when they appear on the compass but I can not find an event to even begin writing my AddOn. Currently, the only thing I want to do is when a Pin becomes visible on the Compass I want to grab what the pin is (pinType perhaps?) and write it (the name) to the chat panel.

I thought this would be extremely simple being it would fire once (event?) but now several days in I'm just spinning in circles trying to put the puzzle together.

Is there any documentation on COMPASS.container or ZO_WorldMap_IsPinGroupShown? Or better yet is there an event fired when a pin shows on the compass?

[Fyrakin]

Originally Posted by unLeashed3k Is there such a thing as compass events? I've been desperately attempting to figure out a way to access the compass pins (quests, POI, anything and all) when they appear on the compass but I can not find an event to even begin writing my AddOn. Currently, the only thing I want to do is when a Pin becomes visible on the Compass I want to grab what the pin is (pinType perhaps?) and write it (the name) to the chat panel. I thought this would be extremely simple being it would fire once (event?) but now several days in I'm just spinning in circles trying to put the puzzle together. Is there any documentation on COMPASS.container or ZO_WorldMap_IsPinGroupShown? Or better yet is there an event fired when a pin shows on the compass?

Compass usually not all that big, you can query ZO_CompassContainer for children controlls (Compass Pins) and see if it changes.

[unLeashed3k]

Would you be kind enough to show me in simple code sample?

Do I make an <OnUpdate> function and poll the GUI for what's actively displayed?

[Fyrakin]

Originally Posted by unLeashed3k Would you be kind enough to show me in simple code sample? Do I make an <OnUpdate> function and poll the GUI for what's actively displayed?

Best practice would be to make a function to check ZO_CompassContainer
and call that function via registration

EVENT_MANAGER:RegisterForUpdate("OnUpdateSomethingYouMade", [number in miliseconds how often to call your function], [your function name])

[Garkin]

Originally Posted by unLeashed3k Is there such a thing as compass events? I've been desperately attempting to figure out a way to access the compass pins (quests, POI, anything and all) when they appear on the compass but I can not find an event to even begin writing my AddOn. Currently, the only thing I want to do is when a Pin becomes visible on the Compass I want to grab what the pin is (pinType perhaps?) and write it (the name) to the chat panel. I thought this would be extremely simple being it would fire once (event?) but now several days in I'm just spinning in circles trying to put the puzzle together. Is there any documentation on COMPASS.container or ZO_WorldMap_IsPinGroupShown? Or better yet is there an event fired when a pin shows on the compass?

There is no such event...

I was playing around with compass in my test addon Compass Distance (http://www.esoui.com/forums/showthread.php?p=9208).

I don't know if it is the best way, but have hooked OnUpdate function:

ZO_PreHookHandler(COMPASS.container, "OnUpdate", 
   function()
      --do stuff
   end)

And from there I'm calling:

for i = 1, COMPASS.container:GetNumCenterOveredPins() do
   local description, pinType, distance, drawLayer, drawLevel, isSupressed = COMPASS.container:GetCenterOveredPinInfo(i)
      if not isSupressed then
         --do stuff
      end
   end
end

[Fyrakin]

Originally Posted by Garkin There is no such event... I was playing around with compass in my test addon Compass Distance (http://www.esoui.com/forums/showthread.php?p=9208). I don't know if it is the best way, but have hooked OnUpdate function: ZO_PreHookHandler(COMPASS.container, "OnUpdate",    function()       --do stuff    end) And from there I'm calling: for i = 1, COMPASS.container:GetNumCenterOveredPins() do    local description, pinType, distance, drawLayer, drawLevel, isSupressed = COMPASS.container:GetCenterOveredPinInfo(i)       if not isSupressed then          --do stuff       end    end end

That would also work. Just don't forget to return false or compass will not update.

[Garkin]

Originally Posted by Fyrakin That would also work. Just don't forget to return false or compass will not update.

You don't need to return anything, no return value (nil) works the same as if you return false.

[unLeashed3k]

Hopefully I'll figure this out and I appreciate the help.

My final goal, which is incredible simple (not for me apparently ~laughs~), is to output text to a message box <Label> that a "Quest Giver is near," thus why I am looking to find all compass pins then somehow distinguish between MAP_PIN_TYPE_QUEST_OFFER and all_the_rest.

Again, thank you for a starting point and I hope I'll get it some day. =)

[unLeashed3k]

YYZ = {}
 
YYZ.ModName = "ESOunLeashed"
 
 
 
function YYZ.doIt()
    local str = ZO_CompassContainer
    d(string.format("%s", str))
end
 
 
function YYZ.OnAddOnLoaded(event, str)
    if str == YYZ.ModName then
        EVENT_MANAGER:RegisterForUpdate(YYZ.ModName, 1000, YYZ.doIt)
    end
end
 
 
EVENT_MANAGER:RegisterForEvent(YYZ.ModName, EVENT_ADD_ON_LOADED, YYZ.OnAddOnLoaded)

What does ZO_CompassContainer return? My error is something about userdata.