Add IDhApiWrapperFactory

api/src/main/java/com/seibel/distanthorizons/api/DhApi.java

@@ -20,6 +20,7 @@
 package com.seibel.distanthorizons.api;
 
 import com.seibel.distanthorizons.api.interfaces.events.IDhApiEventInjector;
+import com.seibel.distanthorizons.api.interfaces.factories.IDhApiWrapperFactory;
 import com.seibel.distanthorizons.api.interfaces.override.IDhApiOverrideable;
 import com.seibel.distanthorizons.api.interfaces.override.worldGenerator.IDhApiWorldGeneratorOverrideRegister;
 import com.seibel.distanthorizons.api.interfaces.render.IDhApiRenderProxy;
@@ -114,6 +115,12 @@ public class DhApi
 		 */
 		public static IDhApiRenderProxy renderProxy = null;
 		
+		/** 
+		 * Used to create wrappers for Minecraft objects needed by other Distant Horizons API methods.
+		 * @since API 1.1.0
+		 */
+		public static IDhApiWrapperFactory wrapperFactory = null;
+		
 	}
 	
 	

api/src/main/java/com/seibel/distanthorizons/api/interfaces/factories/IDhApiWrapperFactory.java

@@ -0,0 +1,80 @@
+/*
+ *    This file is part of the Distant Horizons mod
+ *    licensed under the GNU LGPL v3 License.
+ *
+ *    Copyright (C) 2020-2023 James Seibel
+ *
+ *    This program is free software: you can redistribute it and/or modify
+ *    it under the terms of the GNU Lesser General Public License as published by
+ *    the Free Software Foundation, version 3.
+ *
+ *    This program is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *    GNU Lesser General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public License
+ *    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.seibel.distanthorizons.api.interfaces.factories;
+
+import com.seibel.distanthorizons.api.interfaces.block.IDhApiBiomeWrapper;
+import com.seibel.distanthorizons.api.interfaces.block.IDhApiBlockStateWrapper;
+import com.seibel.distanthorizons.api.interfaces.world.IDhApiLevelWrapper;
+import com.seibel.distanthorizons.api.DhApi;
+
+import java.io.IOException;
+
+/**
+ * This handles creating abstract wrapper objects.
+ *
+ * @author James Seibel
+ * @version 2023-12-16
+ * @since API 1.1.0
+ */
+public interface IDhApiWrapperFactory
+{
+	/**
+	 * Constructs a {@link IDhApiBiomeWrapper} for use by other DhApi methods.
+	 * 
+	 * @param objectArray Expects the following Minecraft objects (in order) for each MC version: <br>
+	 * <b>1.16</b> and <b>1.17</b><br>
+	 * - [net.minecraft.world.level.biome.Biome] <br>
+	 * <b>1.18</b> and <b>newer</b> <br>
+	 * - {@literal [net.minecraft.core.Holder<net.minecraft.world.level.biome.Biome>] }<br>
+	 * 
+	 * @param levelWrapper Expects a {@link IDhApiLevelWrapper} returned by one of DH's {@link DhApi.Delayed#worldProxy} methods. <br>
+	 *                      A custom implementation of {@link IDhApiLevelWrapper} will not be accepted.
+	 * 
+	 * @throws ClassCastException if any of the given parameters is of the wrong type. 
+	 * If thrown the error message will contain the list of expected object types in order. 
+	 * 
+	 * @since API 1.1.0
+	 */
+	IDhApiBiomeWrapper getBiomeWrapper(Object[] objectArray, IDhApiLevelWrapper levelWrapper) throws ClassCastException;
+	
+	/**
+	 * Constructs a {@link IDhApiBlockStateWrapper} for use by other DhApi methods.
+	 *
+	 * @param objectArray Expects the following Minecraft objects (in order) for each MC version: <br>
+	 * <b>1.16</b> and <b>newer</b> <br>
+	 * - [net.minecraft.world.level.block.state.BlockState]<br>
+	 *
+	 * @param levelWrapper Expects a {@link IDhApiBlockStateWrapper} returned by one of DH's {@link DhApi.Delayed#worldProxy} methods. <br>
+	 *                      A custom implementation of {@link IDhApiBlockStateWrapper} will not be accepted.
+	 *
+	 * @throws ClassCastException if any of the given parameters is of the wrong type. 
+	 * If thrown the error message will contain the list of expected object types in order. 
+	 * 
+	 * @since API 1.1.0
+	 */
+	IDhApiBlockStateWrapper getBlockStateWrapper(Object[] objectArray, IDhApiLevelWrapper levelWrapper) throws ClassCastException;
+	
+	/**
+	 * Returns the {@link IDhApiBlockStateWrapper} representing air.
+	 * @since API 1.1.0
+	 */
+	IDhApiBlockStateWrapper getAirBlockStateWrapper();
+	
+}

api/src/main/java/com/seibel/distanthorizons/api/interfaces/override/worldGenerator/IDhApiWorldGenerator.java

@@ -48,6 +48,7 @@ public interface IDhApiWorldGenerator extends Closeable, IDhApiOverrideable
 	 * TODO: System currently only supports 1x1 block per data.
 	 *
 	 * @see EDhApiDetailLevel
+	 * @since API 1.0.0
 	 */
 	default byte getSmallestDataDetailLevel() { return EDhApiDetailLevel.BLOCK.detailLevel; }
 	/**
@@ -57,6 +58,7 @@ public interface IDhApiWorldGenerator extends Closeable, IDhApiOverrideable
 	 * For more information on what detail levels represent see: {@link EDhApiDetailLevel}.
 	 *
 	 * @see EDhApiDetailLevel
+	 * @since API 1.0.0
 	 */
 	default byte getLargestDataDetailLevel() { return EDhApiDetailLevel.BLOCK.detailLevel; }
 	
@@ -69,6 +71,7 @@ public interface IDhApiWorldGenerator extends Closeable, IDhApiOverrideable
 	 * For more information on what detail levels represent see: {@link EDhApiDetailLevel}.
 	 *
 	 * @see EDhApiDetailLevel
+	 * @since API 1.0.0
 	 */
 	default byte getMinGenerationGranularity() { return EDhApiDetailLevel.CHUNK.detailLevel; }
 	
@@ -81,10 +84,14 @@ public interface IDhApiWorldGenerator extends Closeable, IDhApiOverrideable
 	 * For more information on what detail levels represent see: {@link EDhApiDetailLevel}.
 	 *
 	 * @see EDhApiDetailLevel
+	 * @since API 1.0.0
 	 */
 	default byte getMaxGenerationGranularity() { return (byte) (EDhApiDetailLevel.CHUNK.detailLevel + 2); }
 	
-	/** @return true if the generator is unable to accept new generation requests. */
+	/** 
+	 * @return true if the generator is unable to accept new generation requests.
+	 * @since API 1.0.0
+	 */
 	boolean isBusy();
 	
 	
@@ -115,7 +122,10 @@ public interface IDhApiWorldGenerator extends Closeable, IDhApiOverrideable
 	 * @param generatorMode how far into the world gen pipeline this method run. See {@link EDhApiDistantGeneratorMode} for additional documentation.
 	 * @param worldGeneratorThreadPool the thread pool that should be used when generating the returned {@link CompletableFuture}.
 	 * @param resultConsumer the consumer that should be fired whenever a chunk finishes generating.
+	 * 
 	 * @return a future that should run on the worldGeneratorThreadPool and complete once the given generation task has completed.
+	 * 
+	 * @since API 1.0.0
 	 */
 	CompletableFuture<Void> generateChunks(
 			int chunkPosMinX, int chunkPosMinZ,
@@ -131,6 +141,8 @@ public interface IDhApiWorldGenerator extends Closeable, IDhApiOverrideable
 	/**
 	 * Called before a new generator task is started. <br>
 	 * This can be used to run cleanup on existing tasks before new tasks are started.
+	 *
+	 * @since API 1.0.0
 	 */
 	void preGeneratorTaskStart();
 	

core/src/main/java/com/seibel/distanthorizons/core/Initializer.java

@@ -19,7 +19,9 @@
 
 package com.seibel.distanthorizons.core;
 
+import com.seibel.distanthorizons.core.dependencyInjection.SingletonInjector;
 import com.seibel.distanthorizons.core.file.DataSourceReferenceTracker;
+import com.seibel.distanthorizons.core.wrapperInterfaces.IWrapperFactory;
 import com.seibel.distanthorizons.coreapi.ModInfo;
 import com.seibel.distanthorizons.core.world.DhApiWorldProxy;
 import com.seibel.distanthorizons.core.api.external.methods.config.DhApiConfig;
@@ -67,6 +69,11 @@ public class Initializer
 		DhApi.Delayed.terrainRepo = DhApiTerrainDataRepo.INSTANCE;
 		DhApi.Delayed.worldProxy = DhApiWorldProxy.INSTANCE;
 		DhApi.Delayed.renderProxy = DhApiRenderProxy.INSTANCE;
+		DhApi.Delayed.wrapperFactory = SingletonInjector.INSTANCE.get(IWrapperFactory.class);
+		if (DhApi.Delayed.wrapperFactory == null)
+		{
+			LOGGER.error("Programmer Error: No ["+IWrapperFactory.class.getSimpleName()+"] assigned to the DhApi.");
+		}
 		
 		DataSourceReferenceTracker.startGarbageCollectorBackgroundThread();
 		

core/src/main/java/com/seibel/distanthorizons/core/wrapperInterfaces/IWrapperFactory.java

@@ -19,6 +19,7 @@
 
 package com.seibel.distanthorizons.core.wrapperInterfaces;
 
+import com.seibel.distanthorizons.api.interfaces.factories.IDhApiWrapperFactory;
 import com.seibel.distanthorizons.core.level.IDhLevel;
 import com.seibel.distanthorizons.core.wrapperInterfaces.block.IBlockStateWrapper;
 import com.seibel.distanthorizons.core.wrapperInterfaces.chunk.IChunkWrapper;
@@ -36,7 +37,7 @@ import java.util.HashSet;
  * @author James Seibel
  * @version 2022-12-5
  */
-public interface IWrapperFactory extends IBindable
+public interface IWrapperFactory extends IDhApiWrapperFactory, IBindable
 {
 	AbstractBatchGenerationEnvironmentWrapper createBatchGenerator(IDhLevel targetLevel);
 	IBiomeWrapper deserializeBiomeWrapper(String str, ILevelWrapper levelWrapper) throws IOException;