Code Admin Scan Players command

[Trance]

Hi,

 

Admin command, scans a specified range around the admin. It gathers about players within the specified range, including their clan names, party leaders, and class names. Counting all players around can be a helpful task for admins.

You could limit the scanning to players within the same region or zone as the admin - this would reduce the number of players to be processed and improve performance.

 

Index: /main/L2GoldClassic/dist/game/config/AdminCommands.xml
===================================================================
--- /main/L2GoldClassic/dist/game/config/AdminCommands.xml	(revision 26)
+++ /main/L2GoldClassic/dist/game/config/AdminCommands.xml	(revision 27)
@@ -626,4 +626,5 @@
 	<admin command="admin_scan" accessLevel="100" />
 	<admin command="admin_deleteNpcByObjectId" accessLevel="100" confirmDlg="true" />
+	<admin command="admin_scan_players" accessLevel="50" />
 
 	<!-- ADMIN SERVERINFO -->
Index: /main/L2GoldClassic/dist/game/data/scripts/handlers/MasterHandler.java
===================================================================
--- /main/L2GoldClassic/dist/game/data/scripts/handlers/MasterHandler.java	(revision 26)
+++ /main/L2GoldClassic/dist/game/data/scripts/handlers/MasterHandler.java	(revision 27)
@@ -124,4 +124,5 @@
 import handlers.admincommandhandlers.AdminRide;
 import handlers.admincommandhandlers.AdminScan;
+import handlers.admincommandhandlers.AdminScanPlayers;
 import handlers.admincommandhandlers.AdminServerInfo;
 import handlers.admincommandhandlers.AdminShop;
@@ -463,4 +464,5 @@
 			AdminRide.class,
 			AdminScan.class,
+			AdminScanPlayers.class,
 			AdminServerInfo.class,
 			AdminShop.class,
Index: /main/L2GoldClassic/dist/game/data/scripts/handlers/admincommandhandlers/AdminScanPlayers.java
===================================================================
--- /main/L2GoldClassic/dist/game/data/scripts/handlers/admincommandhandlers/AdminScanPlayers.java	(revision 27)
+++ /main/L2GoldClassic/dist/game/data/scripts/handlers/admincommandhandlers/AdminScanPlayers.java	(revision 27)
@@ -0,0 +1,134 @@
+/*
+ * This file is part of the L2Gold Classic project.
+ * 
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+package handlers.admincommandhandlers;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import gold.lineage2.gameserver.data.sql.ClanTable;
+import gold.lineage2.gameserver.handler.IAdminCommandHandler;
+import gold.lineage2.gameserver.model.Location;
+import gold.lineage2.gameserver.model.World;
+import gold.lineage2.gameserver.model.actor.instance.PlayerInstance;
+import gold.lineage2.gameserver.model.clan.Clan;
+import gold.lineage2.gameserver.util.Util;
+
+/**
+ * @author Trance
+ */
+public class AdminScanPlayers implements IAdminCommandHandler
+{
+	private static final String[] ADMIN_COMMANDS =
+	{
+		"admin_scan_players"
+	};
+	
+	@Override
+	public boolean useAdminCommand(String command, PlayerInstance player)
+	{
+		if (command.startsWith("admin_scan_players"))
+		{
+			String[] args = command.split(" ");
+			if (args.length > 1)
+			{
+				String rangeStr = args[1];
+				scanPlayers(player, rangeStr);
+			}
+			else
+			{
+				player.sendMessage("Usage: //admin_scan_players <range>");
+			}
+		}
+		return true;
+	}
+	
+	private void scanPlayers(PlayerInstance player, String rangeStr)
+	{
+		// Parse the range from the command arguments
+		int range = Util.parseNextInt(rangeStr, 0);
+		
+		// Get the player's location
+		Location playerLocation = player.getLocation();
+		
+		// Initialize data structures for storing the scan results
+		Map<String, Set<String>> clanMembers = new HashMap<>();
+		Map<String, Set<String>> partyMembers = new HashMap<>();
+		Map<String, List<String>> classMembers = new HashMap<>();
+		
+		// Iterate through all players in the game world
+		for (PlayerInstance otherPlayer : World.getInstance().getPlayers())
+		{
+			// Check if the other player is within the specified range of the player
+			if (playerLocation.distanceTo(otherPlayer.getLocation()) <= range)
+			{
+				// Gather data for clans, parties, and classes
+				String clanName = otherPlayer.getClan() != null ? otherPlayer.getClan().getName() : "No Clan";
+				String partyLeaderName = otherPlayer.getParty() != null ? otherPlayer.getParty().getLeader().getName() : null;
+				String className = otherPlayer.getTemplate().getClassId().name();
+				
+				// Update the player lists for clans, parties, and classes
+				clanMembers.computeIfAbsent(clanName, k -> new HashSet<>()).add(otherPlayer.getName());
+				if (partyLeaderName != null)
+				{
+					partyMembers.computeIfAbsent(partyLeaderName, k -> new HashSet<>()).add(otherPlayer.getName());
+				}
+				classMembers.computeIfAbsent(className, k -> new ArrayList<>()).add(otherPlayer.getName());
+			}
+		}
+		
+		// Display the scan results to the player
+		player.sendMessage("Scan Results:");
+		player.sendMessage("Range: " + range);
+		player.sendMessage("Clans (" + clanMembers.size() + "):");
+		for (Map.Entry<String, Set<String>> entry : clanMembers.entrySet())
+		{
+			String clanLeaderName = "Unknown";
+			Clan clan = ClanTable.getInstance().getClanByName(entry.getKey());
+			if (clan != null)
+			{
+				PlayerInstance clanLeader = World.getInstance().getPlayer(clan.getLeaderId());
+				if (clanLeader != null)
+				{
+					clanLeaderName = clanLeader.getName();
+				}
+			}
+			player.sendMessage(" - " + entry.getKey() + " (Leader: " + clanLeaderName + "): " + entry.getValue().size() + " members");
+			player.sendMessage("   Members: " + String.join(", ", entry.getValue()));
+		}
+		player.sendMessage("Parties (" + partyMembers.size() + "):");
+		for (Map.Entry<String, Set<String>> entry : partyMembers.entrySet())
+		{
+			player.sendMessage(" - Leader: " + entry.getKey() + ", " + entry.getValue().size() + " members");
+			player.sendMessage("   Members: " + String.join(", ", entry.getValue()));
+		}
+		player.sendMessage("Classes (" + classMembers.size() + "):");
+		for (Map.Entry<String, List<String>> entry : classMembers.entrySet())
+		{
+			player.sendMessage(" - " + entry.getKey() + ": " + entry.getValue().size() + " players " + entry.getValue().stream().collect(Collectors.joining(", ", "(", ")")));
+		}
+	}
+	
+	@Override
+	public String[] getAdminCommandList()
+	{
+		return ADMIN_COMMANDS;
+	}
+}
Index: /main/L2GoldClassic/java/gold/lineage2/gameserver/model/Location.java
===================================================================
--- /main/L2GoldClassic/java/gold/lineage2/gameserver/model/Location.java	(revision 26)
+++ /main/L2GoldClassic/java/gold/lineage2/gameserver/model/Location.java	(revision 27)
@@ -56,4 +56,17 @@
 		_z = set.getInt("z");
 		_heading = set.getInt("heading", 0);
+	}
+	
+	/**
+	 * Calculates the Euclidean distance between two 3D points in the world
+	 * @param other
+	 * @return
+	 */
+	public double distanceTo(Location other)
+	{
+		int dx = _x - other._x;
+		int dy = _y - other._y;
+		int dz = _z - other._z;
+		return Math.sqrt((dx * dx) + (dy * dy) + (dz * dz));
 	}
 	
Index: /main/L2GoldClassic/java/gold/lineage2/gameserver/util/Util.java
===================================================================
--- /main/L2GoldClassic/java/gold/lineage2/gameserver/util/Util.java	(revision 26)
+++ /main/L2GoldClassic/java/gold/lineage2/gameserver/util/Util.java	(revision 27)
@@ -266,4 +266,22 @@
 	
 	/**
+	 * Tries to parse an integer from a string. If it fails, it returns the default value provided.
+	 * @param value
+	 * @param defaultValue
+	 * @return
+	 */
+	public static int parseNextInt(String value, int defaultValue)
+	{
+		try
+		{
+			return Integer.parseInt(value);
+		}
+		catch (NumberFormatException e)
+		{
+			return defaultValue;
+		}
+	}
+	
+	/**
 	 * @param text - the text to check
 	 * @return {@code true} if {@code text} is float, {@code false} otherwise

 

Edited March 19, 2023 by Trance