refactor: Add WaystonesListReceivedEvent, deprecate KnownWaystonesEvent

TwelveIterationMods · Dec 14, 2023 · b05710f · b05710f
1 parent 209ffd5
commit b05710f
Show file tree

Hide file tree

Showing 18 changed files with 80 additions and 9 deletions.
diff --git a/forge/src/main/java/net/blay09/mods/waystones/compat/TheOneProbeIntegration.java b/forge/src/main/java/net/blay09/mods/waystones/compat/TheOneProbeIntegration.java
@@ -6,7 +6,7 @@
 import net.blay09.mods.waystones.block.entity.WarpPlateBlockEntity;
 import net.blay09.mods.waystones.block.entity.WaystoneBlockEntityBase;
 import net.blay09.mods.waystones.core.PlayerWaystoneManager;
-import net.blay09.mods.waystones.core.WaystoneTypes;
+import net.blay09.mods.waystones.api.WaystoneTypes;
 import net.minecraft.network.chat.Component;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.world.entity.player.Player;

diff --git a/neoforge/src/main/java/net/blay09/mods/waystones/compat/TheOneProbeIntegration.java b/neoforge/src/main/java/net/blay09/mods/waystones/compat/TheOneProbeIntegration.java
@@ -6,7 +6,7 @@
 import net.blay09.mods.waystones.block.entity.WarpPlateBlockEntity;
 import net.blay09.mods.waystones.block.entity.WaystoneBlockEntityBase;
 import net.blay09.mods.waystones.core.PlayerWaystoneManager;
-import net.blay09.mods.waystones.core.WaystoneTypes;
+import net.blay09.mods.waystones.api.WaystoneTypes;
 import net.minecraft.network.chat.Component;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.world.entity.player.Player;

diff --git a/shared/src/main/java/net/blay09/mods/waystones/api/KnownWaystonesEvent.java b/shared/src/main/java/net/blay09/mods/waystones/api/KnownWaystonesEvent.java
@@ -6,7 +6,10 @@
 
 /**
  * This event is fired on the client side when the client has received the known waystones of the player.
+ *
+ * @deprecated Use {@link WaystonesListReceivedEvent} instead.
  */
+@Deprecated
 public class KnownWaystonesEvent extends BalmEvent {
 
     private final List<IWaystone> waystones;

diff --git a/shared/src/main/java/net/blay09/mods/waystones/api/WaystoneTypes.java b/shared/src/main/java/net/blay09/mods/waystones/api/WaystoneTypes.java
@@ -0,0 +1,26 @@
+package net.blay09.mods.waystones.api;
+
+import net.blay09.mods.waystones.Waystones;
+import net.minecraft.resources.ResourceLocation;
+import net.minecraft.world.item.DyeColor;
+import org.jetbrains.annotations.Nullable;
+
+public class WaystoneTypes {
+    public static final ResourceLocation WAYSTONE = new ResourceLocation(Waystones.MOD_ID, "waystone");
+    public static final ResourceLocation WARP_PLATE = new ResourceLocation(Waystones.MOD_ID, "warp_plate");
+    public static final ResourceLocation PORTSTONE = new ResourceLocation(Waystones.MOD_ID, "portstone");
+
+    private static final ResourceLocation SHARESTONE = new ResourceLocation(Waystones.MOD_ID, "sharestone");
+
+    public static ResourceLocation getSharestone(@Nullable DyeColor color) {
+        if (color == null) {
+            return SHARESTONE;
+        }
+
+        return new ResourceLocation(Waystones.MOD_ID, color.getSerializedName() + "_sharestone");
+    }
+
+    public static boolean isSharestone(ResourceLocation waystoneType) {
+        return waystoneType.equals(SHARESTONE) || waystoneType.getPath().endsWith("_sharestone");
+    }
+}
diff --git a/shared/src/main/java/net/blay09/mods/waystones/api/WaystonesListReceivedEvent.java b/shared/src/main/java/net/blay09/mods/waystones/api/WaystonesListReceivedEvent.java
@@ -0,0 +1,30 @@
+package net.blay09.mods.waystones.api;
+
+import net.blay09.mods.balm.api.event.BalmEvent;
+import net.minecraft.resources.ResourceLocation;
+
+import java.util.List;
+
+/**
+ * This event is fired on the client side when the client has received a list of waystones of the player.
+ * <p>
+ * Note that for WaystoneTypes.WAYSTONE, the list will only contain the waystones that the player has discovered.
+ */
+public class WaystonesListReceivedEvent extends BalmEvent {
+
+    private final ResourceLocation waystoneType;
+    private final List<IWaystone> waystones;
+
+    public WaystonesListReceivedEvent(ResourceLocation waystoneType, List<IWaystone> waystones) {
+        this.waystoneType = waystoneType;
+        this.waystones = waystones;
+    }
+
+    public ResourceLocation getWaystoneType() {
+        return waystoneType;
+    }
+
+    public List<IWaystone> getWaystones() {
+        return waystones;
+    }
+}
diff --git a/shared/src/main/java/net/blay09/mods/waystones/block/PortstoneBlock.java b/shared/src/main/java/net/blay09/mods/waystones/block/PortstoneBlock.java
@@ -9,7 +9,7 @@
 import net.blay09.mods.waystones.menu.WaystoneSelectionMenu;
 import net.blay09.mods.waystones.core.WarpMode;
 import net.blay09.mods.waystones.core.Waystone;
-import net.blay09.mods.waystones.core.WaystoneTypes;
+import net.blay09.mods.waystones.api.WaystoneTypes;
 import net.minecraft.ChatFormatting;
 import net.minecraft.core.BlockPos;
 import net.minecraft.core.Direction;

diff --git a/shared/src/main/java/net/blay09/mods/waystones/block/entity/SharestoneBlockEntity.java b/shared/src/main/java/net/blay09/mods/waystones/block/entity/SharestoneBlockEntity.java
@@ -5,7 +5,7 @@
 import net.blay09.mods.waystones.block.SharestoneBlock;
 import net.blay09.mods.waystones.core.Waystone;
 import net.blay09.mods.waystones.core.WaystoneManager;
-import net.blay09.mods.waystones.core.WaystoneTypes;
+import net.blay09.mods.waystones.api.WaystoneTypes;
 import net.blay09.mods.waystones.menu.ModMenus;
 import net.blay09.mods.waystones.menu.WaystoneSelectionMenu;
 import net.blay09.mods.waystones.menu.WaystoneSettingsMenu;

diff --git a/shared/src/main/java/net/blay09/mods/waystones/block/entity/WarpPlateBlockEntity.java b/shared/src/main/java/net/blay09/mods/waystones/block/entity/WarpPlateBlockEntity.java
@@ -10,6 +10,7 @@
 import net.blay09.mods.waystones.api.WaystonesAPI;
 import net.blay09.mods.waystones.block.WarpPlateBlock;
 import net.blay09.mods.waystones.config.WaystonesConfig;
+import net.blay09.mods.waystones.api.WaystoneTypes;
 import net.blay09.mods.waystones.core.*;
 import net.blay09.mods.waystones.menu.WarpPlateContainer;
 import net.blay09.mods.waystones.recipe.ModRecipes;

diff --git a/shared/src/main/java/net/blay09/mods/waystones/block/entity/WaystoneBlockEntity.java b/shared/src/main/java/net/blay09/mods/waystones/block/entity/WaystoneBlockEntity.java
@@ -6,7 +6,7 @@
 import net.blay09.mods.waystones.menu.WaystoneSelectionMenu;
 import net.blay09.mods.waystones.menu.WaystoneSettingsMenu;
 import net.blay09.mods.waystones.core.WarpMode;
-import net.blay09.mods.waystones.core.WaystoneTypes;
+import net.blay09.mods.waystones.api.WaystoneTypes;
 import net.minecraft.core.BlockPos;
 import net.minecraft.network.FriendlyByteBuf;
 import net.minecraft.network.chat.Component;

diff --git a/shared/src/main/java/net/blay09/mods/waystones/client/gui/screen/WaystoneSettingsScreen.java b/shared/src/main/java/net/blay09/mods/waystones/client/gui/screen/WaystoneSettingsScreen.java
@@ -4,7 +4,7 @@
 import net.blay09.mods.waystones.api.IWaystone;
 import net.blay09.mods.waystones.menu.WaystoneSettingsMenu;
 import net.blay09.mods.waystones.core.PlayerWaystoneManager;
-import net.blay09.mods.waystones.core.WaystoneTypes;
+import net.blay09.mods.waystones.api.WaystoneTypes;
 import net.blay09.mods.waystones.network.message.EditWaystoneMessage;
 import net.minecraft.client.Minecraft;
 import net.minecraft.client.gui.GuiGraphics;

diff --git a/shared/src/main/java/net/blay09/mods/waystones/compat/WaystonesWailaUtils.java b/shared/src/main/java/net/blay09/mods/waystones/compat/WaystonesWailaUtils.java
@@ -6,7 +6,7 @@
 import net.blay09.mods.waystones.block.entity.WarpPlateBlockEntity;
 import net.blay09.mods.waystones.block.entity.WaystoneBlockEntityBase;
 import net.blay09.mods.waystones.core.PlayerWaystoneManager;
-import net.blay09.mods.waystones.core.WaystoneTypes;
+import net.blay09.mods.waystones.api.WaystoneTypes;
 import net.minecraft.network.chat.Component;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.world.entity.player.Player;

diff --git a/shared/src/main/java/net/blay09/mods/waystones/core/PlayerWaystoneManager.java b/shared/src/main/java/net/blay09/mods/waystones/core/PlayerWaystoneManager.java
@@ -4,6 +4,7 @@
 import net.blay09.mods.balm.api.Balm;
 import net.blay09.mods.balm.api.BalmEnvironment;
 import net.blay09.mods.waystones.api.*;
+import net.blay09.mods.waystones.api.WaystoneTypes;
 import net.blay09.mods.waystones.block.entity.WarpPlateBlockEntity;
 import net.blay09.mods.waystones.config.DimensionalWarp;
 import net.blay09.mods.waystones.config.InventoryButtonMode;

diff --git a/shared/src/main/java/net/blay09/mods/waystones/core/WarpMode.java b/shared/src/main/java/net/blay09/mods/waystones/core/WarpMode.java
@@ -1,6 +1,7 @@
 package net.blay09.mods.waystones.core;
 
 import net.blay09.mods.waystones.api.IWaystone;
+import net.blay09.mods.waystones.api.WaystoneTypes;
 import net.blay09.mods.waystones.config.WaystonesConfig;
 import net.minecraft.world.entity.Entity;
 import net.minecraft.world.entity.player.Player;

diff --git a/shared/src/main/java/net/blay09/mods/waystones/core/Waystone.java b/shared/src/main/java/net/blay09/mods/waystones/core/Waystone.java
@@ -4,6 +4,7 @@
 import net.blay09.mods.waystones.api.IMutableWaystone;
 import net.blay09.mods.waystones.api.IWaystone;
 import net.blay09.mods.waystones.api.TeleportDestination;
+import net.blay09.mods.waystones.api.WaystoneTypes;
 import net.blay09.mods.waystones.api.WaystoneOrigin;
 import net.blay09.mods.waystones.block.WaystoneBlock;
 import net.blay09.mods.waystones.tag.ModBlockTags;

diff --git a/shared/src/main/java/net/blay09/mods/waystones/core/WaystoneSyncManager.java b/shared/src/main/java/net/blay09/mods/waystones/core/WaystoneSyncManager.java
@@ -2,6 +2,7 @@
 
 import net.blay09.mods.balm.api.Balm;
 import net.blay09.mods.waystones.api.IWaystone;
+import net.blay09.mods.waystones.api.WaystoneTypes;
 import net.blay09.mods.waystones.network.message.KnownWaystonesMessage;
 import net.blay09.mods.waystones.network.message.PlayerWaystoneCooldownsMessage;
 import net.blay09.mods.waystones.network.message.UpdateWaystoneMessage;
@@ -10,7 +11,6 @@
 import net.minecraft.world.entity.player.Player;
 import org.jetbrains.annotations.Nullable;
 
-import java.util.Collections;
 import java.util.List;
 import java.util.stream.Collectors;
 

diff --git a/shared/src/main/java/net/blay09/mods/waystones/core/WaystoneTypes.java b/shared/src/main/java/net/blay09/mods/waystones/core/WaystoneTypes.java
@@ -5,6 +5,10 @@
 import net.minecraft.world.item.DyeColor;
 import org.jetbrains.annotations.Nullable;
 
+/*
+ * @deprecated Use {@link net.blay09.mods.waystones.api.WaystoneTypes} instead.
+ */
+@Deprecated
 public class WaystoneTypes {
     public static final ResourceLocation WAYSTONE = new ResourceLocation(Waystones.MOD_ID, "waystone");
     public static final ResourceLocation WARP_PLATE = new ResourceLocation(Waystones.MOD_ID, "warp_plate");

diff --git a/shared/src/main/java/net/blay09/mods/waystones/menu/WaystoneSelectionMenu.java b/shared/src/main/java/net/blay09/mods/waystones/menu/WaystoneSelectionMenu.java
@@ -6,7 +6,7 @@
 import net.blay09.mods.waystones.core.PlayerWaystoneManager;
 import net.blay09.mods.waystones.core.WarpMode;
 import net.blay09.mods.waystones.core.WaystoneManager;
-import net.blay09.mods.waystones.core.WaystoneTypes;
+import net.blay09.mods.waystones.api.WaystoneTypes;
 import net.minecraft.core.BlockPos;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.server.MinecraftServer;

diff --git a/shared/src/main/java/net/blay09/mods/waystones/network/message/KnownWaystonesMessage.java b/shared/src/main/java/net/blay09/mods/waystones/network/message/KnownWaystonesMessage.java
@@ -4,6 +4,8 @@
 import net.blay09.mods.balm.api.BalmEnvironment;
 import net.blay09.mods.waystones.api.IWaystone;
 import net.blay09.mods.waystones.api.KnownWaystonesEvent;
+import net.blay09.mods.waystones.api.WaystonesListReceivedEvent;
+import net.blay09.mods.waystones.api.WaystoneTypes;
 import net.blay09.mods.waystones.core.*;
 import net.minecraft.network.FriendlyByteBuf;
 import net.minecraft.resources.ResourceLocation;
@@ -48,6 +50,8 @@ public static void handle(Player player, KnownWaystonesMessage message) {
             Balm.getEvents().fireEvent(new KnownWaystonesEvent(message.waystones));
         }
 
+        Balm.getEvents().fireEvent(new WaystonesListReceivedEvent(message.type, message.waystones));
+
         for (IWaystone waystone : message.waystones) {
             WaystoneManager.get(player.getServer()).updateWaystone(waystone);
         }