Package codechicken.lib.gui.modular.elements

Class GuiItemStack

java.lang.Object

codechicken.lib.gui.modular.lib.geometry.ConstrainedGeometry<T>

codechicken.lib.gui.modular.elements.GuiElement<GuiItemStack>

codechicken.lib.gui.modular.elements.GuiItemStack

All Implemented Interfaces:

BackgroundRender, ElementEvents, GuiParent<GuiItemStack>, TooltipHandler<GuiItemStack>

public class GuiItemStack
extends GuiElement<GuiItemStack>
implements BackgroundRender

A simple gui element that renders an item stack. This width and height of this element should be constrained to the same value, The stack size is based on the element size. constrain size to 16x16 for the standard gui stack size.

Created by brandon3055 on 03/09/2023

Field Summary

Fields inherited from class codechicken.lib.gui.modular.elements.GuiElement

hoverTime, initialized

Constructor Summary

Constructors

Constructor	Description
GuiItemStack(@NotNull GuiParent<?> parent)
GuiItemStack(@NotNull GuiParent<?> parent, Supplier<net.minecraft.world.item.ItemStack> provider)
GuiItemStack(@NotNull GuiParent<?> parent, net.minecraft.world.item.ItemStack itemStack)

Method Summary

Modifier and Type	Method	Description
GuiItemStack	enableStackDecoration(boolean enableDecoration)	Enable item stack decorations.
GuiItemStack	enableStackDecoration(Supplier<Boolean> enableDecoration)	Enable item stack decorations.
GuiItemStack	enableStackToolTip(boolean enableToolTip)	Enable the default item stack tooltip.
GuiItemStack	enableStackToolTip(Supplier<Boolean> enableToolTip)	Enable the default item stack tooltip.
double	getBackgroundDepth()	Specifies the z depth of the background content.
double	getStackSize()
void	renderBackground(GuiRender render, double mouseX, double mouseY, float partialTicks)	Used to render content behind this elements child elements.
boolean	renderOverlay(GuiRender render, double mouseX, double mouseY, float partialTicks, boolean consumed)	Used to render overlay's such as hover text.
GuiItemStack	setStack(Supplier<net.minecraft.world.item.ItemStack> stackProvider)
GuiItemStack	setStack(net.minecraft.world.item.ItemStack stack)

Methods inherited from class codechicken.lib.gui.modular.elements.GuiElement

addChild, addJeiDropTargets, addJeiExclusions, adoptChild, applyQueuedChildUpdates, blockMouseEvents, blockMouseOver, bringChildToForeground, font, getChildren, getCombinedElementDepth, getJeiDropConsumer, getModularGui, getParent, getTooltip, getTooltipDelay, hoverTime, initElement, isDescendantOf, isEnabled, isJeiDropTarget, isJeiExcluded, isMouseOver, isOpaque, isRemoved, isTooltipEnabled, jeiExclude, mc, onScreenInit, removeChild, render, renderChild, scaledScreenHeight, scaledScreenWidth, sendChildToBackground, sendChildToIndex, setEnabled, setEnabled, setEnableToolTip, setJeiDropTarget, setJeiExcluded, setOpaque, setRenderCull, setTooltip, setTooltipDelay, setZStacking, showToolTip, tick, toString, updateMouseOver, updateScreenData, zStacking

Methods inherited from class codechicken.lib.gui.modular.lib.geometry.ConstrainedGeometry

addBoundsToRect, clearConstraints, clearGeometryCache, constrain, get, getChildBounds, getEnclosingRect, getParent, getPosition, getRectangle, placeInside, placeInside, placeOutside, placeOutside, setHeight, setPos, setSize, setWidth, setXPos, setYPos, strictMode, validate, xCenter, xMax, xMin, xSize, yCenter, yMax, yMin, ySize

Methods inherited from class java.lang.Object

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

Methods inherited from interface codechicken.lib.gui.modular.lib.ElementEvents

charTyped, charTyped, keyPressed, keyPressed, keyReleased, keyReleased, mouseClicked, mouseClicked, mouseMoved, mouseReleased, mouseReleased, mouseScrolled, mouseScrolled

Methods inherited from interface codechicken.lib.gui.modular.lib.geometry.GuiParent

addChild, getValue

Methods inherited from interface codechicken.lib.gui.modular.lib.TooltipHandler

renderTooltip, setTooltip, setTooltip, setTooltip, setTooltipSingle, setTooltipSingle

Constructor Details

GuiItemStack

public GuiItemStack(@NotNull
 @NotNull GuiParent<?> parent)

GuiItemStack

public GuiItemStack(@NotNull
 @NotNull GuiParent<?> parent,
 net.minecraft.world.item.ItemStack itemStack)

GuiItemStack

public GuiItemStack(@NotNull
 @NotNull GuiParent<?> parent,
 Supplier<net.minecraft.world.item.ItemStack> provider)

Method Details

setStack

public GuiItemStack setStack(Supplier<net.minecraft.world.item.ItemStack> stackProvider)

setStack

public GuiItemStack setStack(net.minecraft.world.item.ItemStack stack)

enableStackDecoration

public GuiItemStack enableStackDecoration(boolean enableDecoration)

Enable item stack decorations. Meaning, Damage bar, Stack size, Item cool down, etc. (Default Enabled)

enableStackDecoration

public GuiItemStack enableStackDecoration(Supplier<Boolean> enableDecoration)

Enable item stack decorations. Meaning, Damage bar, Stack size, Item cool down, etc. (Default Enabled)

enableStackToolTip

public GuiItemStack enableStackToolTip(boolean enableToolTip)

Enable the default item stack tooltip. (Default Enabled) Note: If the GuiItemStack element has a tooltip applied via one of the element #setTooltip methods, That will override the item stack tool tip.

enableStackToolTip

public GuiItemStack enableStackToolTip(Supplier<Boolean> enableToolTip)

Enable the default item stack tooltip. (Default Enabled) Note: If the GuiItemStack element has a tooltip applied via one of the element #setTooltip methods, That will override the item stack tool tip.

getStackSize

public double getStackSize()

getBackgroundDepth

public double getBackgroundDepth()

Description copied from interface: BackgroundRender

Specifies the z depth of the background content. After BackgroundRender.renderBackground(GuiRender, double, double, float) is called, the PoseStack will be translated by this amount in the z direction before any assigned child elements are rendered. Recommended minimum depth is 0.01 or 0.035 if this element renders text. (text shadows are rendered with a 0.03 offset)

Specified by:

getBackgroundDepth in interface BackgroundRender

Returns:

the z height of the background content.

renderBackground

public void renderBackground(GuiRender render,
 double mouseX,
 double mouseY,
 float partialTicks)

Description copied from interface: BackgroundRender

Used to render content behind this elements child elements. When rendering element content, always use the PoseStack available via the provided GuiRender Where applicable, always use push/pop to ensure the stack is returned to its original state after your rendering is complete.

Specified by:

renderBackground in interface BackgroundRender

Parameters:

render - Contains gui context information as well as essential render methods/utils including the PoseStack.

renderOverlay

public boolean renderOverlay(GuiRender render,
 double mouseX,
 double mouseY,
 float partialTicks,
 boolean consumed)

Description copied from class: GuiElement

Used to render overlay's such as hover text. Anything rendered in this method will be rendered on top of everything else on the screen. Only one overlay should be rendered at a time, When an element renders content via the overlay method it must return true to indicate the render call has been 'consumed' If the render call has already been consumed (Check via the consumed boolean) then this element should avoid rendering its overlay.

When rendering overlay content, always use the PoseStack available via the provided GuiRender This stack will already have the correct Z translation to ensure the overlay renders above everything else on the screen.

To check if the cursor is over this element, use 'render.hoveredElement() == this' GuiElement.isMouseOver() Will also work, but may be problematic when multiple, stacked elements have overlay content.

Overrides:

renderOverlay in class GuiElement<GuiItemStack>

Parameters:

render - Contains gui context information as well as essential render methods/utils including the PoseStack.

mouseX - Current mouse X position

mouseY - Current mouse Y position

partialTicks - Partial render ticks

consumed - Will be true if the overlay render call has already been consumed by another element.

Returns:

true if the render call has been consumed.