Quantcast
Download
(8 Kb)
Download
Updated: 02/27/20 01:50 PM
Compatibility:
Harrowstorm (5.3.5)
Updated:02/27/20 01:50 PM
Created:02/20/16 11:34 AM
Monthly downloads:30,073
Total downloads:795,659
Favorites:779
MD5:
LibMapPing  Popular! (More than 5000 hits)
Version: 1.0 r12
by: sirinsidiator, votan
This library is an abstraction for the different types of player set pings on the map. Not to be confused with LibMapPins which handles creation of custom map markers.
The main features include:
  • a unified way to manipulate pings and to react to the ensuing map ping events,
  • suppression of pings so that their information can only be accessed via the library,
  • silent placement of pings,
  • watch dog that fires the callbacks if an event does not get fired by the API due to a bug.

API Reference

MapPingState
MapPingState is an enumeration of the possible states of a map ping.
lib.MAP_PING_NOT_SET: There is no ping.
lib.MAP_PING_NOT_SET_PENDING: The ping has been removed, but EVENT_MAP_PING has not been processed.
lib.MAP_PING_SET_PENDING: A ping was added, but EVENT_MAP_PING has not been processed.
lib.MAP_PING_SET: There is a ping.

SetMapPing
Wrapper for PingMap.
pingType is one of the three possible MapDisplayPinType for map pings (MAP_PIN_TYPE_PLAYER_WAYPOINT, MAP_PIN_TYPE_PING or MAP_PIN_TYPE_RALLY_POINT).
mapType is usually MAP_TYPE_LOCATION_CENTERED.
x and y are the normalized coordinates on the current map.
Code:
lib:SetMapPing(MapDisplayPinType pingType, MapDisplayType mapType, number x, number y)
RemoveMapPing
Wrapper for the different ping removal functions.
For waypoints and rally points it calls their respective removal function.
For group pings it just sets the position to 0, 0 as there is no function to clear them.
Code:
lib:RemoveMapPing(MapDisplayPinType pingType)
GetMapPing
Wrapper for the different get ping functions. Returns coordinates regardless of their suppression state.
The game API functions return 0, 0 when the ping type is suppressed.
pingType is the same as for SetMapPing.
pingTag is optionally used if another group member's MAP_PIN_TYPE_PING should be returned (possible values: group1 .. group24).
Code:
number x, number y = lib:GetMapPing(MapDisplayPinType pingType[, string pingTag])
GetMapPingState
Returns the MapPingState for the pingType and pingTag.
Code:
MapPingState state = lib:GetMapPingState(MapDisplayPinType pingType[, string pingTag])
HasMapPing
Returns true if ping state is lib.MAP_PING_SET_PENDING or lib.MAP_PING_SET.
Code:
boolean hasPing = lib:HasMapPing(MapDisplayPinType pingType[, string pingTag])
RefreshMapPin
Refreshes the pin icon for the pingType on the worldmap.
Returns true if the pin has been refreshed.
Code:
boolean wasRefreshed = lib:RefreshMapPin(MapDisplayPinType pingType[, string pingTag])
IsPositionOnMap
Returns true if the normalized position is within 0 and 1.
Code:
boolean isInside = lib:IsPositionOnMap(number x, number y)
MutePing
Mutes the map ping of the specified type, so it does not make a sound when it is set.
Do not forget to call UnmutePing later, otherwise the sound will be permanently muted!
Code:
lib:MutePing(MapDisplayPinType pingType[, string pingTag])
UnmutePing
Unmutes the map ping of the specified type.
Do not call this more often than you called MutePing, or you might interfere with other addons.
The sounds are played between the BeforePing* and AfterPing* callbacks are fired.
Code:
lib:UnmutePing(MapDisplayPinType pingType[, string pingTag])
IsPingMuted
Returns true if the map ping has been muted.
Code:
boolean isMuted = lib:IsPingMuted(MapDisplayPinType pingType[, string pingTag])
SuppressPing
Suppresses the map ping of the specified type, so that it neither makes a sound nor shows up on the map.
This also makes the API functions return 0, 0 for that ping.
In order to access the actual coordinates lib:GetMapPing has to be used.
Do not forget to call UnsuppressPing later, otherwise map pings won't work anymore for the user and other addons!
Code:
lib:SuppressPing(MapDisplayPinType pingType[, string pingTag])
UnsuppressPing
Unsuppresses the map ping so it shows up again.
Do not call this more often than you called SuppressPing, or you might interfere with other addons.
Code:
lib:UnsuppressPing(MapDisplayPinType pingType[, string pingTag])
IsPingSuppressed
Returns true if the map ping has been suppressed.
Code:
boolean isSuppressed = lib:IsPingSuppressed(MapDisplayPinType pingType[, string pingTag])
RegisterCallback
Register to callbacks from the library.
Valid events are BeforePingAdded, AfterPingAdded, BeforePingRemoved and AfterPingRemoved.
These are fired at certain points during handling EVENT_MAP_PING.
Code:
lib:RegisterCallback(string eventName, function callback)
UnregisterCallback
Unregister from callbacks. See lib:RegisterCallback.
Code:
lib:UnregisterCallback(string eventName, function callback)
BeforePingAdded
This callback is fired in EVENT_MAP_PING before the map ping is processed.
Code:
BeforePingAdded(MapDisplayPinType pingType, string pingTag, number x, number y, boolean isPingOwner)
AfterPingAdded
This callback is fired in EVENT_MAP_PING after the map ping has been processed.
Code:
AfterPingAdded(MapDisplayPinType pingType, string pingTag, number x, number y, boolean isPingOwner)
BeforePingRemoved
This callback is fired in EVENT_MAP_PING before the map ping is processed.
Code:
BeforePingRemoved(MapDisplayPinType pingType, string pingTag, number x, number y, boolean isPingOwner)
AfterPingRemoved
This callback is fired in EVENT_MAP_PING after the map ping has been processed.
Code:
AfterPingRemoved(MapDisplayPinType pingType, string pingTag, number x, number y, boolean isPingOwner)
version 1.0 r12 - sirinsidiator
  • fixed errors when either LibStub or LibDebugLogger is not loaded

version 1.0 r11 - sirinsidiator
  • fixed error when LibStub is loaded

version 1.0 r10 - sirinsidiator
  • switched to LibDebugLogger for debug output
  • removed LibStub and made its usage optional
  • updated API version in manifest

version 1.0 r9 - votan
  • Update to API 100027 "Elsweyr".

version 1.0 r8 - sirinsidiator
  • removed debug output (thanks Sordrak)

version 1.0 r7 - sirinsidiator
  • added protection to drop group pings that would cause a player to get kicked (only relevant when you use LibGroupSocket with many addons that send data)
  • updated API version in manifest

version 1.0 r6 - votan
  • Fixed map ping events can cause wrong waypoint/rally pins in combination with addons changing the current map
  • updated API version in manifest

version 1.0 r5 - sirinsidiator
  • fixed an issue where the initial state of the player waypoint is discarded on ui load in combination with LibGPS
  • updated API version in manifest

version 1.0 r4 - sirinsidiator
  • fixed an error when trying to set a group ping while not in a group
  • added watchdog that fires the callbacks and resets mute and suppress counts when the EVENT_MAP_PING does not get fired by the API in response to a waypoint being set by the player
Optional Files (0)


Archived Files (9)
File Name
Version
Size
Uploader
Date
1.0 r11
8kB
sirinsidiator
02/26/20 04:13 PM
10
8kB
sirinsidiator
02/26/20 03:20 PM
9
9kB
sirinsidiator
05/15/19 01:13 PM
r8
17kB
sirinsidiator
07/03/18 06:54 AM
r7
9kB
sirinsidiator
06/24/18 03:29 AM
r6
9kB
sirinsidiator
11/11/17 07:54 AM
r5
9kB
sirinsidiator
07/14/16 02:45 PM
r4
8kB
sirinsidiator
03/19/16 08:59 AM
r3
8kB
sirinsidiator
02/20/16 11:34 AM


Post A Reply Comment Options
Unread 09/25/20, 02:01 AM  
sirinsidiator
 
sirinsidiator's Avatar
AddOn Author - Click to view AddOns

Forum posts: 1444
File comments: 989
Uploads: 37
Re: Map Popping Up

Originally Posted by Starckle
Hello! I installed this addon because it's a dependency for my other addon, LibGPS (which works for my Zygor leveling addon) ... I wasn't having issues with his addon before but the map keeps popping up randomly and will not go off unless I tap "M" a couple of times to get off. It also comes up during combat, and when I type / press enter after typing. Removing this particular addon fixes the issue but I really need to use Zygor.

Any ideas on what I can do?
This is a library. It doesn't have any functions of its own, but instead gets called by other addons. If you have problems like that, it's highly unlikely a library is at fault, but instead you should start looking at the addons that depend on it. When you disable a library, all addons that depend on it are disabled too, that's why you see the problem going away.
__________________
https://www.imperialtradingcompany.eu/ - My Addons - The Vault (Early updates and experimental projects) - My patreon - My blog
>siri.exe MyAddon
Does your addon work? [y/n] n
There is a typo in there.
Report comment to moderator  
Reply With Quote
Unread 09/24/20, 10:47 PM  
Starckle

Forum posts: 0
File comments: 1
Uploads: 0
Smile Map Popping Up

Hello! I installed this addon because it's a dependency for my other addon, LibGPS (which works for my Zygor leveling addon) ... I wasn't having issues with his addon before but the map keeps popping up randomly and will not go off unless I tap "M" a couple of times to get off. It also comes up during combat, and when I type / press enter after typing. Removing this particular addon fixes the issue but I really need to use Zygor.

Any ideas on what I can do?
Report comment to moderator  
Reply With Quote
Unread 08/17/20, 12:30 PM  
sirinsidiator
 
sirinsidiator's Avatar
AddOn Author - Click to view AddOns

Forum posts: 1444
File comments: 989
Uploads: 37
Originally Posted by zerdax
It still says outdated. Any one managed to get them right?
This library is working fine. You just need to check the "allow outdated" checkbox in the addon menu
__________________
https://www.imperialtradingcompany.eu/ - My Addons - The Vault (Early updates and experimental projects) - My patreon - My blog
>siri.exe MyAddon
Does your addon work? [y/n] n
There is a typo in there.
Report comment to moderator  
Reply With Quote
Unread 08/17/20, 11:15 AM  
zerdax

Forum posts: 0
File comments: 1
Uploads: 0
It still says outdated. Any one managed to get them right?
Report comment to moderator  
Reply With Quote
Unread 07/13/20, 08:40 PM  
TECHHNYNE

Forum posts: 0
File comments: 4
Uploads: 0
its saying libMapPing is missing but i have 3 files in a folder in my addon dir
Report comment to moderator  
Reply With Quote
Unread 07/10/20, 06:47 PM  
vizql

Forum posts: 0
File comments: 1
Uploads: 0
Ive only recently started modding ESO due to playing seriously now, its listed as out-of-date when loading up? I have installed the more recent version.
Report comment to moderator  
Reply With Quote
Unread 07/04/20, 07:13 PM  
DivineHolinessjr

Forum posts: 0
File comments: 1
Uploads: 0
Out Of Date

It's listed as out of date in my menu as of rn in the Add On list
btw, apologies if there's something I'm missing. Quite new to ESO (I've owned the game for a while but only started playing it seriously.)
Last edited by DivineHolinessjr : 07/04/20 at 07:13 PM.
Report comment to moderator  
Reply With Quote
Unread 07/01/20, 03:11 PM  
sirinsidiator
 
sirinsidiator's Avatar
AddOn Author - Click to view AddOns

Forum posts: 1444
File comments: 989
Uploads: 37
Re: obsolete

Originally Posted by weasybeer
obsolete and dont work whit "skyshard" addon
What do you feel makes this obsolete? I've been following the API changes quite closely and there haven't been any functions added which could replace what this library does?
And please elaborate on "dont work whit "skyshard" addon"? What doesn't work? is there an error that points to the library? Otherwise I suggest you ask in the comment section for Skyshards.
__________________
https://www.imperialtradingcompany.eu/ - My Addons - The Vault (Early updates and experimental projects) - My patreon - My blog
>siri.exe MyAddon
Does your addon work? [y/n] n
There is a typo in there.
Report comment to moderator  
Reply With Quote
Unread 07/01/20, 02:54 PM  
Kyoma
AddOn Author - Click to view AddOns

Forum posts: 125
File comments: 316
Uploads: 10
Re: obsolete

Originally Posted by weasybeer
obsolete and dont work whit "skyshard" addon
Wrong and incorrect, user error.
Report comment to moderator  
Reply With Quote
Unread 07/01/20, 02:35 PM  
weasybeer

Forum posts: 0
File comments: 1
Uploads: 0
obsolete

obsolete and dont work whit "skyshard" addon
Report comment to moderator  
Reply With Quote
Unread 06/25/20, 08:25 AM  
sirinsidiator
 
sirinsidiator's Avatar
AddOn Author - Click to view AddOns

Forum posts: 1444
File comments: 989
Uploads: 37
Originally Posted by btk400
Originally Posted by sirinsidiator
Originally Posted by Hermetist
Can we please have this library updated to 6.0.5 (Graymoor)?
Is there something not working with Greymoor?
yep not working
It's working fine for me. You'll have to be a bit more specific, otherwise there is nothing I can do about it.
What exactly is not working? Do you get an error message? Can you show screenshots or a video of what is not working?
You can also install LibDebugLogger if you haven't done so yet and send me your LibDebugLogger.lua saved variable (simply drag the file in, press share on top and send me the link).
__________________
https://www.imperialtradingcompany.eu/ - My Addons - The Vault (Early updates and experimental projects) - My patreon - My blog
>siri.exe MyAddon
Does your addon work? [y/n] n
There is a typo in there.
Report comment to moderator  
Reply With Quote
Unread 06/25/20, 08:05 AM  
btk400

Forum posts: 0
File comments: 1
Uploads: 0
Originally Posted by sirinsidiator
Originally Posted by Hermetist
Can we please have this library updated to 6.0.5 (Graymoor)?
Is there something not working with Greymoor?
yep not working
Report comment to moderator  
Reply With Quote
Unread 06/13/20, 04:34 AM  
sirinsidiator
 
sirinsidiator's Avatar
AddOn Author - Click to view AddOns

Forum posts: 1444
File comments: 989
Uploads: 37
Originally Posted by Hermetist
Can we please have this library updated to 6.0.5 (Graymoor)?
Is there something not working with Greymoor?
__________________
https://www.imperialtradingcompany.eu/ - My Addons - The Vault (Early updates and experimental projects) - My patreon - My blog
>siri.exe MyAddon
Does your addon work? [y/n] n
There is a typo in there.
Report comment to moderator  
Reply With Quote
Unread 06/13/20, 01:56 AM  
Hermetist

Forum posts: 0
File comments: 6
Uploads: 0
Can we please have this library updated to 6.0.5 (Graymoor)?
Report comment to moderator  
Reply With Quote
Unread 05/27/20, 11:40 AM  
sirinsidiator
 
sirinsidiator's Avatar
AddOn Author - Click to view AddOns

Forum posts: 1444
File comments: 989
Uploads: 37
Re: MapPin.lua:1669 attempt to index a nil value

Originally Posted by sjones123
This error message is being sent to the Notification table of Chat at the rate of 1 per sec. There are currently over 3000 of these in the Notification tab of the chat window. This started this morning after last night's ZoS 'maintenance'.
Is there a way to turn this off? Manually deleting them requires clicking in the Notifications window once for each msg.

I'm in Blackreach: Greymore Caverns in the new Greymore area
You are confusing this library for LibMapPin (without the g).
__________________
https://www.imperialtradingcompany.eu/ - My Addons - The Vault (Early updates and experimental projects) - My patreon - My blog
>siri.exe MyAddon
Does your addon work? [y/n] n
There is a typo in there.
Report comment to moderator  
Reply With Quote
Post A Reply



Category Jump:

Support AddOn Development!

You have just downloaded by the author . If you like this AddOn why not consider supporting the author? This author has set up a donation account. Donations ensure that authors can continue to develop useful tools for everyone.