Up the API version 1.1.0 -> 2.0.0

There were several breaking changes and I forgot to up the major version number appropriately.
This commit is contained in:
James Seibel
2024-05-04 18:16:19 -05:00
parent e1ca398b8f
commit 7e45a98e8f
46 changed files with 58 additions and 58 deletions
@@ -123,7 +123,7 @@ public class DhApi
/**
* Used to create wrappers for Minecraft objects needed by other Distant Horizons API methods.
* @since API 1.1.0
* @since API 2.0.0
*/
public static IDhApiWrapperFactory wrapperFactory = null;
@@ -198,7 +198,7 @@ public class DhApi
/**
* Returns true if the thread this method was called from is owned by Distant Horizons.
* @since API 1.1.0
* @since API 2.0.0
*/
public static boolean isDhThread() { return Thread.currentThread().getName().startsWith(ModInfo.THREAD_NAME_PREFIX); }
@@ -23,7 +23,7 @@ package com.seibel.distanthorizons.api.enums.config;
* NONE, <br>
* NON_COLLIDING, <br>
*
* @since API 1.1.0
* @since API 2.0.0
* @version 2024-4-6
*/
public enum EDhApiBlocksToAvoid
@@ -29,7 +29,7 @@ package com.seibel.distanthorizons.api.enums.config;
* and should only be used for estimated comparisons.
*
* @version 2024-3-16
* @since API 1.1.0
* @since API 2.0.0
*/
public enum EDhApiDataCompressionMode
{
@@ -20,7 +20,7 @@
package com.seibel.distanthorizons.api.enums.config;
/**
* @since API 1.1.0
* @since API 2.0.0
* @version 2024-4-6
*/
public enum EDhApiGLErrorHandlingMode
@@ -20,7 +20,7 @@
package com.seibel.distanthorizons.api.enums.config;
/**
* @since API 1.1.0
* @since API 2.0.0
* @version 2024-4-6
*/
public enum EDhApiGlProfileMode
@@ -29,7 +29,7 @@ package com.seibel.distanthorizons.api.enums.config;
* @author Leetom
* @author James Seibel
* @version 2024-4-6
* @since API 1.1.0
* @since API 2.0.0
*/
public enum EDhApiGpuUploadMethod
{
@@ -24,7 +24,7 @@ package com.seibel.distanthorizons.api.enums.config;
* FADE_TO_DIRT <br>
* AS_DIRT <br>
*
* @since API 1.1.0
* @since API 2.0.0
* @version 2024-4-7
*/
public enum EDhApiGrassSideRendering
@@ -26,7 +26,7 @@ package com.seibel.distanthorizons.api.enums.config;
* HIGH <br>
* UNLIMITED <br>
*
* @since API 1.1.0
* @since API 2.0.0
* @version 2024-4-6
*/
public enum EDhApiHorizontalQuality
@@ -24,7 +24,7 @@ package com.seibel.distanthorizons.api.enums.config;
* ENABLED <br>
* DISABLED <br>
*
* @since API 1.1.0
* @since API 2.0.0
* @version 2024-4-6
*/
public enum EDhApiLodShading
@@ -22,7 +22,7 @@ package com.seibel.distanthorizons.api.enums.config;
import org.apache.logging.log4j.Level;
/**
* @since API 1.1.0
* @since API 2.0.0
* @version 2024-4-6
*/
public enum EDhApiLoggerMode
@@ -33,7 +33,7 @@ import com.seibel.distanthorizons.coreapi.util.MathUtil;
*
* @author James Seibel
* @author Leonardo Amato
* @since API 1.1.0
* @since API 2.0.0
* @version 2024-4-6
*/
public enum EDhApiMaxHorizontalResolution
@@ -30,7 +30,7 @@ package com.seibel.distanthorizons.api.enums.config;
* Determines how the multiplayer folders should be named.
*
* @author James Seibel
* @since API 1.1.0
* @since API 2.0.0
* @version 2024-4-6
*/
public enum EDhApiServerFolderNameMode
@@ -4,7 +4,7 @@ package com.seibel.distanthorizons.api.enums.config;
* STABLE, <br>
* NIGHTLY, <br><br>
*
* @since API 1.1.0
* @since API 2.0.0
* @version 2024-4-6
*/
public enum EDhApiUpdateBranch
@@ -28,7 +28,7 @@ package com.seibel.distanthorizons.api.enums.config;
* the vanilla Minecraft terrain.
*
* @author James Seibel
* @since API 1.1.0
* @since API 2.0.0
* @version 2024-4-6
*/
@Deprecated // not currently in use, if the config this enum represents is re-implemented, the deprecated flag can be removed
@@ -30,7 +30,7 @@ import com.seibel.distanthorizons.coreapi.util.MathUtil;
*
* @author Leonardo Amato
* @version 2024-4-6
* @since API 1.1.0
* @since API 2.0.0
*/
public enum EDhApiVerticalQuality
{
@@ -24,7 +24,7 @@ package com.seibel.distanthorizons.api.enums.config;
* VISUALLY_EQUAL <br><br>
*
* @version 2024-3-27
* @since API 1.1.0
* @since API 2.0.0
*/
public enum EDhApiWorldCompressionMode
{
@@ -30,7 +30,7 @@ import com.seibel.distanthorizons.api.enums.config.DisallowSelectingViaConfigGui
* HIGH, <br>
* EXTREME, <br>
*
* @since API 1.1.0
* @since API 2.0.0
* @version 2024-4-6
*/
public enum EDhApiQualityPreset
@@ -29,7 +29,7 @@ import com.seibel.distanthorizons.api.enums.config.DisallowSelectingViaConfigGui
* BALANCED, <br>
* AGGRESSIVE, <br>
*
* @since API 1.1.0
* @since API 2.0.0
* @version 2024-4-6
*/
public enum EDhApiThreadPreset
@@ -29,7 +29,7 @@ package com.seibel.distanthorizons.api.enums.rendering;
* @author Leetom
* @author James Seibel
* @version 2024-4-6
* @since API 1.1.0
* @since API 2.0.0
*/
public enum EDhApiDebugRendering
{
@@ -25,7 +25,7 @@ package com.seibel.distanthorizons.api.enums.rendering;
*
* @author James Seibel
* @version 2024-4-6
* @since API 1.1.0
* @since API 2.0.0
*/
public enum EDhApiFogColorMode
{
@@ -25,7 +25,7 @@ package com.seibel.distanthorizons.api.enums.rendering;
* FOG_DISABLED <br>
*
* @author James Seibel
* @since API 1.1.0
* @since API 2.0.0
* @version 2022-6-2
*/
public enum EDhApiFogDrawMode
@@ -26,7 +26,7 @@ package com.seibel.distanthorizons.api.enums.rendering;
*
* @author Leetom
* @version 2022-6-30
* @since API 1.1.0
* @since API 2.0.0
*/
public enum EDhApiFogFalloff
{
@@ -33,7 +33,7 @@ package com.seibel.distanthorizons.api.enums.rendering;
*
* @author Leetom
* @version 2024-4-6
* @since API 1.1.0
* @since API 2.0.0
*/
public enum EDhApiHeightFogMixMode
{
@@ -29,7 +29,7 @@ package com.seibel.distanthorizons.api.enums.rendering;
*
* @author Leetom
* @version 2024-4-6
* @since API 1.1.0
* @since API 2.0.0
*/
public enum EDhApiHeightFogMode
{
@@ -7,7 +7,7 @@ package com.seibel.distanthorizons.api.enums.rendering;
*
* @author James Seibel
* @version 2024-1-30
* @since API 1.1.0
* @since API 2.0.0
*/
public enum EDhApiRenderPass
{
@@ -24,7 +24,7 @@ package com.seibel.distanthorizons.api.enums.rendering;
* Debug <br>
* Disabled <br>
*
* @since API 1.1.0
* @since API 2.0.0
* @version 2024-4-6
*/
public enum EDhApiRendererMode
@@ -24,7 +24,7 @@ package com.seibel.distanthorizons.api.enums.rendering;
* FAKE, <br>
* COMPLETE, <br>
*
* @since API 1.1.0
* @since API 2.0.0
* @version 2024-4-6
*/
public enum EDhApiTransparency
@@ -31,7 +31,7 @@ import java.util.function.Consumer;
*
* @author Builderb0y, James Seibel
* @version 2023-12-21
* @since API 1.1.0
* @since API 2.0.0
*/
public enum EDhApiWorldGeneratorReturnType
{
@@ -40,7 +40,7 @@ public enum EDhApiWorldGeneratorReturnType
* {@link IDhApiWorldGenerator#generateChunks(int, int, byte, byte, EDhApiDistantGeneratorMode, ExecutorService, Consumer)}
* will be used when generating terrain.
*
* @since API 1.1.0
* @since API 2.0.0
*/
VANILLA_CHUNKS,
@@ -49,7 +49,7 @@ public enum EDhApiWorldGeneratorReturnType
* {@link IDhApiWorldGenerator#generateApiChunks(int, int, byte, byte, EDhApiDistantGeneratorMode, ExecutorService, Consumer)}
* will be used when generating terrain.
*
* @since API 1.1.0
* @since API 2.0.0
*/
API_CHUNKS;
@@ -47,7 +47,7 @@ public interface IDhApiConfigValue<T>
* Returns the value of the config if it was set by the API.
* Returns null if the config hasn't been set by the API.
*
* @since API 1.1.0
* @since API 2.0.0
*/
T getApiValue();
@@ -68,7 +68,7 @@ public interface IDhApiConfigValue<T>
* use the value set in the config menu.
*
* @return true if the value was set, false otherwise.
* @since API 1.1.0
* @since API 2.0.0
*/
boolean clearValue();
@@ -121,7 +121,7 @@ public interface IDhApiGraphicsConfig extends IDhApiConfigGroup
* Setting this to 0 will reduce/prevent holes in the world due to clipping to close to the camera
* but may cause overdraw issues with transparent or non-full blocks.
*
* @since API 1.1.0
* @since API 2.0.0
*/
IDhApiConfigValue<Double> overdrawPreventionRadius();
@@ -158,7 +158,7 @@ public interface IDhApiGraphicsConfig extends IDhApiConfigGroup
/**
* Determines how LODs should be shaded.
*
* @since API 1.1.0
* @since API 2.0.0
*/
IDhApiConfigValue<EDhApiLodShading> lodShading();
@@ -171,7 +171,7 @@ public interface IDhApiGraphicsConfig extends IDhApiConfigGroup
* start/stop rendering incorrectly based on the camera direction,
* but will also reduce FPS.
*
* @since API 1.1.0
* @since API 2.0.0
* @see IDhApiGraphicsConfig#disableShadowFrustumCulling()
*/
IDhApiConfigValue<Boolean> disableFrustumCulling();
@@ -183,7 +183,7 @@ public interface IDhApiGraphicsConfig extends IDhApiConfigGroup
*
* Disable this if shadows render incorrectly.
*
* @since API 1.1.0
* @since API 2.0.0
* @see IDhApiGraphicsConfig#disableFrustumCulling()
*/
IDhApiConfigValue<Boolean> disableShadowFrustumCulling();
@@ -31,7 +31,7 @@ import java.io.IOException;
*
* @author James Seibel
* @version 2023-12-16
* @since API 1.1.0
* @since API 2.0.0
*/
public interface IDhApiWrapperFactory
{
@@ -50,7 +50,7 @@ public interface IDhApiWrapperFactory
* @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
* @since API 2.0.0
*/
IDhApiBiomeWrapper getBiomeWrapper(Object[] objectArray, IDhApiLevelWrapper levelWrapper) throws ClassCastException;
@@ -67,13 +67,13 @@ public interface IDhApiWrapperFactory
* @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
* @since API 2.0.0
*/
IDhApiBlockStateWrapper getBlockStateWrapper(Object[] objectArray, IDhApiLevelWrapper levelWrapper) throws ClassCastException;
/**
* Returns the {@link IDhApiBlockStateWrapper} representing air.
* @since API 1.1.0
* @since API 2.0.0
*/
IDhApiBlockStateWrapper getAirBlockStateWrapper();
@@ -29,7 +29,7 @@ import com.seibel.distanthorizons.coreapi.util.math.Mat4f;
*
* @author James Seibel
* @version 2024-2-6
* @since API 1.1.0
* @since API 2.0.0
*/
public interface IDhApiCullingFrustum extends IDhApiOverrideable
{
@@ -24,7 +24,7 @@ import com.seibel.distanthorizons.api.interfaces.override.IDhApiOverrideable;
/**
* @author James Seibel
* @version 2024-1-24
* @since API 1.1.0
* @since API 2.0.0
*/
public interface IDhApiFramebuffer extends IDhApiOverrideable
{
@@ -27,7 +27,7 @@ import com.seibel.distanthorizons.coreapi.util.math.Vec3f;
/**
* @author James Seibel
* @version 2024-1-24
* @since API 1.1.0
* @since API 2.0.0
*/
public interface IDhApiShaderProgram extends IDhApiOverrideable
{
@@ -35,7 +35,7 @@ import com.seibel.distanthorizons.coreapi.util.math.Mat4f;
*
* @author James Seibel
* @version 2024-2-10
* @since API 1.1.0
* @since API 2.0.0
*/
public interface IDhApiShadowCullingFrustum extends IDhApiCullingFrustum
{
@@ -168,7 +168,7 @@ public interface IDhApiWorldGenerator extends Closeable, IDhApiOverrideable
*
* @return a future that should run on the worldGeneratorThreadPool and complete once the given generation task has completed.
*
* @since API 1.1.0
* @since API 2.0.0
*/
default CompletableFuture<Void> generateApiChunks(
int chunkPosMinX,
@@ -189,7 +189,7 @@ public interface IDhApiWorldGenerator extends Closeable, IDhApiOverrideable
* which means that {@link #generateChunks(int, int, byte, byte, EDhApiDistantGeneratorMode, ExecutorService, Consumer)}
* will be invoked whenever Distant Horizons wants to generate terrain with this world generator.
*
* @since API 1.1.0
* @since API 2.0.0
*/
default EDhApiWorldGeneratorReturnType getReturnType() { return EDhApiWorldGeneratorReturnType.VANILLA_CHUNKS; }
@@ -31,7 +31,7 @@ import com.seibel.distanthorizons.api.methods.events.sharedParameterObjects.DhAp
*
* @author James Seibel
* @version 2024-1-31
* @since API 1.1.0
* @since API 2.0.0
*/
public abstract class DhApiBeforeApplyShaderRenderEvent implements IDhApiCancelableEvent<DhApiRenderParam>
{
@@ -30,7 +30,7 @@ import com.seibel.distanthorizons.coreapi.util.math.Vec3f;
*
* @author James Seibel
* @version 2023-1-31
* @since API 1.1.0
* @since API 2.0.0
*
* @see DhApiBeforeRenderEvent
*/
@@ -29,7 +29,7 @@ import com.seibel.distanthorizons.api.interfaces.render.IDhApiRenderProxy;
*
* @author James Seibel
* @version 2024-1-22
* @since API 1.1.0
* @since API 2.0.0
*/
public abstract class DhApiBeforeDeferredRenderEvent extends DhApiBeforeRenderEvent
{
@@ -29,7 +29,7 @@ import com.seibel.distanthorizons.api.methods.events.sharedParameterObjects.DhAp
*
* @author James Seibel
* @version 2024-1-31
* @since API 1.1.0
* @since API 2.0.0
*/
public abstract class DhApiBeforeRenderCleanupEvent implements IDhApiEvent<DhApiRenderParam>
{
@@ -31,7 +31,7 @@ import com.seibel.distanthorizons.api.methods.events.sharedParameterObjects.DhAp
*
* @author James Seibel
* @version 2023-1-31
* @since API 1.1.0
* @since API 2.0.0
*
* @see DhApiBeforeRenderEvent
*/
@@ -29,7 +29,7 @@ import com.seibel.distanthorizons.api.methods.events.sharedParameterObjects.DhAp
*
* @author James Seibel
* @version 2024-1-31
* @since API 1.1.0
* @since API 2.0.0
*
* @see DhApiBeforeRenderPassEvent
*/
@@ -31,7 +31,7 @@ import com.seibel.distanthorizons.api.methods.events.sharedParameterObjects.DhAp
*
* @author James Seibel
* @version 2024-1-31
* @since API 1.1.0
* @since API 2.0.0
*/
public abstract class DhApiBeforeTextureClearEvent implements IDhApiCancelableEvent<DhApiRenderParam>
{
@@ -28,7 +28,7 @@ import com.seibel.distanthorizons.api.methods.events.sharedParameterObjects.DhAp
*
* @author James Seibel
* @version 2024-3-2
* @since API 1.1.0
* @since API 2.0.0
*/
public abstract class DhApiColorDepthTextureCreatedEvent implements IDhApiEvent<DhApiColorDepthTextureCreatedEvent.EventParam>
{
@@ -30,7 +30,7 @@ import java.util.List;
*
* @author Builderb0y, James Seibel
* @version 2023-12-21
* @since API 1.1.0
* @since API 2.0.0
*
* @see IDhApiWrapperFactory
* @see DhApiTerrainDataPoint
@@ -39,9 +39,9 @@ public final class ModInfo
public static boolean IS_DEV_BUILD = VERSION.toLowerCase().contains("dev");
/** This version should only be updated when breaking changes are introduced to the DH API */
public static final int API_MAJOR_VERSION = 1;
public static final int API_MAJOR_VERSION = 2;
/** This version should be updated whenever new methods are added to the DH API */
public static final int API_MINOR_VERSION = 1;
public static final int API_MINOR_VERSION = 0;
/** This version should be updated whenever non-breaking fixes are added to the DH API */
public static final int API_PATH_VERSION = 0;