Package io.github.cottonmc.cotton.gui.widget

Class WPlayerInvPanel

java.lang.Object

io.github.cottonmc.cotton.gui.widget.WWidget

io.github.cottonmc.cotton.gui.widget.WPanel

io.github.cottonmc.cotton.gui.widget.WPanelWithInsets

io.github.cottonmc.cotton.gui.widget.WPlainPanel

io.github.cottonmc.cotton.gui.widget.WPlayerInvPanel

public class WPlayerInvPanel
extends WPlainPanel

A player inventory widget that has a visually separate hotbar.

See Also:

• SyncedGuiDescription.createPlayerInventoryPanel()

Field Summary

Fields

Modifier and Type	Field	Description
protected final WItemSlot	hotbar	A 9 by 1 WItemSlot that represents the player's hotbar.
protected final WItemSlot	inventory	A 9 by 3 WItemSlot that represents the player's inventory.
protected final @Nullable WWidget	label	The label seen above inventory.

Fields inherited from class io.github.cottonmc.cotton.gui.widget.WPanelWithInsets

insets

Fields inherited from class io.github.cottonmc.cotton.gui.widget.WPanel

children

Fields inherited from class io.github.cottonmc.cotton.gui.widget.WWidget

height, host, parent, width, x, y

Constructor Summary

Constructors

Constructor	Description
WPlayerInvPanel(PlayerInventory playerInventory)	Constructs a player inventory panel with a label.
WPlayerInvPanel(PlayerInventory playerInventory, boolean hasLabel)	Constructs a player inventory panel.
WPlayerInvPanel(PlayerInventory playerInventory, @Nullable WWidget label)	Constructs a player inventory panel.

Method Summary

Modifier and Type	Method	Description
boolean	canResize()	Checks whether this widget can be resized using WWidget.setSize(int, int).
static WLabel	createInventoryLabel(PlayerInventory playerInventory)	Creates a vanilla-style inventory label for a player inventory.
WPanel	setBackgroundPainter(BackgroundPainter painter)	Sets the background painter of this inventory widget's slots.
void	validate(GuiDescription c)	Creates component peers and initializes animation data for this Widget and all its children.

Methods inherited from class io.github.cottonmc.cotton.gui.widget.WPlainPanel

add, add, setInsets

Methods inherited from class io.github.cottonmc.cotton.gui.widget.WPanelWithInsets

expandToFit, getInsets

Methods inherited from class io.github.cottonmc.cotton.gui.widget.WPanel

addPainters, expandToFit, getBackgroundPainter, hit, layout, onHidden, onShown, paint, remove, setHost, streamChildren, tick, toString

Methods inherited from class io.github.cottonmc.cotton.gui.widget.WWidget

addNarrations, addTooltip, canFocus, canHover, getAbsoluteX, getAbsoluteY, getFocusModel, getHeight, getHost, getParent, getWidth, getX, getY, hoveredProperty, isActivationKey, isFocused, isHovered, isNarratable, isWithinBounds, onCharTyped, onClick, onFocusGained, onFocusLost, onKeyPressed, onKeyReleased, onMouseDown, onMouseDrag, onMouseMove, onMouseScroll, onMouseUp, releaseFocus, renderTooltip, requestFocus, setHovered, setLocation, setParent, setSize, shouldRenderInDarkMode

Methods inherited from class java.lang.Object

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

Field Details

inventory

protected final WItemSlot inventory

A 9 by 3 WItemSlot that represents the player's inventory.

Since:

8.1.0

See Also:

• PlayerInventory

hotbar

protected final WItemSlot hotbar

A 9 by 1 WItemSlot that represents the player's hotbar.

Since:

8.1.0

See Also:

• PlayerInventory

label

@Nullable
protected final @Nullable WWidget label

The label seen above inventory.

In vanilla and WPlayerInvPanel(PlayerInventory), this label is always 'Inventory'

Since:

8.1.0

See Also:

• createInventoryLabel(PlayerInventory)

Constructor Details

WPlayerInvPanel

public WPlayerInvPanel(PlayerInventory playerInventory)

Constructs a player inventory panel with a label.

Parameters:

playerInventory - the player inventory

WPlayerInvPanel

public WPlayerInvPanel(PlayerInventory playerInventory,
 boolean hasLabel)

Constructs a player inventory panel.

Parameters:

playerInventory - the player inventory

hasLabel - whether there should be an "Inventory" label

Since:

2.0.0

WPlayerInvPanel

public WPlayerInvPanel(PlayerInventory playerInventory,
 @Nullable
 @Nullable WWidget label)

Constructs a player inventory panel.

Parameters:

playerInventory - the player inventory

label - the label widget, can be null

Since:

2.0.0

Method Details

canResize

public boolean canResize()

Description copied from class: WWidget

Checks whether this widget can be resized using WWidget.setSize(int, int).

Overrides:

canResize in class WPanel

Returns:

true if this widget can be resized, false otherwise

createInventoryLabel

public static WLabel createInventoryLabel(PlayerInventory playerInventory)

Creates a vanilla-style inventory label for a player inventory.

Parameters:

playerInventory - the player inventory

Returns:

the created label

Since:

3.1.0

setBackgroundPainter

@Environment(CLIENT)
public WPanel setBackgroundPainter(BackgroundPainter painter)

Sets the background painter of this inventory widget's slots.

Overrides:

setBackgroundPainter in class WPanel

Parameters:

painter - the new painter

Returns:

this panel

validate

public void validate(GuiDescription c)

Description copied from class: WPanel

Creates component peers and initializes animation data for this Widget and all its children. The host screen handler must clear any heavyweight peers from its records before this method is called.

This method must be called on the root panel of any screen once the widgets have been initialized.

Subclasses should call super.validate(c) to ensure that children are validated.

Overrides:

validate in class WPanel

Parameters:

c - the host GUI description