From fbe81021c0775ad58191adb8847709cd6242cf5c Mon Sep 17 00:00:00 2001 From: James Seibel Date: Sun, 28 Jul 2024 08:55:35 -0500 Subject: [PATCH] Update API javadocs --- .../distanthorizons/api/enums/EDhApiDetailLevel.java | 2 +- .../api/enums/rendering/EDhApiBlockMaterial.java | 1 + .../api/interfaces/block/IDhApiBlockStateWrapper.java | 7 ++++++- .../api/interfaces/world/IDhApiLevelWrapper.java | 4 +++- 4 files changed, 11 insertions(+), 3 deletions(-) diff --git a/api/src/main/java/com/seibel/distanthorizons/api/enums/EDhApiDetailLevel.java b/api/src/main/java/com/seibel/distanthorizons/api/enums/EDhApiDetailLevel.java index 46a68b531..9721c68e6 100644 --- a/api/src/main/java/com/seibel/distanthorizons/api/enums/EDhApiDetailLevel.java +++ b/api/src/main/java/com/seibel/distanthorizons/api/enums/EDhApiDetailLevel.java @@ -24,7 +24,7 @@ package com.seibel.distanthorizons.api.enums; * CHUNK - Detail Level: 4, width 16 block,
* REGION - Detail Level: 9, width 512 block

* - * Detail levels in Distant Horizons represent how large a section (of either LODs or MC chunks) + * Detail levels in Distant Horizons represent how large a LOD * is, with the smallest being 0 (1 block wide).
* The width of a detail level can be calculated by putting the detail level to the power of 2.
* Example for the chunk detail level (4): 2^4 = 16 blocks wide

diff --git a/api/src/main/java/com/seibel/distanthorizons/api/enums/rendering/EDhApiBlockMaterial.java b/api/src/main/java/com/seibel/distanthorizons/api/enums/rendering/EDhApiBlockMaterial.java index dfedf3278..a3dbb674b 100644 --- a/api/src/main/java/com/seibel/distanthorizons/api/enums/rendering/EDhApiBlockMaterial.java +++ b/api/src/main/java/com/seibel/distanthorizons/api/enums/rendering/EDhApiBlockMaterial.java @@ -21,6 +21,7 @@ package com.seibel.distanthorizons.api.enums.rendering; * AIR,
* ILLUMINATED,
* + * @author IMS * @author James Seibel * @since API 3.0.0 * @version 2024-7-11 diff --git a/api/src/main/java/com/seibel/distanthorizons/api/interfaces/block/IDhApiBlockStateWrapper.java b/api/src/main/java/com/seibel/distanthorizons/api/interfaces/block/IDhApiBlockStateWrapper.java index 8a71a090f..7539fbb1d 100644 --- a/api/src/main/java/com/seibel/distanthorizons/api/interfaces/block/IDhApiBlockStateWrapper.java +++ b/api/src/main/java/com/seibel/distanthorizons/api/interfaces/block/IDhApiBlockStateWrapper.java @@ -19,6 +19,7 @@ package com.seibel.distanthorizons.api.interfaces.block; +import com.seibel.distanthorizons.api.enums.rendering.EDhApiBlockMaterial; import com.seibel.distanthorizons.api.interfaces.IDhApiUnsafeWrapper; /** @@ -44,7 +45,11 @@ public interface IDhApiBlockStateWrapper extends IDhApiUnsafeWrapper * @since API 3.0.0 */ String getSerialString(); - /** @since API 3.0.0 */ + /** + * Returns the byte value representing the {@link EDhApiBlockMaterial} enum. + * @see EDhApiBlockMaterial + * @since API 3.0.0 + */ byte getMaterialId(); } diff --git a/api/src/main/java/com/seibel/distanthorizons/api/interfaces/world/IDhApiLevelWrapper.java b/api/src/main/java/com/seibel/distanthorizons/api/interfaces/world/IDhApiLevelWrapper.java index ee28ad06a..4513b6a82 100644 --- a/api/src/main/java/com/seibel/distanthorizons/api/interfaces/world/IDhApiLevelWrapper.java +++ b/api/src/main/java/com/seibel/distanthorizons/api/interfaces/world/IDhApiLevelWrapper.java @@ -28,7 +28,7 @@ import com.seibel.distanthorizons.api.interfaces.render.IDhApiCustomRenderRegist * A level is equivalent to a dimension in vanilla Minecraft. * * @author James Seibel - * @version 2022-7-14 + * @version 2024-7-28 * @since API 1.0.0 */ public interface IDhApiLevelWrapper extends IDhApiUnsafeWrapper @@ -53,6 +53,8 @@ public interface IDhApiLevelWrapper extends IDhApiUnsafeWrapper /** * Will return null if called on the server, * or if called before the renderer has been set up. + * + * @since API 3.0.0 */ IDhApiCustomRenderRegister getRenderRegister();