Add support for Team Viewer mod

Author: GyllieGyllie

bukkit-common/src/main/java/net/badlion/bukkitapi/AbstractBukkitBadlionPlugin.java

@@ -3,6 +3,7 @@
 import net.badlion.bukkitapi.cosmetics.CosmeticManager;
 import net.badlion.bukkitapi.listener.PlayerListener;
 import net.badlion.bukkitapi.survival.AbstractBukkitSurvivalManager;
+import net.badlion.bukkitapi.teamviewer.TeamViewerManager;
 import net.badlion.bukkitapi.timers.TimerApi;
 import net.badlion.bukkitapi.timers.TimerApiImpl;
 import net.badlion.bukkitapi.waypoints.WaypointManager;
@@ -27,6 +28,7 @@ public AbstractBukkitBadlionPlugin() {
 		this.badlionApi.setWaypointManager(this.waypointManager);
 		this.cosmeticManager = new CosmeticManager();
 		this.badlionApi.setCosmeticManager(this.cosmeticManager);
+		this.badlionApi.setTeamViewerManager(new TeamViewerManager(this));
 	}
 
 	protected void setMessageSender(AbstractBukkitPluginMessageSender messageSender) {

bukkit-common/src/main/java/net/badlion/bukkitapi/teamviewer/TeamViewerManager.java

@@ -0,0 +1,24 @@
+package net.badlion.bukkitapi.teamviewer;
+
+import net.badlion.bukkitapi.AbstractBukkitBadlionPlugin;
+import net.badlion.modapicommon.AbstractBadlionApi;
+import net.badlion.modapicommon.mods.ModType;
+import net.badlion.modapicommon.utility.AbstractTeamViewerManager;
+import net.badlion.modapicommon.utility.TeamMemberLocation;
+
+import java.util.List;
+import java.util.UUID;
+
+public class TeamViewerManager extends AbstractTeamViewerManager {
+
+	private final AbstractBukkitBadlionPlugin apiBukkit;
+
+	public TeamViewerManager(AbstractBukkitBadlionPlugin apiBukkit) {
+		this.apiBukkit = apiBukkit;
+	}
+
+	@Override
+	public void sendLocations(UUID player, List<TeamMemberLocation> locations) {
+		this.apiBukkit.getMessageSender().sendModData(player, ModType.TEAM_VIEWER, AbstractBadlionApi.GSON_NON_PRETTY.toJsonTree(locations));
+	}
+}

bungee/src/main/java/net/badlion/bungeeapi/BungeeBadlionPlugin.java

@@ -3,6 +3,7 @@
 import net.badlion.bungeeapi.cosmetics.UnsupportedCosmeticManager;
 import net.badlion.bungeeapi.listener.PlayerListener;
 import net.badlion.bungeeapi.survival.UnsupportedSurvivalManager;
+import net.badlion.bungeeapi.teamviewer.UnsupportedTeamViewerManager;
 import net.badlion.bungeeapi.waypoints.UnsupportedWaypointManager;
 import net.md_5.bungee.api.plugin.Plugin;
 
@@ -21,6 +22,7 @@ public BungeeBadlionPlugin() {
 		this.badlionApi.setWaypointManager(new UnsupportedWaypointManager());
 		this.badlionApi.setCosmeticManager(new UnsupportedCosmeticManager());
 		this.badlionApi.setSurvivalManager(new UnsupportedSurvivalManager());
+		this.badlionApi.setTeamViewerManager(new UnsupportedTeamViewerManager());
 	}
 
 	@Override

bungee/src/main/java/net/badlion/bungeeapi/teamviewer/UnsupportedTeamViewerManager.java

@@ -0,0 +1,17 @@
+package net.badlion.bungeeapi.teamviewer;
+
+import net.badlion.modapicommon.utility.AbstractTeamViewerManager;
+import net.badlion.modapicommon.utility.AbstractWaypoint;
+import net.badlion.modapicommon.utility.AbstractWaypointManager;
+import net.badlion.modapicommon.utility.TeamMemberLocation;
+
+import java.util.List;
+import java.util.UUID;
+
+public class UnsupportedTeamViewerManager extends AbstractTeamViewerManager {
+
+	@Override
+	public void sendLocations(UUID player, List<TeamMemberLocation> locations) {
+		throw new UnsupportedOperationException("Team Viewer mod hooks are not supported on bungee!");
+	}
+}

examples.md

@@ -5,6 +5,7 @@ Below are some examples of how you could hook into our mods using this API.
 * [Waypoints](https://github.com/BadlionClient/BadlionClientModAPI/blob/master/examples.md#waypoints)
 * [TNT Time](https://github.com/BadlionClient/BadlionClientModAPI/blob/master/examples.md#tnt-time)
 * [Height Limit Overlay](https://github.com/BadlionClient/BadlionClientModAPI/blob/master/examples.md#height-limit-overlay)
+* [Team Viewer](https://github.com/BadlionClient/BadlionClientModAPI/blob/master/examples.md#team-viewer)
 * [Notifications](https://github.com/BadlionClient/BadlionClientModAPI/blob/master/examples.md#notifications)
   * [Click Event Types](https://github.com/BadlionClient/BadlionClientModAPI/blob/master/examples.md#click-event-types)
   * [Levels](https://github.com/BadlionClient/BadlionClientModAPI/blob/master/examples.md#levels)
@@ -143,6 +144,57 @@ public class Game {
 }
 ```
 
+## Team Viewer
+
+Using the `net.badlion.modapicommon.mods.TeamViewer` class you can send a list of team members and their locations to
+the player and support the team viewer icon to be shown.
+
+```java
+// Since we need to send the locations on a regular basis to update the locations it's best to put the logic in a task
+// We recommend running it faster than 3 seconds since the client removes the locations after 5 seconds of no updates
+public class TeamViewerTask extends BukkitRunnable {
+
+  @Override
+  public void run() {
+
+    // This is just an example, there may be other ways you keep track of teams
+    TeamManager teamManager = Plugin.getTeamManager();
+
+    // Loop over all teams to update the locations
+    for (Team team : teamManager.getTeams()) {
+
+      List<TeamMemberLocation> locations = new ArrayList<>();
+
+      // First we loop over all players in this team
+      // We do not need to worry about having the player receiving it being in the list too since the client ignored that location
+      for (Player player : team.getMembers()) {
+
+        Location location = player.getLocation();
+
+        // Add the location for this member into the list
+        locations.add(
+                new TeamMemberLocation(
+                        player.getUniqueId(),
+                        team.getColor(), // This color has to be the in Hex value, can be different for each player
+                        location.getX(),
+                        location.getY(),
+                        location.getZ()
+                )
+        );
+
+      }
+
+      // Loop over all the players again and send the list
+      for (Player player : team.getMembers()) {
+
+        TeamViewer.sendLocations(player.getUniqueId(), locations);
+
+      }
+    }
+  }
+}
+```
+
 
 ## Notifications
 

modapi-common/src/main/java/net/badlion/modapicommon/AbstractBadlionApi.java

@@ -4,6 +4,7 @@
 import com.google.gson.GsonBuilder;
 import net.badlion.modapicommon.survival.AbstractSurvivalManager;
 import net.badlion.modapicommon.utility.AbstractCosmeticManager;
+import net.badlion.modapicommon.utility.AbstractTeamViewerManager;
 import net.badlion.modapicommon.utility.AbstractWaypointManager;
 
 import java.io.File;
@@ -18,6 +19,7 @@ public abstract class AbstractBadlionApi {
 	private AbstractWaypointManager waypointManager;
 	private AbstractCosmeticManager cosmeticManager;
 	private AbstractSurvivalManager survivalManager;
+	private AbstractTeamViewerManager teamViewerManager;
 
 	protected AbstractBadlionApi() {
 		AbstractBadlionApi.instance = this;
@@ -107,6 +109,24 @@ public AbstractSurvivalManager getSurvivalManager() {
 		return this.survivalManager;
 	}
 
+	/**
+	 * Sets the implementation for the {@link AbstractTeamViewerManager} class.
+	 *
+	 * @param teamViewerManager The team viewer manager instance
+	 */
+	public void setTeamViewerManager(AbstractTeamViewerManager teamViewerManager) {
+		this.teamViewerManager = teamViewerManager;
+	}
+
+	/**
+	 * Returns the implementation for the {@link AbstractTeamViewerManager} class.
+	 *
+	 * @return The team viewer manager instance
+	 */
+	public AbstractTeamViewerManager getTeamViewerManager() {
+		return this.teamViewerManager;
+	}
+
 	/**
 	 * Returns the Badlion Api instance.
 	 *

modapi-common/src/main/java/net/badlion/modapicommon/mods/ModType.java

@@ -6,7 +6,8 @@ public enum ModType {
 	WAYPOINTS("waypoints"),
 	TNT_TIME("tntTime"),
 	NOTIFICATION("notification"),
-	SURVIVAL("survival");
+	SURVIVAL("survival"),
+	TEAM_VIEWER("teamViewer");
 
 	private final String type;
 

modapi-common/src/main/java/net/badlion/modapicommon/mods/TeamViewer.java

@@ -0,0 +1,26 @@
+package net.badlion.modapicommon.mods;
+
+import net.badlion.modapicommon.AbstractBadlionApi;
+import net.badlion.modapicommon.utility.TeamMemberLocation;
+
+import java.util.List;
+import java.util.UUID;
+
+/**
+ * Class with API Hooks for our Team Viewer mod.
+ */
+public class TeamViewer {
+
+	/**
+	 * Update the team member locations. You always need to send all the locations that should be showing as on each call old points will be deleted
+	 *
+	 * The client automatically removes locations that weren't updated for 5 seconds, so we recommend sending the updates faster than this.
+	 * If the team member can be tracked by the client it will also automatically update the location but above timeout still applies.
+	 *
+	 * @param player UUID from the player who should be receiving this
+	 * @param locations List of team member locations to show
+	 */
+	public static void sendLocations(UUID player, List<TeamMemberLocation> locations) {
+		AbstractBadlionApi.getInstance().getTeamViewerManager().sendLocations(player, locations);
+	}
+}

modapi-common/src/main/java/net/badlion/modapicommon/utility/AbstractTeamViewerManager.java

@@ -0,0 +1,10 @@
+package net.badlion.modapicommon.utility;
+
+import java.util.List;
+import java.util.UUID;
+
+public abstract class AbstractTeamViewerManager {
+
+	public abstract void sendLocations(UUID player, List<TeamMemberLocation> locations);
+
+}

modapi-common/src/main/java/net/badlion/modapicommon/utility/TeamMemberLocation.java

@@ -0,0 +1,20 @@
+package net.badlion.modapicommon.utility;
+
+import java.util.UUID;
+
+public class TeamMemberLocation {
+
+	private final UUID uuid;
+	private final int color;
+	private final double x;
+	private final double y;
+	private final double z;
+
+	public TeamMemberLocation(UUID uuid, int color, double x, double y, double z) {
+		this.uuid = uuid;
+		this.color = color;
+		this.x = x;
+		this.y = y;
+		this.z = z;
+	}
+}