diff options
Diffstat (limited to 'src/main/java/dev/isxander/yacl3/api/OptionDescription.java')
-rw-r--r-- | src/main/java/dev/isxander/yacl3/api/OptionDescription.java | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/src/main/java/dev/isxander/yacl3/api/OptionDescription.java b/src/main/java/dev/isxander/yacl3/api/OptionDescription.java index 7336379..fce7e2f 100644 --- a/src/main/java/dev/isxander/yacl3/api/OptionDescription.java +++ b/src/main/java/dev/isxander/yacl3/api/OptionDescription.java @@ -128,7 +128,7 @@ public interface OptionDescription { * <p> * However, <strong>THIS IS NOT API SAFE!</strong> As part of the gui package, things * may change that could break compatibility with future versions of YACL. - * A helpful utility (that is also not API safe) is {@link ImageRenderer#getOrMakeAsync(ResourceLocation, Supplier)} + * A helpful utility (that is also not API safe) is {@link dev.isxander.yacl3.gui.image.ImageRendererManager#registerOrGetImage(ResourceLocation, Supplier)} * which will cache the image renderer for the whole game lifecycle and construct it asynchronously to the render thread. * @param image the image renderer to display * @return this builder @@ -136,6 +136,21 @@ public interface OptionDescription { Builder customImage(CompletableFuture<Optional<ImageRenderer>> image); /** + * Sets a custom image renderer to display with the description. + * This is useful for rendering other abstract things relevant to your mod. + * <p> + * However, <strong>THIS IS NOT API SAFE!</strong> As part of the gui package, things + * may change that could break compatibility with future versions of YACL. + * A helpful utility (that is also not API safe) is {@link dev.isxander.yacl3.gui.image.ImageRendererManager#registerOrGetImage(ResourceLocation, Supplier)} + * which will cache the image renderer for the whole game lifecycle and construct it asynchronously to the render thread. + * @param image the image renderer to display + * @return this builder + */ + default Builder customImage(ImageRenderer image) { + return this.customImage(CompletableFuture.completedFuture(Optional.of(image))); + } + + /** * Sets an animated GIF image to display with the description. This is backed by a regular minecraft resource * in your mod's /assets folder. * |