add LGB as non optional dependency and remove legacy features after U46

Author: m00nyONE

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2024.03.14 - @m00nyONE
+- add LibGroupBroadcast as dependency
+- LibDataShare will still work with map pings until U46 arrives and then auto switch to compatibility mode for everyone!
+  - this is to avoid incompatibilities between players who have LGB installed and those who do not
+
 ## 2024.02.10 - @m00nyONE
 - introducing compatibility layer to LibGroupBroadcast
 - fix handler bleeding to global

LibDataShare.lua

@@ -475,37 +475,7 @@ end
 
 --------------------------------------------------------------------------
 
-local function OnPlayerActivated()
-	-- EOL detection
-
-	if ApiVersion >= 101046 then
-		if WorldName ~= "PTS" then
-			zo_callLater(function()
-				d("|cFF00FFWarning: 'LibDataShare' is now disabled due to API restrictions in Update 46. The MapPing API only allows one ping every 10 seconds, and this library is no longer functional. Please uninstall it to avoid seeing this message.|r")
-			end, 5000)
-
-			-- remove functionality of the addon completely by overwriting all functions of the Library
-			MapHandler.QueueData = function() end
-			MapHandler.SendData = function() end
-			lib.PrepareMap = function() return false end
-			lib.IsEnabled = function() return false end
-			lib.GetMapPing = function() return 0, 0 end
-			lib.SetMapPing = function() end
-			lib.ResolveConflicts = function() end
-			OnMapPing = function() end
-			MapStateChange = function() end
-
-			return -- exit Initialize function here to not load the OnPlayerActivated function
-		end
-
-
-		-- set the ping rate to every 10seconds because of API changes in U46
-		PING_RATE = 10200
-		zo_callLater(function()
-			d("|cFF00FFImportant: Please remove 'LibDataShare' from your add-ons! The MapPing API has been rate-limited in Update 46, allowing only one ping every 10 seconds. Continuing to use this library may result in being kicked from the server.|r")
-		end, 5000)
-	end
-
+local function Legacy_MapPing_OnPlayerActivated()
 	-- Unregister map ping handler.
 	EM:UnregisterForEvent(NAME, EVENT_MAP_PING)
 
@@ -529,18 +499,20 @@ local function OnPlayerActivated()
 end
 
 local function Initialize()
-	if not LGB then
-		-- run without compatibility layer
-		EM:RegisterForEvent(NAME, EVENT_PLAYER_ACTIVATED, OnPlayerActivated)
+
+	if ApiVersion >= 101046 then
+		-- create compatibility layer
+		DeclareLGBProtocols()
+		overwriteLibFunctions()
+		overwriteMapHandlerFunctions()
+		registerSendQueuedMessages()
+		d("LibDataShare compatibility mode initiated")
+
 		return
 	end
 
-	-- create compatibility layer
-	DeclareLGBProtocols()
-	overwriteLibFunctions()
-	overwriteMapHandlerFunctions()
-	registerSendQueuedMessages()
-	d("LibDataShare compatibility mode initiated")
+	-- run without compatibility layer
+	EM:RegisterForEvent(NAME, EVENT_PLAYER_ACTIVATED, Legacy_MapPing_OnPlayerActivated)
 
 end
 

LibDataShare.txt

@@ -9,7 +9,8 @@
 ## Version: dev
 ## AddOnVersion: 99999999
 ## APIVersion: 101044 101045
-## OptionalDependsOn: LibMapPing RaidNotifier BanditsUserInterface FoundryTacticalCombat TaosGroupTools POC LibGroupSocket LibGroupBroadcast
+## OptionalDependsOn: LibMapPing RaidNotifier BanditsUserInterface FoundryTacticalCombat TaosGroupTools POC LibGroupSocket
+## DependsOn: LibGroupBroadcast>=88
 ## IsLibrary: true
 ## Description: Deprecated Library for sharing small amounts of data between group members. Originally created for HodorReflexes. Please use LibGroupBroadcast after U45 instead of this Library.