Fix colony teams assignment behaviour (#10239)

Consistently ensure citizens are registered to the correct team
Use the colony team name instead of a per citizen team
Ensure that upon deletion of a colony it's respective team is removed
Fix the colony deletion event not triggering for command based deletion

src/main/java/com/minecolonies/api/entity/citizen/AbstractEntityCitizen.java

@@ -46,8 +46,10 @@
 import net.minecraft.world.item.ShieldItem;
 import net.minecraft.world.level.Level;
 import net.minecraft.world.phys.Vec3;
+import net.minecraft.world.scores.PlayerTeam;
 import net.minecraftforge.items.IItemHandler;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.List;
 
@@ -233,6 +235,18 @@ public boolean isNoAi()
         return false;
     }
 
+    @Override
+    @Nullable
+    protected PlayerTeam getAssignedTeam()
+    {
+        final ICitizenColonyHandler citizenColonyHandler = getCitizenColonyHandler();
+        if (citizenColonyHandler == null || citizenColonyHandler.getColony() == null)
+        {
+            return null;
+        }
+        return citizenColonyHandler.getColony().getTeam();
+    }
+
     /**
      * Sets the textures of all citizens and distinguishes between male and female.
      */

src/main/java/com/minecolonies/api/entity/mobs/AbstractEntityRaiderMob.java

@@ -52,17 +52,13 @@
 import static com.minecolonies.api.util.constant.ColonyManagerConstants.NO_COLONY_ID;
 import static com.minecolonies.api.util.constant.NbtTagConstants.*;
 import static com.minecolonies.api.util.constant.RaiderConstants.*;
+import static com.minecolonies.core.util.TeamUtils.checkOrCreateTeam;
 
 /**
  * Abstract for all raider entities.
  */
 public abstract class AbstractEntityRaiderMob extends AbstractFastMinecoloniesEntity implements IThreatTableEntity, Enemy
 {
-    /**
-     * Difficulty at which raiders team up
-     */
-    private static final double TEAM_DIFFICULTY = 2.0d;
-
     /**
      * The percent of life taken per damage modifier
      */
@@ -521,23 +517,23 @@ private void onEnterChunk(final ChunkPos newChunkPos)
         }
     }
 
-    @org.jetbrains.annotations.Nullable
+    @Nullable
     @Override
     public SpawnGroupData finalizeSpawn(
       final ServerLevelAccessor worldIn,
       final DifficultyInstance difficultyIn,
       final MobSpawnType reason,
-      @org.jetbrains.annotations.Nullable final SpawnGroupData spawnDataIn,
-      @org.jetbrains.annotations.Nullable final CompoundTag dataTag)
+      @Nullable final SpawnGroupData spawnDataIn,
+      @Nullable final CompoundTag dataTag)
     {
         RaiderMobUtils.setEquipment(this);
         return super.finalizeSpawn(worldIn, difficultyIn, reason, spawnDataIn, dataTag);
     }
 
     @Override
-    public void remove(RemovalReason reason)
+    public void remove(@NotNull final RemovalReason reason)
     {
-        if (!level().isClientSide && colony != null && eventID > 0)
+        if (!level.isClientSide && colony != null && eventID > 0)
         {
             colony.getEventManager().unregisterEntity(this, eventID);
         }
@@ -732,38 +728,15 @@ public void initStatsFor(final double baseHealth, final double difficulty, final
             this.setEnvDamageImmunity(true);
         }
 
-        if (difficulty >= TEAM_DIFFICULTY)
-        {
-            level().getScoreboard().addPlayerToTeam(getScoreboardName(), checkOrCreateTeam());
-        }
-
         this.getAttribute(Attributes.MAX_HEALTH).setBaseValue(baseHealth);
         this.setHealth(this.getMaxHealth());
     }
 
-    /**
-     * Creates or gets the scoreboard team
-     *
-     * @return Scoreboard team
-     */
-    private PlayerTeam checkOrCreateTeam()
-    {
-        if (this.level().getScoreboard().getPlayerTeam(getTeamName()) == null)
-        {
-            this.level().getScoreboard().addPlayerTeam(getTeamName());
-            this.level().getScoreboard().getPlayerTeam(getTeamName()).setAllowFriendlyFire(false);
-        }
-        return this.level().getScoreboard().getPlayerTeam(getTeamName());
-    }
-
-    /**
-     * Gets the scoreboard team name
-     *
-     * @return
-     */
-    protected String getTeamName()
+    @Override
+    @Nullable
+    protected PlayerTeam getAssignedTeam()
     {
-        return RAID_TEAM;
+        return checkOrCreateTeam(level, RAID_TEAM);
     }
 
     /**

src/main/java/com/minecolonies/api/entity/other/AbstractFastMinecoloniesEntity.java

@@ -14,12 +14,15 @@
 import net.minecraft.world.level.Level;
 import net.minecraft.world.level.entity.EntityTypeTest;
 import net.minecraft.world.phys.Vec3;
+import net.minecraft.world.scores.PlayerTeam;
+import net.minecraft.world.scores.Team;
 import net.minecraftforge.common.util.ITeleporter;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Objects;
 
 /**
  * Special abstract minecolonies mob that overrides laggy vanilla behaviour.
@@ -316,6 +319,74 @@ public void updateSwimAmount()
 
     }
 
+    /**
+     * Get the team this entity is assigned to.
+     *
+     * @return the team instance.
+     */
+    @Nullable
+    protected abstract PlayerTeam getAssignedTeam();
+
+    @Override
+    @Nullable
+    public final Team getTeam()
+    {
+        final PlayerTeam assignedTeam = getAssignedTeam();
+        registerToTeamInternal(assignedTeam);
+        return assignedTeam;
+    }
+
+    /**
+     * Register this entity to its own assigned team.
+     */
+    public void registerToTeam()
+    {
+        registerToTeamInternal(getAssignedTeam());
+    }
+
+    /**
+     * Internal method for team registration.
+     *
+     * @param team the team to register to.
+     */
+    private void registerToTeamInternal(@Nullable final PlayerTeam team)
+    {
+        if (team != null && !isInTeam(team))
+        {
+            level.getScoreboard().addPlayerToTeam(getScoreboardName(), team);
+        }
+    }
+
+    /**
+     * Remove the entity from its own assigned team.
+     */
+    public void removeFromTeam()
+    {
+        final PlayerTeam team = getAssignedTeam();
+        if (team != null && isInTeam(team))
+        {
+            level.getScoreboard().removePlayerFromTeam(getScoreboardName(), team);
+        }
+    }
+
+    /**
+     * Check if the current entity is assigned to the provided team.
+     *
+     * @param team the input team.
+     * @return true if so.
+     */
+    private boolean isInTeam(@NotNull final PlayerTeam team)
+    {
+        return Objects.equals(level.getScoreboard().getPlayersTeam(getScoreboardName()), team);
+    }
+
+    @Override
+    public void remove(@NotNull final RemovalReason reason)
+    {
+        super.remove(reason);
+        removeFromTeam();
+    }
+
     /**
      * Static Byte values to avoid frequent autoboxing
      */

src/main/java/com/minecolonies/api/events/ColonyEvents.java

@@ -0,0 +1,38 @@
+package com.minecolonies.api.events;
+
+import com.minecolonies.api.colony.IColony;
+import com.minecolonies.api.colony.event.ColonyDeletedEvent;
+import com.minecolonies.api.util.Log;
+import net.minecraftforge.common.MinecraftForge;
+import net.minecraftforge.eventbus.api.Event;
+
+/**
+ * Event manager for all forge events.
+ */
+public class ColonyEvents
+{
+    /**
+     * Event triggered when a colony is being deleted.
+     *
+     * @param colony the colony in question.
+     */
+    public static void deleteColony(final IColony colony)
+    {
+        sendEventSafe(new ColonyDeletedEvent(colony));
+    }
+
+    /**
+     * Underlying logic for transmitting an event.
+     */
+    private static void sendEventSafe(final Event event)
+    {
+        try
+        {
+            MinecraftForge.EVENT_BUS.post(event);
+        }
+        catch (final Exception e)
+        {
+            Log.getLogger().atError().withThrowable(e).log("Exception occurred during {} event", event.getClass().getName());
+        }
+    }
+}

src/main/java/com/minecolonies/core/colony/Colony.java

@@ -80,6 +80,7 @@
 import static com.minecolonies.api.util.constant.NbtTagConstants.*;
 import static com.minecolonies.api.util.constant.TranslationConstants.*;
 import static com.minecolonies.core.MineColonies.getConfig;
+import static com.minecolonies.core.util.TeamUtils.checkOrCreateTeam;
 
 /**
  * This class describes a colony and contains all the data and methods for manipulating a Colony.
@@ -362,7 +363,7 @@ protected Colony(final int id, @Nullable final Level world)
         {
             this.dimensionId = world.dimension();
             onWorldLoad(world);
-            checkOrCreateTeam();
+            checkOrCreateTeam(world, getTeamName(), false);
         }
         this.permissions = new Permissions(this);
         researchManager = new ResearchManager(this);
@@ -627,23 +628,11 @@ public void updateAttackingPlayers()
     }
 
     @Override
+    @Nullable
     public PlayerTeam getTeam()
     {
         // This getter will create the team if it doesn't exist. Could do something different though in the future.
-        return checkOrCreateTeam();
-    }
-
-    /**
-     * Check or create the team.
-     */
-    private PlayerTeam checkOrCreateTeam()
-    {
-        if (this.world.getScoreboard().getPlayerTeam(getTeamName()) == null)
-        {
-            this.world.getScoreboard().addPlayerTeam(getTeamName());
-            this.world.getScoreboard().getPlayerTeam(getTeamName()).setAllowFriendlyFire(false);
-        }
-        return this.world.getScoreboard().getPlayerTeam(getTeamName());
+        return checkOrCreateTeam(world, getTeamName(), false);
     }
 
     /**
@@ -655,10 +644,13 @@ public void setColonyColor(final ChatFormatting colonyColor)
     {
         if (this.world != null)
         {
-            checkOrCreateTeam();
             this.colonyTeamColor = colonyColor;
-            this.world.getScoreboard().getPlayerTeam(getTeamName()).setColor(colonyColor);
-            this.world.getScoreboard().getPlayerTeam(getTeamName()).setPlayerPrefix(Component.literal(colonyColor.toString()));
+            final PlayerTeam team = getTeam();
+            if (team != null)
+            {
+                team.setColor(colonyColor);
+                team.setPlayerPrefix(Component.literal(colonyColor.toString()));
+            }
         }
         this.markDirty();
     }

src/main/java/com/minecolonies/core/colony/ColonyManager.java

@@ -11,6 +11,7 @@
 import com.minecolonies.api.compatibility.CompatibilityManager;
 import com.minecolonies.api.compatibility.ICompatibilityManager;
 import com.minecolonies.api.crafting.IRecipeManager;
+import com.minecolonies.api.events.ColonyEvents;
 import com.minecolonies.api.sounds.SoundManager;
 import com.minecolonies.api.util.BlockPosUtil;
 import com.minecolonies.api.util.ColonyUtils;
@@ -201,6 +202,7 @@ private void deleteColony(@Nullable final IColony iColony, final boolean canDest
                 return;
             }
 
+            ColonyEvents.deleteColony(colony);
             cap.deleteColony(id);
             BackUpHelper.markColonyDeleted(colony.getID(), colony.getDimension());
             colony.getImportantMessageEntityPlayers()

src/main/java/com/minecolonies/core/colony/managers/CitizenManager.java

@@ -139,10 +139,10 @@ public void registerCivilian(final AbstractCivilianEntity entity)
 
         final Optional<AbstractEntityCitizen> existingCitizen = data.getEntity();
 
-        if (!existingCitizen.isPresent())
+        if (existingCitizen.isEmpty())
         {
             data.setEntity(entity);
-            entity.level.getScoreboard().addPlayerToTeam(entity.getScoreboardName(), colony.getTeam());
+            entity.registerToTeam();
             return;
         }
 
@@ -159,18 +159,7 @@ public void unregisterCivilian(final AbstractCivilianEntity entity)
         final ICitizenData data = citizens.get(entity.getCivilianID());
         if (data != null && data.getEntity().isPresent() && data.getEntity().get() == entity)
         {
-            try
-            {
-                if (colony.getWorld().getScoreboard().getPlayersTeam(entity.getScoreboardName()) == colony.getTeam())
-                {
-                    colony.getWorld().getScoreboard().removePlayerFromTeam(entity.getScoreboardName(), colony.getTeam());
-                }
-            }
-            catch (Exception ignored)
-            {
-                // For some weird reason we can get an exception here, though the exception is thrown for team != colony team which we check == on before
-            }
-
+            entity.removeFromTeam();
             citizens.get(entity.getCivilianID()).setEntity(null);
         }
     }