diff --git a/api/src/main/java/com/seibel/distanthorizons/api/interfaces/IDhApiUnsafeWrapper.java b/api/src/main/java/com/seibel/distanthorizons/api/interfaces/IDhApiUnsafeWrapper.java index ba16b9e3e..030dc6137 100644 --- a/api/src/main/java/com/seibel/distanthorizons/api/interfaces/IDhApiUnsafeWrapper.java +++ b/api/src/main/java/com/seibel/distanthorizons/api/interfaces/IDhApiUnsafeWrapper.java @@ -19,6 +19,8 @@ package com.seibel.distanthorizons.api.interfaces; +import com.seibel.distanthorizons.api.interfaces.block.IDhApiBlockStateWrapper; + /** * Implemented by wrappers so developers can * access the underlying Minecraft object(s). @@ -38,7 +40,11 @@ public interface IDhApiUnsafeWrapper * In order to cast this object to something usable, you may want * to use obj.getClass() when in your IDE * in order to determine what object this method returns for - * the specific version of Minecraft you are developing for. + * the specific version of Minecraft you are developing for.

+ * + * Note:
+ * This method may return null in some cases, IE {@link IDhApiBlockStateWrapper} + * when it is wrapping air. */ Object getWrappedMcObject(); 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 5cfc89d3d..29b76d610 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 @@ -23,7 +23,10 @@ import com.seibel.distanthorizons.api.enums.rendering.EDhApiBlockMaterial; import com.seibel.distanthorizons.api.interfaces.IDhApiUnsafeWrapper; /** - * A Minecraft version independent way of handling Blocks. + * A Minecraft version independent way of handling Blocks.

+ * + * Note: the wrapped object (IE the object returned by {@link IDhApiUnsafeWrapper#getWrappedMcObject}) + * will be null if this object is wrapping air. * * @author James Seibel * @version 2023-6-11