Class AdvancementRenderer

java.lang.Object

net.fabricmc.fabric.api.client.rendering.v1.advancement.AdvancementRenderer

public final class AdvancementRenderer
extends Object

Advancement renderers allow for custom advancement icons, frames, and backgrounds which render in the advancements screen and advancement toasts.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AdvancementRenderer.BackgroundRenderer	Called after the background of an advancement tab renders.
static interface	AdvancementRenderer.FrameRenderer	Called after the frame of an advancement renders.
static interface	AdvancementRenderer.IconRenderer	Called after the icon (display item) of an advancement renders.

Method Summary

Modifier and Type	Method	Description
static void	registerBackground(AdvancementRenderer.BackgroundRenderer backgroundRenderer, net.minecraft.resources.Identifier... advancementIds)	Registers a AdvancementRenderer.BackgroundRenderer for the backgrounds of advancement tabs.
static void	registerFrame(AdvancementRenderer.FrameRenderer frameRenderer, net.minecraft.resources.Identifier... advancementIds)	Registers a AdvancementRenderer.FrameRenderer for advancement frames that show on advancement widgets.
static void	registerIcon(AdvancementRenderer.IconRenderer iconRenderer, net.minecraft.resources.Identifier... advancementIds)	Registers an AdvancementRenderer.IconRenderer for advancement icons that show on advancement widgets, tabs, and toasts.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

registerIcon

public static void registerIcon(AdvancementRenderer.IconRenderer iconRenderer,
 net.minecraft.resources.Identifier... advancementIds)

Registers an AdvancementRenderer.IconRenderer for advancement icons that show on advancement widgets, tabs, and toasts.

Parameters:

iconRenderer - the icon renderer

advancementIds - identifiers of the advancements

Throws:

IllegalArgumentException - if an advancement already has a registered icon renderer

NullPointerException - if either an advancement id or the icon renderer is null

registerFrame

public static void registerFrame(AdvancementRenderer.FrameRenderer frameRenderer,
 net.minecraft.resources.Identifier... advancementIds)

Registers a AdvancementRenderer.FrameRenderer for advancement frames that show on advancement widgets.

Parameters:

frameRenderer - the frame renderer

advancementIds - identifiers of the advancements

Throws:

IllegalArgumentException - if an advancement already has a registered frame renderer

NullPointerException - if either an advancement id or the frame renderer is null

registerBackground

public static void registerBackground(AdvancementRenderer.BackgroundRenderer backgroundRenderer,
 net.minecraft.resources.Identifier... advancementIds)

Registers a AdvancementRenderer.BackgroundRenderer for the backgrounds of advancement tabs.

Only root advancements render their backgrounds.

Parameters:

backgroundRenderer - the frame renderer

advancementIds - identifiers of the advancements

Throws:

IllegalArgumentException - if an advancement already has a registered background renderer

NullPointerException - if either an advancement id or the background renderer is null