Merge pull request #78 from FTBTeam/1.21.1/dev

1.21.1/dev

Author: desht

CHANGELOG.md

@@ -4,6 +4,14 @@ 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).
 
+## [2101.1.8]
+
+### Added
+* Expanded the team properties system somewhat
+  * New team property types: Big Integer, String set, and String to int/bool/string map
+  * Added API to make it easier to register more custom property types if needed
+  * Added new builtin "Team Stage" team property, a team-based game stages system
+
 ## [2101.1.7]
 
 ### Added

common/src/main/java/dev/ftb/mods/ftbteams/FTBTeams.java

@@ -10,7 +10,6 @@
 import dev.architectury.utils.EnvExecutor;
 import dev.ftb.mods.ftblibrary.nbtedit.NBTEditResponseHandlers;
 import dev.ftb.mods.ftbteams.api.FTBTeamsAPI;
-import dev.ftb.mods.ftbteams.api.Team;
 import dev.ftb.mods.ftbteams.api.event.TeamCollectPropertiesEvent;
 import dev.ftb.mods.ftbteams.api.event.TeamEvent;
 import dev.ftb.mods.ftbteams.api.event.TeamManagerEvent;
@@ -19,12 +18,10 @@
 import dev.ftb.mods.ftbteams.data.AbstractTeam;
 import dev.ftb.mods.ftbteams.data.FTBTeamsCommands;
 import dev.ftb.mods.ftbteams.data.TeamManagerImpl;
-import dev.ftb.mods.ftbteams.data.TeamType;
 import dev.ftb.mods.ftbteams.net.FTBTeamsNet;
 import net.minecraft.commands.CommandBuildContext;
 import net.minecraft.commands.CommandSourceStack;
 import net.minecraft.commands.Commands;
-import net.minecraft.nbt.CompoundTag;
 import net.minecraft.network.chat.Component;
 import net.minecraft.server.MinecraftServer;
 import net.minecraft.server.level.ServerLevel;
@@ -92,6 +89,7 @@ private void teamConfig(TeamCollectPropertiesEvent event) {
 		event.add(TeamProperties.COLOR);
 		event.add(TeamProperties.FREE_TO_JOIN);
 		event.add(TeamProperties.MAX_MSG_HISTORY_SIZE);
+		event.add(TeamProperties.TEAM_STAGES);
 	}
 
 	private void playerLoggedIn(ServerPlayer player) {

common/src/main/java/dev/ftb/mods/ftbteams/api/FTBTeamsAPI.java

@@ -9,9 +9,6 @@
 
 import java.util.UUID;
 
-/**
- * @author LatvianModder
- */
 public class FTBTeamsAPI {
 	public static final String MOD_ID = "ftbteams";
 	public static final String MOD_NAME = "FTB Teams";

common/src/main/java/dev/ftb/mods/ftbteams/api/Team.java

@@ -6,6 +6,7 @@
 import dev.ftb.mods.ftbteams.api.property.TeamPropertyCollection;
 import net.minecraft.nbt.CompoundTag;
 import net.minecraft.network.chat.Component;
+import net.minecraft.server.MinecraftServer;
 import net.minecraft.server.level.ServerPlayer;
 import org.jetbrains.annotations.Nullable;
 
@@ -236,4 +237,25 @@ default boolean isClientTeam() {
      * @return the newly-created party team
      */
     Team createParty(String description, @Nullable Color4I color);
+
+    /**
+     * Synchronise the value of one team property for this team to all players on the server. This method does nothing
+     * if the property was not declared syncable (via {@link TeamProperty#syncToAll()}), or if called on the client.
+     *
+     * @param server the server
+     * @param property the property to sync
+     * @param value the value to sync
+     * @param <T> the property type
+     */
+    <T> void syncOnePropertyToAll(MinecraftServer server, TeamProperty<T> property, T value);
+
+    /**
+     * Synchronise the value of one team property for this team to all online players on this team. This method does nothing
+     *  if called on the client.
+     *
+     * @param property the property to sync
+     * @param value the value to sync
+     * @param <T> the property type
+     */
+    <T> void syncOnePropertyToTeam(TeamProperty<T> property, T value);
 }

common/src/main/java/dev/ftb/mods/ftbteams/api/TeamStagesHelper.java

@@ -0,0 +1,100 @@
+package dev.ftb.mods.ftbteams.api;
+
+import dev.ftb.mods.ftbteams.api.event.TeamEvent;
+import dev.ftb.mods.ftbteams.api.event.TeamPropertiesChangedEvent;
+import dev.ftb.mods.ftbteams.api.property.TeamProperties;
+import dev.ftb.mods.ftbteams.api.property.TeamPropertyCollection;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+import java.util.Set;
+
+/**
+ * Utility class providing some convenience methods for querying and adjust the team stages for a team. These methods
+ * all handle client sync and team data serialization internally.
+ * <p>
+ * Modifying a team's stages also causes a {@link TeamPropertiesChangedEvent} event to be fired.
+ */
+public class TeamStagesHelper {
+    /**
+     * Add one team stage to a team.
+     *
+     * @param team the team
+     * @param stage the stage to add
+     * @return true if the stage was added, false if the team already had the stage
+     */
+    public static boolean addTeamStage(Team team, String stage) {
+        return addTeamStages(team, List.of(stage)) == 1;
+    }
+
+    /**
+     * Add multiple team stages to a team. It is much more efficient to use this method rather than repeated calls to
+     * {@link #addTeamStage(Team, String)} when adding multiple stages.
+     *
+     * @param team the team
+     * @param stages the stages to add
+     * @return the number of stages actually added
+     */
+    public static int addTeamStages(Team team, Collection<String> stages) {
+        return updateStages(team, stages, true);
+    }
+
+    /**
+     * Remove one team stage from a team.
+     *
+     * @param team the team
+     * @param stage the stage to add
+     * @return true if the stage was remove, false if the team did not have the stage
+     */
+    public static boolean removeTeamStage(Team team, String stage) {
+        return removeTeamStages(team, List.of(stage)) == 1;
+    }
+
+    /**
+     * Removing multiple team stages from a team. It is much more efficient to use this method rather than repeated calls to
+     * {@link #removeTeamStage(Team, String)} when removing multiple stages.
+     *
+     * @param team the team
+     * @param stages the stages to add
+     * @return the number of stages actually removed
+     */
+    public static int removeTeamStages(Team team, Collection<String> stages) {
+        return updateStages(team, stages, false);
+    }
+
+    /**
+     * Check if a team has a particular stage.
+     *
+     * @param team the team
+     * @param stage the stage to check
+     * @return true if the team has the stage, false otherwise
+     */
+    public static boolean hasTeamStage(Team team, String stage) {
+        return team.getProperty(TeamProperties.TEAM_STAGES).contains(stage);
+    }
+
+    /**
+     * Get all the stages for a team.
+     *
+     * @param team the team
+     * @return an unmodifiable collection of the team's stages
+     */
+    public static Collection<String> getStages(Team team) {
+        return Collections.unmodifiableSet(team.getProperty(TeamProperties.TEAM_STAGES));
+    }
+
+    private static int updateStages(Team team, Collection<String> stages, boolean adding) {
+        Set<String> stageSet = team.getProperty(TeamProperties.TEAM_STAGES);
+        int changed = (int) stages.stream().filter(stage -> adding && stageSet.add(stage) || !adding && stageSet.remove(stage)).count();
+        if (changed > 0) {
+            team.setProperty(TeamProperties.TEAM_STAGES, stageSet);
+
+            TeamPropertyCollection old = team.getProperties().copy();
+            TeamEvent.PROPERTIES_CHANGED.invoker().accept(new TeamPropertiesChangedEvent(team, old));
+            team.syncOnePropertyToTeam(TeamProperties.TEAM_STAGES, stageSet);
+        }
+
+        return changed;
+    }
+}

common/src/main/java/dev/ftb/mods/ftbteams/api/client/ClientTeamManager.java

@@ -10,7 +10,7 @@
 import java.util.UUID;
 
 /**
- * Used to track known teams and player on each client in the game. You can retrieve an instance of this via
+ * Used to track known teams and players on each client in the game. You can retrieve an instance of this via
  * {@link FTBTeamsAPI.API#getClientManager()}.
  */
 public interface ClientTeamManager {

common/src/main/java/dev/ftb/mods/ftbteams/api/event/ClientTeamPropertiesChangedEvent.java

@@ -3,9 +3,6 @@
 import dev.ftb.mods.ftbteams.api.Team;
 import dev.ftb.mods.ftbteams.api.property.TeamPropertyCollection;
 
-/**
- * @author LatvianModder
- */
 public class ClientTeamPropertiesChangedEvent {
 	private final Team team;
 	private final TeamPropertyCollection old;

common/src/main/java/dev/ftb/mods/ftbteams/api/event/PlayerChangedTeamEvent.java

@@ -7,9 +7,6 @@
 import java.util.Optional;
 import java.util.UUID;
 
-/**
- * @author LatvianModder
- */
 public class PlayerChangedTeamEvent extends TeamEvent {
 	private final Team previousTeam;
 	private final UUID playerId;

common/src/main/java/dev/ftb/mods/ftbteams/api/event/PlayerJoinedPartyTeamEvent.java

@@ -4,9 +4,6 @@
 import net.minecraft.server.level.ServerPlayer;
 import org.jetbrains.annotations.NotNull;
 
-/**
- * @author LatvianModder
- */
 public class PlayerJoinedPartyTeamEvent extends TeamEvent {
 	private final Team previousTeam;
 	private final ServerPlayer player;

common/src/main/java/dev/ftb/mods/ftbteams/api/event/PlayerLeftPartyTeamEvent.java

@@ -6,9 +6,6 @@
 
 import java.util.UUID;
 
-/**
- * @author LatvianModder
- */
 public class PlayerLeftPartyTeamEvent extends TeamEvent {
 	private final Team playerTeam;
 	private final UUID playerId;