Class UpdatableSpriteButton

java.lang.Object

net.minecraft.client.gui.components.AbstractWidget

net.minecraft.client.gui.components.AbstractWidget.WithInactiveMessage

net.minecraft.client.gui.components.AbstractButton

net.minecraft.client.gui.components.Button

net.minecraft.client.gui.components.SpriteIconButton

net.minecraft.client.gui.components.SpriteIconButton.CenteredIcon

net.dillon.dillonlib.platform.info.UpdatableSpriteButton

All Implemented Interfaces:

net.minecraft.client.gui.components.events.GuiEventListener, net.minecraft.client.gui.components.Renderable, net.minecraft.client.gui.components.TabOrderedElement, net.minecraft.client.gui.layouts.LayoutElement, net.minecraft.client.gui.narration.NarratableEntry, net.minecraft.client.gui.narration.NarrationSupplier

public class UpdatableSpriteButton
extends net.minecraft.client.gui.components.SpriteIconButton.CenteredIcon

Extends a normal SpriteIconButton, but with the update sprite automatically rendering if necessary.

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraft.client.gui.components.SpriteIconButton

net.minecraft.client.gui.components.SpriteIconButton.Builder, net.minecraft.client.gui.components.SpriteIconButton.CenteredIcon, net.minecraft.client.gui.components.SpriteIconButton.TextAndIcon

Nested classes/interfaces inherited from class net.minecraft.client.gui.components.Button

net.minecraft.client.gui.components.Button.CreateNarration, net.minecraft.client.gui.components.Button.OnPress, net.minecraft.client.gui.components.Button.Plain

Nested classes/interfaces inherited from class net.minecraft.client.gui.components.AbstractWidget

net.minecraft.client.gui.components.AbstractWidget.WithInactiveMessage

Nested classes/interfaces inherited from interface net.minecraft.client.gui.narration.NarratableEntry

net.minecraft.client.gui.narration.NarratableEntry.NarrationPriority

Field Summary

Fields inherited from class net.minecraft.client.gui.components.SpriteIconButton

sprite, spriteHeight, spriteOffsetX, spriteOffsetY, spriteWidth

Fields inherited from class net.minecraft.client.gui.components.Button

BIG_WIDTH, createNarration, DEFAULT_HEIGHT, DEFAULT_NARRATION, DEFAULT_SPACING, DEFAULT_WIDTH, onPress, SMALL_WIDTH

Fields inherited from class net.minecraft.client.gui.components.AbstractButton

SPRITES, TEXT_MARGIN

Fields inherited from class net.minecraft.client.gui.components.AbstractWidget

active, alpha, height, isHovered, message, packedFGColor, UNSET_FG_COLOR, visible, width

Method Summary

Modifier and Type	Method	Description
void	extractContents(net.minecraft.client.gui.GuiGraphicsExtractor graphics, int mouseX, int mouseY, float a)
String	getName()
static UpdatableSpriteButton	of(String name, net.minecraft.resources.Identifier sprite, net.minecraft.client.gui.components.Button.OnPress onPress, net.minecraft.network.chat.Component tooltip, int spriteWidth, int spriteHeight, boolean hasUpdate)	Creates a UpdatableSpriteButton with a custom sprite width and height.
static UpdatableSpriteButton	ofDefault(String name, net.minecraft.resources.Identifier sprite, net.minecraft.client.gui.components.Button.OnPress onPress, net.minecraft.network.chat.Component tooltip, boolean hasUpdate)	Creates a default UpdatableSpriteButton.
boolean	shouldRenderUpdateSprite()

Methods inherited from class net.minecraft.client.gui.components.SpriteIconButton

builder, extractLoadingStateIfLoading, extractSprite, isActive, onPress, setLoading, setLoading

Methods inherited from class net.minecraft.client.gui.components.Button

builder, createNarrationMessage, updateWidgetNarration

Methods inherited from class net.minecraft.client.gui.components.AbstractButton

extractDefaultLabel, extractDefaultSprite, extractWidgetRenderState, keyPressed, onClick, setOverrideRenderHighlightedSprite

Methods inherited from class net.minecraft.client.gui.components.AbstractWidget.WithInactiveMessage

defaultInactiveMessage, getMessage, setMessage

Methods inherited from class net.minecraft.client.gui.components.AbstractWidget

clearFGColor, defaultButtonNarrationText, extractRenderState, extractScrollingStringOverContents, extractTooltipForNextRenderPass, getAlpha, getBottom, getFGColor, getHeight, getRectangle, getRight, getTabOrderGroup, getWidth, getX, getY, handleCursor, isFocused, isHovered, isHoveredOrFocused, isMouseOver, isValidClickButton, mouseClicked, mouseDragged, mouseReleased, narrationPriority, nextFocusPath, onDrag, onRelease, playButtonClickSound, playDownSound, setAlpha, setFGColor, setFocused, setHeight, setRectangle, setSize, setTabOrderGroup, setTooltip, setTooltipDelay, setWidth, setX, setY, updateNarration, visitWidgets, wrapDefaultNarrationMessage

Methods inherited from class Object

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

Methods inherited from interface net.minecraft.client.gui.components.events.GuiEventListener

capturesInput, charTyped, getBorderForArrowNavigation, getCurrentFocusPath, keyReleased, mouseMoved, mouseScrolled, preeditUpdated, shouldTakeFocusAfterInteraction

Methods inherited from interface net.minecraft.client.gui.layouts.LayoutElement

setPosition

Methods inherited from interface net.minecraft.client.gui.narration.NarratableEntry

getNarratables

Method Details

extractContents

public void extractContents(net.minecraft.client.gui.GuiGraphicsExtractor graphics,
 int mouseX,
 int mouseY,
 float a)

Overrides:

extractContents in class net.minecraft.client.gui.components.SpriteIconButton.CenteredIcon

ofDefault

public static UpdatableSpriteButton ofDefault(String name,
 net.minecraft.resources.Identifier sprite,
 net.minecraft.client.gui.components.Button.OnPress onPress,
 net.minecraft.network.chat.Component tooltip,
 boolean hasUpdate)

Creates a default UpdatableSpriteButton.

of

public static UpdatableSpriteButton of(String name,
 net.minecraft.resources.Identifier sprite,
 net.minecraft.client.gui.components.Button.OnPress onPress,
 net.minecraft.network.chat.Component tooltip,
 int spriteWidth,
 int spriteHeight,
 boolean hasUpdate)

Creates a UpdatableSpriteButton with a custom sprite width and height.

getName

public String getName()

Returns:

the button libName, used for correct alphabetical ordering.

shouldRenderUpdateSprite

public boolean shouldRenderUpdateSprite()

Returns:

if the update sprite should render on the button.