Quantcast
Download
(8 Kb)
Download
Updated: 02/27/20 01:50 PM
Compatibility:
Harrowstorm (5.3.4)
Updated:02/27/20 01:50 PM
Created:02/20/16 11:34 AM
Monthly downloads:63,611
Total downloads:576,526
Favorites:572
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 05/27/20, 11:40 AM  
sirinsidiator
 
sirinsidiator's Avatar
AddOn Author - Click to view AddOns

Forum posts: 1383
File comments: 918
Uploads: 36
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).
__________________
Like what I do? Support me on Patreon!
>siri.exe MyAddon
Does your addon work? [y/n] n
There is a typo in there.
Report comment to moderator  
Reply With Quote
Unread 05/27/20, 11:21 AM  
sjones123

Forum posts: 0
File comments: 4
Uploads: 0
MapPin.lua:1669 attempt to index a nil value

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
Last edited by sjones123 : 05/27/20 at 11:24 AM.
Report comment to moderator  
Reply With Quote
Unread 02/27/20, 02:06 PM  
sirinsidiator
 
sirinsidiator's Avatar
AddOn Author - Click to view AddOns

Forum posts: 1383
File comments: 918
Uploads: 36
The next version will fix all errors. It's still pending, but should be available for download shortly.
__________________
Like what I do? Support me on Patreon!
>siri.exe MyAddon
Does your addon work? [y/n] n
There is a typo in there.
Report comment to moderator  
Reply With Quote
Unread 02/27/20, 01:24 PM  
Micke2nd
AddOn Author - Click to view AddOns

Forum posts: 36
File comments: 76
Uploads: 1
Originally Posted by deljason
I have that installed and MapPing still gives me errors.
did you also activate it ?
Last edited by Micke2nd : 02/27/20 at 01:25 PM.
Report comment to moderator  
Reply With Quote
Unread 02/27/20, 11:44 AM  
deljason
AddOn Author - Click to view AddOns

Forum posts: 9
File comments: 59
Uploads: 1
Originally Posted by Demiknight
Then new version expects that LibDebugLogger is installed, but is not also set as a required dependency. You can install the lib here:

https://www.esoui.com/downloads/info...bugLogger.html
I have that installed and MapPing still gives me errors.
Report comment to moderator  
Reply With Quote
Unread 02/27/20, 10:09 AM  
Majulook

Forum posts: 0
File comments: 64
Uploads: 0
Originally Posted by Demiknight
Then new version expects that LibDebugLogger is installed, but is not also set as a required dependency. You can install the lib here:

https://www.esoui.com/downloads/info...bugLogger.html
Why make it require an addon that is not updated (last update 06/01/19) to the latest game version.
Last edited by Majulook : 02/27/20 at 10:10 AM.
Report comment to moderator  
Reply With Quote
Unread 02/27/20, 08:06 AM  
Demiknight
AddOn Author - Click to view AddOns

Forum posts: 4
File comments: 53
Uploads: 1
Then new version expects that LibDebugLogger is installed, but is not also set as a required dependency. You can install the lib here:

https://www.esoui.com/downloads/info...bugLogger.html
Report comment to moderator  
Reply With Quote
Unread 02/27/20, 08:03 AM  
Baertram
 
Baertram's Avatar
AddOn Author - Click to view AddOns

Forum posts: 2886
File comments: 3477
Uploads: 61
The new version of LibMapPing (r11) is throwing this error when you do not have LibDebugLogger installed. Either you install that, or you use LibMapPing r9 for the time being.
Report comment to moderator  
Reply With Quote
Unread 02/27/20, 07:42 AM  
yRaven

Forum posts: 0
File comments: 3
Uploads: 0
New version is bugged

2 LUA error in the new version, if you guys wanna a fix just ''un-update'' to version 10
Last edited by yRaven : 02/27/20 at 07:43 AM.
Report comment to moderator  
Reply With Quote
Unread 02/27/20, 07:27 AM  
smoothjoe

Forum posts: 0
File comments: 1
Uploads: 0
worked before i updated it now it just is a error
Report comment to moderator  
Reply With Quote
Unread 02/27/20, 01:39 AM  
andy.s
AddOn Author - Click to view AddOns

Forum posts: 5
File comments: 30
Uploads: 5
LibDebugLogger dependency

LibDebugLogger and LibStub are optional dependencies in the manifest file, but the lib doesn't work without both of them (throws nil errors).
Report comment to moderator  
Reply With Quote
Unread 02/27/20, 12:47 AM  
Kr4ftw3rk

Forum posts: 0
File comments: 7
Uploads: 0
A Slew of Error Popups

Had the same errors as the previous posters - but also included problems with:

LIbMapPing
LibGroupSocket
Raidnotifier
LibAsync
VotansMiniMap
HodorReflexes
LibGPS
LibAddonMenu
LibCombat
LibHarvensAddonSettings


I installed LibDebugLogger as mentioned (didn't know I needed it) and that cleared everything up for me. Thnx....
Last edited by Kr4ftw3rk : 02/27/20 at 12:51 AM.
Report comment to moderator  
Reply With Quote
Unread 02/26/20, 11:57 PM  
LarsS

Forum posts: 0
File comments: 12
Uploads: 0
dont work for me after update. Worked Before.
Report comment to moderator  
Reply With Quote
Unread 02/26/20, 08:47 PM  
khaoticfury

Forum posts: 0
File comments: 1
Uploads: 0
Fixed yet?

Has there been a fix yet? Latest update broke things.
Report comment to moderator  
Reply With Quote
Unread 02/26/20, 07:05 PM  
Micke2nd
AddOn Author - Click to view AddOns

Forum posts: 36
File comments: 76
Uploads: 1
Originally Posted by sirinsidiator
LibDebugLogger should actually be specified as a required dependency the way it works right now. The error should go away when you install it.
In my case it looks like too, if exceptions are triggered by LibMapPing.
Installed LibDebugLogger - and yes exceptions are gone. But doesnt this only say exceptions are catched, but not gone ?
Last edited by Micke2nd : 02/27/20 at 02:17 AM.
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.