Merge pull request #31 from FTBTeam/1.19/dev

1.19/dev

Author: MaxNeedsSnacks

CHANGELOG.md

@@ -4,6 +4,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1902.2.12]
+
+### Added
+* Team properties can now include properties which are lists of string (required by new FTB Chunks builds)
+
+### Fixed
+* Major improvements in efficiency of server->client sync for team data
+  * Should greatly reduce network traffic and load for busy servers (many players & teams) in particular
+* A few GUI and logic fixes related to handling invites for team members and allies
+  * Allow players to be added as allies of your team even when they are a member of a different team
+  * Don't allow invitations to be sent to players who are already in a different team (they couldn't actually be added, but a useless invitation was being sent)
+  * Only show the GUI "Manage Allies" and "Invite Players" buttons for party teams
+  * Don't show "Disband Party" context menu entry in the GUI for non-party teams
+* Don't allow server teams to be created with names shorter than 3 characters
+* Converted a couple of more messages into translations
+
 ## [1902.2.11]
 
 ### Fixes

common/src/main/java/dev/ftb/mods/ftbteams/client/AllyScreen.java

@@ -30,7 +30,7 @@ public AllyScreen() {
     @Override
     protected boolean shouldIncludePlayer(KnownClientPlayer player) {
         // any player who isn't in our team is a valid potential or actual ally
-        return player.isValid() && !ClientTeamManager.INSTANCE.selfTeam.isMember(player.uuid);
+        return player.online && !ClientTeamManager.INSTANCE.selfTeam.isMember(player.uuid);
     }
 
     @Override

common/src/main/java/dev/ftb/mods/ftbteams/client/CreatePartyScreen.java

@@ -139,7 +139,7 @@ public void onClicked(MouseButton mouseButton) {
 			});
 
 			for (KnownClientPlayer player : manager.knownPlayers.values().stream().sorted().toList()) {
-				if (player != manager.selfKnownPlayer) {
+				if (player.isOnlineAndNotInParty() && player != manager.selfKnownPlayer) {
 					add(new InvitedButton(this, CreatePartyScreen.this, player));
 				}
 			}

common/src/main/java/dev/ftb/mods/ftbteams/client/InviteScreen.java

@@ -14,7 +14,7 @@ public InviteScreen() {
     @Override
     protected boolean shouldIncludePlayer(KnownClientPlayer player) {
         // any player who is online and not in a team
-        return player.online && player.isValid() && player.isInternalTeam() && player != ClientTeamManager.INSTANCE.selfKnownPlayer;
+        return player.isOnlineAndNotInParty() && player != ClientTeamManager.INSTANCE.selfKnownPlayer;
     }
 
     @Override

common/src/main/java/dev/ftb/mods/ftbteams/client/InvitedButton.java

@@ -28,7 +28,7 @@ public class InvitedButton extends NordButton {
 		screen = s;
 		player = p;
 
-		if (!player.isValid()) {
+		if (!player.online) {
 			title = title.copy().withStyle(Style.EMPTY.withColor(TextColor.fromRgb(NordColors.POLAR_NIGHT_0.rgb())));
 		}
 	}
@@ -51,7 +51,7 @@ public void drawIcon(PoseStack matrixStack, Theme theme, int x, int y, int w, in
 
 	@Override
 	public void onClicked(MouseButton button) {
-		if (player.isValid()) {
+		if (player.online) {
 			GameProfile profile = player.getProfile();
 			boolean invited = screen.isInvited(profile);
 			screen.setInvited(profile, !invited);

common/src/main/java/dev/ftb/mods/ftbteams/client/MemberButton.java

@@ -44,13 +44,15 @@ public void drawIcon(PoseStack matrixStack, Theme theme, int x, int y, int w, in
 
 	@Override
 	public void onClicked(MouseButton button) {
-		if (ClientTeamManager.INSTANCE.selfKnownPlayer == null) return;
+		if (ClientTeamManager.INSTANCE.selfKnownPlayer == null || ClientTeamManager.INSTANCE.selfTeam == null) return;
 
 		KnownClientPlayer self = ClientTeamManager.INSTANCE.selfKnownPlayer;
 		ClientTeam selfTeam = ClientTeamManager.INSTANCE.selfTeam;
 		TeamRank selfRank = selfTeam.getHighestRank(self.uuid);
 		TeamRank playerRank = selfTeam.getHighestRank(player.uuid);
 
+		if (selfTeam.getType() != TeamType.PARTY) return;
+
 		List<ContextMenuItem> items0 = new ArrayList<>();
 		if (player.uuid.equals(self.uuid)) {
 			if (selfRank.is(TeamRank.OWNER)) {

common/src/main/java/dev/ftb/mods/ftbteams/client/MyTeamScreen.java

@@ -50,7 +50,7 @@ public static void refreshIfOpen() {
 			if (mts.getManager().selfTeam.getId().equals(mts.teamID)) {
 				mts.refreshWidgets();
 			} else {
-				// team has changed (player left or got kicked?)
+				// team has changed (player left or got kicked from party?)
 				mts.closeGui(false);
 			}
 		}
@@ -176,6 +176,9 @@ public InviteButton(Panel panel) {
 
 		@Override
 		public boolean isEnabled() {
+			if (ClientTeamManager.INSTANCE.selfTeam.getType() != TeamType.PARTY) {
+				return false;
+			}
 			KnownClientPlayer knownPlayer = ClientTeamManager.INSTANCE.selfKnownPlayer;
 			return knownPlayer != null && ClientTeamManager.INSTANCE.selfTeam.isOfficer(knownPlayer.uuid);
 		}
@@ -194,6 +197,9 @@ public AllyButton(Panel panel) {
 
 		@Override
 		public boolean isEnabled() {
+			if (ClientTeamManager.INSTANCE.selfTeam.getType() != TeamType.PARTY) {
+				return false;
+			}
 			KnownClientPlayer knownPlayer = ClientTeamManager.INSTANCE.selfKnownPlayer;
 			return knownPlayer != null && ClientTeamManager.INSTANCE.selfTeam.isOfficer(knownPlayer.uuid);
 		}
@@ -277,7 +283,7 @@ public MemberPanel() {
 		@Override
 		public void addWidgets() {
 			ClientTeamManager manager = getManager();
-			if (manager == null || manager.invalid) return;
+			if (manager == null || manager.isInvalid()) return;
 
 			PARTY_RANKS.stream()
 					.flatMap(rank -> manager.selfTeam.getRanked(rank).entrySet().stream()

common/src/main/java/dev/ftb/mods/ftbteams/data/ClientTeam.java

@@ -1,32 +1,50 @@
 package dev.ftb.mods.ftbteams.data;
 
+import dev.ftb.mods.ftbteams.property.TeamProperty;
 import net.minecraft.Util;
 import net.minecraft.network.FriendlyByteBuf;
 
+import java.util.List;
 import java.util.Map;
 import java.util.UUID;
 
 public class ClientTeam extends TeamBase {
+	private static List<TeamProperty> SYNCABLE_PROPS = List.of(DISPLAY_NAME, COLOR);
+
 	public final ClientTeamManager manager;
 	public boolean invalid;
 	TeamType type;
 	private final UUID ownerID;
 
-	public ClientTeam(ClientTeamManager m, FriendlyByteBuf buffer, long now) {
+	public static ClientTeam invalidTeam(ClientTeamManager m, Team team) {
+		return new ClientTeam(m, team.getId());
+	}
+
+	private ClientTeam(ClientTeamManager m, UUID id) {
+		super();
+		this.id = id;
+		manager = m;
+		ownerID = Util.NIL_UUID;
+		invalid = true;
+		type = TeamType.PARTY;
+	}
+
+	public ClientTeam(ClientTeamManager m, FriendlyByteBuf buffer) {
 		manager = m;
 		id = buffer.readUUID();
-		type = TeamType.VALUES[buffer.readByte()];
+		type = buffer.readEnum(TeamType.class);
 		properties.read(buffer);
 
 		int rs = buffer.readVarInt();
-
 		for (int i = 0; i < rs; i++) {
-			ranks.put(buffer.readUUID(), TeamRank.VALUES[buffer.readByte()]);
+			ranks.put(buffer.readUUID(), buffer.readEnum(TeamRank.class));
 		}
 
 		extraData = buffer.readNbt();
 
 		ownerID = buffer.readBoolean() ? buffer.readUUID() : Util.NIL_UUID;
+
+		invalid = buffer.readBoolean();
 	}
 
 	public ClientTeam(ClientTeamManager m, Team team) {
@@ -49,23 +67,29 @@ public boolean isValid() {
 		return manager.teamMap.containsKey(id);
 	}
 
-	public void write(FriendlyByteBuf buffer, long now) {
+	public void write(FriendlyByteBuf buffer, boolean writeAllProperties) {
 		buffer.writeUUID(id);
-		buffer.writeByte(type.ordinal());
-		properties.write(buffer);
+		buffer.writeEnum(type);
+		if (writeAllProperties) {
+			properties.write(buffer);
+		} else {
+			properties.writeSyncableOnly(buffer, SYNCABLE_PROPS);
+		}
 
 		buffer.writeVarInt(ranks.size());
 
 		for (Map.Entry<UUID, TeamRank> entry : ranks.entrySet()) {
 			buffer.writeUUID(entry.getKey());
-			buffer.writeByte(entry.getValue().ordinal());
+			buffer.writeEnum(entry.getValue());
 		}
 
 		buffer.writeNbt(extraData);
 
 		boolean hasOwner = !ownerID.equals(Util.NIL_UUID);
 		buffer.writeBoolean(hasOwner);
 		if (hasOwner) buffer.writeUUID(ownerID);
+
+		buffer.writeBoolean(invalid);
 	}
 
 	public boolean isSelf() {
@@ -75,4 +99,9 @@ public boolean isSelf() {
 	public UUID getOwnerID() {
 		return ownerID;
 	}
+
+	public void setMessageHistory(List<TeamMessage> messages) {
+		messageHistory.clear();
+		messageHistory.addAll(messages);
+	}
 }

common/src/main/java/dev/ftb/mods/ftbteams/data/ClientTeamManager.java

@@ -1,7 +1,6 @@
 package dev.ftb.mods.ftbteams.data;
 
 import dev.ftb.mods.ftbteams.FTBTeams;
-import net.fabricmc.loader.impl.util.log.Log;
 import net.minecraft.ChatFormatting;
 import net.minecraft.Util;
 import net.minecraft.client.Minecraft;
@@ -10,68 +9,70 @@
 import org.jetbrains.annotations.Nullable;
 
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
 import java.util.UUID;
 
+/**
+ * Represents the teams and known players that the client knows about; one global instance exists on the client.
+ * Instances are also created server-side for when changes need to be sync'd to the client; the server side instance
+ * will usually not have a complete list of client teams, but just those that needed to be added/updated/removed
+ * on the client.
+ */
 public class ClientTeamManager {
-	public static ClientTeamManager INSTANCE;
+	public static ClientTeamManager INSTANCE;  // instantiated when initial team data is sync'd on player login
 
-	public boolean invalid;
-	private final UUID id;
+	private final UUID managerId;
+	private boolean invalid;
 	public final Map<UUID, ClientTeam> teamMap;
 	public final Map<UUID, KnownClientPlayer> knownPlayers;
 	public ClientTeam selfTeam;
 	public KnownClientPlayer selfKnownPlayer;
 
-	public ClientTeamManager(UUID i) {
+	public ClientTeamManager(UUID managerId) {
+		this.managerId = managerId;
 		invalid = false;
-		id = i;
 		teamMap = new HashMap<>();
 		knownPlayers = new HashMap<>();
 	}
 
-	public ClientTeamManager(FriendlyByteBuf buffer, long now) {
+	public ClientTeamManager(FriendlyByteBuf buffer) {
 		this(buffer.readUUID());
 
-		int ts = buffer.readVarInt();
-
-		for (int i = 0; i < ts; i++) {
-			ClientTeam t = new ClientTeam(this, buffer, now);
+		int nTeams = buffer.readVarInt();
+		for (int i = 0; i < nTeams; i++) {
+			ClientTeam t = new ClientTeam(this, buffer);
 			teamMap.put(t.getId(), t);
 		}
 
-		int ps = buffer.readVarInt();
-
-		for (int i = 0; i < ps; i++) {
+		int nPlayers = buffer.readVarInt();
+		for (int i = 0; i < nPlayers; i++) {
 			KnownClientPlayer knownClientPlayer = new KnownClientPlayer(buffer);
 			knownPlayers.put(knownClientPlayer.uuid, knownClientPlayer);
 		}
 	}
 
-	public UUID getId() {
-		return id;
+	public UUID getManagerId() {
+		return managerId;
 	}
 
-	public void write(FriendlyByteBuf buffer, long now) {
-		buffer.writeUUID(getId());
+	public boolean isInvalid() {
+		return invalid;
+	}
 
-		buffer.writeVarInt(teamMap.size());
+	public void write(FriendlyByteBuf buffer, UUID selfTeamID) {
+		buffer.writeUUID(getManagerId());
 
-		for (ClientTeam t : teamMap.values()) {
-			t.write(buffer, now);
-		}
+		buffer.writeVarInt(teamMap.size());
+		teamMap.values().forEach(clientTeam -> clientTeam.write(buffer, selfTeamID.equals(clientTeam.getId())));
 
 		buffer.writeVarInt(knownPlayers.size());
-
 		for (KnownClientPlayer knownClientPlayer : knownPlayers.values()) {
 			knownClientPlayer.write(buffer);
 		}
 	}
 
-	public void init(UUID self, List<TeamMessage> messages) {
-		selfTeam = teamMap.get(self);
-		selfTeam.addMessages(messages);
+	public void initSelfDetails(UUID selfTeamID) {
+		selfTeam = teamMap.get(selfTeamID);
 		UUID userId = Minecraft.getInstance().getUser().getGameProfile().getId();
 		selfKnownPlayer = knownPlayers.get(userId);
 		if (selfKnownPlayer == null) {
@@ -98,4 +99,39 @@ public Component getName(@Nullable UUID id) {
 		KnownClientPlayer p = knownPlayers.get(id);
 		return Component.literal(p == null ? "Unknown" : p.name).withStyle(ChatFormatting.YELLOW);
 	}
+
+	public void invalidate() {
+		teamMap.values().forEach(team -> team.invalid = true);
+		invalid = true;
+	}
+
+	public static void syncFromServer(ClientTeamManager syncedData, UUID selfTeamID, boolean fullSync) {
+		if (fullSync) {
+			// complete live team manager invalidation and replacement
+			syncedData.initSelfDetails(selfTeamID);
+			if (INSTANCE != null) {
+				INSTANCE.invalidate();
+			}
+			INSTANCE = syncedData;
+		} else if (ClientTeamManager.INSTANCE != null) {
+			// just copy the sync'd team(s) into the live client team manager
+			syncedData.teamMap.forEach((teamID, clientTeam) -> {
+				if (clientTeam.invalid) {
+					FTBTeams.LOGGER.debug("remove {} from client team map", teamID);
+					INSTANCE.teamMap.remove(teamID);
+				} else {
+					ClientTeam existing = INSTANCE.teamMap.get(teamID);
+					if (existing != null) {
+						FTBTeams.LOGGER.debug("update {} in client team map", teamID);
+					} else {
+						FTBTeams.LOGGER.debug("insert {} into client team map", teamID);
+					}
+					INSTANCE.teamMap.put(teamID, clientTeam);
+				}
+			});
+			INSTANCE.knownPlayers.putAll(syncedData.knownPlayers);
+			INSTANCE.initSelfDetails(selfTeamID);
+		}
+
+	}
 }

common/src/main/java/dev/ftb/mods/ftbteams/data/KnownClientPlayer.java

@@ -58,7 +58,7 @@ public boolean isInternalTeam() {
 		return teamId.equals(uuid);
 	}
 
-	public boolean isValid() {
+	public boolean isOnlineAndNotInParty() {
 		return online && isInternalTeam();
 	}
 
@@ -68,7 +68,7 @@ public CompoundTag getExtraData() {
 
 	@Override
 	public int compareTo(KnownClientPlayer o) {
-		int i = Boolean.compare(o.isValid(), isValid());
+		int i = Boolean.compare(o.isOnlineAndNotInParty(), isOnlineAndNotInParty());
 		return i == 0 ? name.compareToIgnoreCase(o.name) : i;
 	}
 }