From c7ea93349488d02f13faa75787268d96c2ef8b1b Mon Sep 17 00:00:00 2001
From: Hedzer Kuijlman <h.kuijlman@hak.wtf>
Date: Wed, 23 Apr 2025 20:53:15 +0200
Subject: [PATCH] Added documentation to Mixin classes

---
 .../hak/survivalfabric/mixin/PlayerManagerMixin.java | 12 ++++++++++++
 .../mixin/ServerPlayNetworkHandlerMixin.java         |  3 +++
 .../mixin/ServerPlayerEntityMixin.java               |  3 +++
 .../hak/survivalfabric/mixin/ServerWorldMixin.java   |  3 +++
 4 files changed, 21 insertions(+)

diff --git a/src/main/java/wtf/hak/survivalfabric/mixin/PlayerManagerMixin.java b/src/main/java/wtf/hak/survivalfabric/mixin/PlayerManagerMixin.java
index 2067bbe..d5b6ad6 100644
--- a/src/main/java/wtf/hak/survivalfabric/mixin/PlayerManagerMixin.java
+++ b/src/main/java/wtf/hak/survivalfabric/mixin/PlayerManagerMixin.java
@@ -22,6 +22,9 @@ import java.util.Set;
 @Mixin(PlayerManager.class)
 public abstract class PlayerManagerMixin {
 
+    /**
+     * Send join message to joined player
+     */
     @Inject(method = {"onPlayerConnect"}, at = {@At(value = "INVOKE", target = "Lnet/minecraft/server/PlayerManager;broadcast(Lnet/minecraft/text/Text;Z)V")})
     public void onPlayerConnect(ClientConnection connection, ServerPlayerEntity player, ConnectedClientData clientData, CallbackInfo ci) {
         if (ConfigManager.getConfig().joinMessageEnabled && !player.getServer().isSingleplayer()) {
@@ -30,6 +33,9 @@ public abstract class PlayerManagerMixin {
         }
     }
 
+    /**
+     * Modify join message broadcasted to server
+     */
     @ModifyArg(method = {"onPlayerConnect"}, at = @At(value = "INVOKE", target = "Lnet/minecraft/server/PlayerManager;broadcast(Lnet/minecraft/text/Text;Z)V"))
     private Text onPlayerConnect(Text text) {
         if (ConfigManager.getConfig().joinMessageEnabled) {
@@ -39,6 +45,9 @@ public abstract class PlayerManagerMixin {
             return text;
     }
 
+    /**
+     * Get player out of specator mode if necessary
+     */
     @Inject(method = {"remove"}, at = {@At("HEAD")})
     public void onPlayerLeave(ServerPlayerEntity player, CallbackInfo ci) {
         if (SpectatorCommand.spectating.containsKey(player)) {
@@ -48,6 +57,9 @@ public abstract class PlayerManagerMixin {
         }
     }
 
+    /**
+     * Modify chat messages
+     */
     @Inject(method = {"broadcast(Lnet/minecraft/network/message/SignedMessage;Lnet/minecraft/server/network/ServerPlayerEntity;Lnet/minecraft/network/message/MessageType$Parameters;)V"}, at = {@At("HEAD")}, cancellable = true)
     private void onBroadcast(SignedMessage message, ServerPlayerEntity sender, MessageType.Parameters parameters, CallbackInfo ci) {
         if (sender != null) {
diff --git a/src/main/java/wtf/hak/survivalfabric/mixin/ServerPlayNetworkHandlerMixin.java b/src/main/java/wtf/hak/survivalfabric/mixin/ServerPlayNetworkHandlerMixin.java
index 8d2caf9..db19be8 100644
--- a/src/main/java/wtf/hak/survivalfabric/mixin/ServerPlayNetworkHandlerMixin.java
+++ b/src/main/java/wtf/hak/survivalfabric/mixin/ServerPlayNetworkHandlerMixin.java
@@ -10,6 +10,9 @@ import wtf.hak.survivalfabric.config.ConfigManager;
 @Mixin(ServerPlayNetworkHandler.class)
 public abstract class ServerPlayNetworkHandlerMixin {
 
+    /**
+     * Modify quit message
+     */
     @ModifyArg(method = {"cleanUp"}, at = @At(value = "INVOKE", target = "Lnet/minecraft/server/PlayerManager;broadcast(Lnet/minecraft/text/Text;Z)V"))
     private Text quitMessage(Text text) {
         if (ConfigManager.getConfig().quitMessageEnabled) {
diff --git a/src/main/java/wtf/hak/survivalfabric/mixin/ServerPlayerEntityMixin.java b/src/main/java/wtf/hak/survivalfabric/mixin/ServerPlayerEntityMixin.java
index d0110f9..3fb2fb0 100644
--- a/src/main/java/wtf/hak/survivalfabric/mixin/ServerPlayerEntityMixin.java
+++ b/src/main/java/wtf/hak/survivalfabric/mixin/ServerPlayerEntityMixin.java
@@ -12,6 +12,9 @@ import wtf.hak.survivalfabric.config.ConfigManager;
 @Mixin(ServerPlayerEntity.class)
 public abstract class ServerPlayerEntityMixin {
 
+    /**
+     * Change player list name if enabled
+     */
     @Inject(method = "getPlayerListName", at = @At("HEAD"), cancellable = true)
     private void changePlayerListName(CallbackInfoReturnable<Text> cir) {
         if (ConfigManager.getConfig().dimensionIndicatorEnabled) {
diff --git a/src/main/java/wtf/hak/survivalfabric/mixin/ServerWorldMixin.java b/src/main/java/wtf/hak/survivalfabric/mixin/ServerWorldMixin.java
index d2ea4ae..60bfb28 100644
--- a/src/main/java/wtf/hak/survivalfabric/mixin/ServerWorldMixin.java
+++ b/src/main/java/wtf/hak/survivalfabric/mixin/ServerWorldMixin.java
@@ -12,6 +12,9 @@ import wtf.hak.survivalfabric.utils.PacketUtils;
 @Mixin(ServerWorld.class)
 public class ServerWorldMixin {
 
+    /**
+     * Update List Names if needed
+     */
     @Inject(method = "onDimensionChanged", at = {@At("HEAD")})
     public void onDimensionChange(Entity entity, CallbackInfo ci) {
         if (entity instanceof ServerPlayerEntity) {