Merge branch '1.21.1/dev' into 1.21.1/main

Author: MichaelHillcox

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.13]
+
+### Added
+* An API `CustomMinYEvent` event to register custom `min-y` providers
+
+### Removed
+* Remove the previously added support for custom min-y per chunk scanning. This does not effect the global min-y already available
+
 ## [2101.1.12]
 
 ### Added
@@ -314,7 +322,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   * Periodically, least-recently accessed region data is released from RAM, requiring reload from disk on the next access. Every 300 seconds by default; can be tuned in client config.
   * When the large map screen is closed, regions furthest from the player are released from RAM, down to 32 loaded regions by default; also tunable in client config.
   * Map zoom-out is limited where the ratio of the number of known (explored) regions to available JVM memory is poor. Limiting zoom-out reduces the number of regions which need to be loaded in memory at a given moment. This can be disabled in client config if you prefer.
-  * New client config settings are available in the "Memory Usage" section of the client config; tuning them is a trade-off between RAM usage and disk activity. However, even when tuned toward lower RAM usage, the level of disk activity should not be a major concern. 
+  * New client config settings are available in the "Memory Usage" section of the client config; tuning them is a trade-off between RAM usage and disk activity. However, even when tuned toward lower RAM usage, the level of disk activity should not be a major concern.
 
 ## [1902.3.20]
 
@@ -335,7 +343,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## Fixed
 * Fixed a crash with fake player mods which use buckets to pick up water in protected chunks
 * Fixed interaction with Fabric mods which do block placement protection by firing the FAPI block break event directly (thanks @TelepathicGrunt)
-  * Example mod: Bumblezone 
+  * Example mod: Bumblezone
   * Architectury currently handles this via its own mixin
 
 
@@ -431,7 +439,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   * This means player heads will only be visible to team-mates and allies by default; if you're not in a party team but want to be visible on the map, set your "Location Visibility" to "Public" in team settings.
 * Player heads can now be tracked on the map at any range, not just inside the default entity tracking range
   * The same visibility restrictions apply as above, via "Location Visibility"
-  * Added server-side config item `long_range_tracker_interval` which controls how frequently long-range tracking data is sent by the server to clients; default is every 20 ticks (for players who are moving). 
+  * Added server-side config item `long_range_tracker_interval` which controls how frequently long-range tracking data is sent by the server to clients; default is every 20 ticks (for players who are moving).
   * Set this to 0 to disable long-tracking entirely
   * Be careful about setting this to very low (non-zero) values; it can cause extra server and network load, especially on very busy servers
 * Added entity interaction protection as a Team setting

common/src/main/java/dev/ftb/mods/ftbchunks/CustomMinYRegistryImpl.java

@@ -0,0 +1,35 @@
+package dev.ftb.mods.ftbchunks;
+
+import dev.ftb.mods.ftbchunks.api.LevelMinYCalculator;
+import dev.ftb.mods.ftbchunks.api.event.CustomMinYEvent;
+import net.minecraft.core.BlockPos;
+import net.minecraft.world.level.Level;
+
+import java.util.List;
+import java.util.OptionalInt;
+import java.util.concurrent.CopyOnWriteArrayList;
+
+public class CustomMinYRegistryImpl implements CustomMinYEvent.CustomMinYRegistry {
+    private static final CustomMinYRegistryImpl serverInstance = new CustomMinYRegistryImpl();
+    private static final CustomMinYRegistryImpl clientInstance = new CustomMinYRegistryImpl();
+
+    private final List<LevelMinYCalculator> calculators = new CopyOnWriteArrayList<>();  // needs to be threadsafe
+
+    public static CustomMinYRegistryImpl getInstance(boolean isClientSide) {
+        return isClientSide ? clientInstance : serverInstance;
+    }
+
+    public void register(LevelMinYCalculator calculator) {
+        calculators.add(calculator);
+    }
+
+    public int getMinYAt(Level level, BlockPos pos) {
+        for (var calc : calculators) {
+            OptionalInt h = calc.getLevelMinY(level, pos);
+            if (h.isPresent()) {
+                return h.getAsInt();
+            }
+        }
+        return level.getMinBuildHeight();
+    }
+}

common/src/main/java/dev/ftb/mods/ftbchunks/FTBChunks.java

@@ -14,6 +14,7 @@
 import dev.architectury.utils.EnvExecutor;
 import dev.architectury.utils.value.IntValue;
 import dev.ftb.mods.ftbchunks.api.*;
+import dev.ftb.mods.ftbchunks.api.event.CustomMinYEvent;
 import dev.ftb.mods.ftbchunks.client.FTBChunksClient;
 import dev.ftb.mods.ftbchunks.client.FTBChunksClientConfig;
 import dev.ftb.mods.ftbchunks.data.*;
@@ -133,6 +134,10 @@ public FTBChunks() {
 		TickEvent.PLAYER_POST.register(this::playerTickPost);
 
 		EnvExecutor.runInEnv(Env.CLIENT, () -> FTBChunksClient.INSTANCE::init);
+
+		LifecycleEvent.SETUP.register(() ->
+				CustomMinYEvent.REGISTER.invoker().register(CustomMinYRegistryImpl.getInstance(Platform.getEnvironment() == Env.CLIENT))
+		);
 	}
 
 	private EventResult playerAttackEntity(Player player, Level level, Entity entity, InteractionHand interactionHand, @Nullable EntityHitResult entityHitResult) {

common/src/main/java/dev/ftb/mods/ftbchunks/api/LevelMinYCalculator.java

@@ -0,0 +1,18 @@
+package dev.ftb.mods.ftbchunks.api;
+
+import dev.ftb.mods.ftbchunks.api.event.CustomMinYEvent;
+import net.minecraft.core.BlockPos;
+import net.minecraft.world.level.Level;
+
+import java.util.OptionalInt;
+
+/**
+ * Functional interface to allow custom minimum Y levels to be returned for a given dimension and block position.
+ * The intention of this is to allow for custom areas of a map to be concealed from FTB Chunks mapping.
+ * <p>
+ * Listen to the Architectury {@link CustomMinYEvent} event to register this method, on both client and server.
+ */
+@FunctionalInterface
+public interface LevelMinYCalculator {
+    OptionalInt getLevelMinY(Level level, BlockPos pos);
+}

common/src/main/java/dev/ftb/mods/ftbchunks/api/event/CustomMinYEvent.java

@@ -0,0 +1,15 @@
+package dev.ftb.mods.ftbchunks.api.event;
+
+import dev.architectury.event.Event;
+import dev.architectury.event.EventFactory;
+import dev.ftb.mods.ftbchunks.api.LevelMinYCalculator;
+
+public interface CustomMinYEvent {
+    Event<CustomMinYEvent> REGISTER = EventFactory.createLoop();
+
+    void register(CustomMinYRegistry registry);
+
+    interface CustomMinYRegistry {
+        void register(LevelMinYCalculator calculator);
+    }
+}

common/src/main/java/dev/ftb/mods/ftbchunks/util/HeightUtils.java

@@ -1,8 +1,8 @@
 package dev.ftb.mods.ftbchunks.util;
 
+import dev.ftb.mods.ftbchunks.CustomMinYRegistryImpl;
 import dev.ftb.mods.ftbchunks.FTBChunksWorldConfig;
 import dev.ftb.mods.ftbchunks.client.FTBChunksClient;
-import dev.ftb.mods.ftbchunks.client.FTBChunksClientConfig;
 import dev.ftb.mods.ftbchunks.core.BlockStateFTBC;
 import net.minecraft.core.BlockPos;
 import net.minecraft.util.Mth;
@@ -43,14 +43,15 @@ public static int getHeight(Level level, @Nullable ChunkAccess chunkAccess, Bloc
 			return UNKNOWN;
 		}
 
-        int chunkX = pos.getX() >> 4;
-        int chunkZ = pos.getZ() >> 4;
+//        int chunkX = pos.getX() >> 4;
+//        int chunkZ = pos.getZ() >> 4;
 
         // Clamped within the dimensions build height limits
-        int startY = FTBChunksWorldConfig.OVERRIDE_MIN_Y_LEVEL.get()
-                ? getMinYFromChunkOrConfig(chunkX, chunkZ)
-                : chunkAccess.getMinBuildHeight();
+//        int startY = FTBChunksWorldConfig.OVERRIDE_MIN_Y_LEVEL.get()
+//                ? getMinYFromChunkOrConfig(chunkX, chunkZ)
+//                : chunkAccess.getMinBuildHeight();
 
+		int startY = CustomMinYRegistryImpl.getInstance(level.isClientSide).getMinYAt(level, pos);
 		int bottomY = Mth.clamp(startY, chunkAccess.getMinBuildHeight(), chunkAccess.getMaxBuildHeight());
 
 		int topY = pos.getY();

gradle.properties

@@ -8,7 +8,7 @@ readable_name=FTB Chunks
 maven_group=dev.ftb.mods
 mod_author=FTB Team
 
-mod_version=2101.1.12
+mod_version=2101.1.13
 minecraft_version=1.21.1
 
 # Deps