Class SyncedGuiDescription

java.lang.Object

net.minecraft.world.inventory.AbstractContainerMenu

io.github.cottonmc.cotton.gui.SyncedGuiDescription

All Implemented Interfaces:

GuiDescription

Direct Known Subclasses:

ItemSyncedGuiDescription

public class SyncedGuiDescription
extends net.minecraft.world.inventory.AbstractContainerMenu
implements GuiDescription

A screen handler-based GUI description for GUIs with slots.

Nested Class Summary

Nested classes/interfaces inherited from interface GuiDescription

GuiDescription.FocusChangeListener

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable net.minecraft.world.Container	blockInventory
protected int	darkTitleColor
protected @Nullable WWidget	focus
protected boolean	fullscreen
protected net.minecraft.world.entity.player.Inventory	playerInventory
protected @Nullable net.minecraft.world.inventory.ContainerData	propertyDelegate	Deprecated, for removal: This API element is subject to removal in a future version. Use the methods getContainerData() and setContainerData(ContainerData) instead.
protected WPanel	rootPanel
protected HorizontalAlignment	titleAlignment
protected int	titleColor
protected boolean	titleVisible
protected net.minecraft.world.level.Level	world	Deprecated, for removal: This API element is subject to removal in a future version. Use the method getLevel() instead.

Fields inherited from class net.minecraft.world.inventory.AbstractContainerMenu

CARRIED_SLOT_SIZE, containerId, QUICKCRAFT_HEADER_CONTINUE, QUICKCRAFT_HEADER_END, QUICKCRAFT_HEADER_START, QUICKCRAFT_TYPE_CHARITABLE, QUICKCRAFT_TYPE_CLONE, QUICKCRAFT_TYPE_GREEDY, SLOT_CLICKED_OUTSIDE, SLOT_SIZE, slots, SLOTS_PER_ROW

Constructor Summary

Constructors

Constructor	Description
SyncedGuiDescription(net.minecraft.world.inventory.MenuType<?> type, int syncId, net.minecraft.world.entity.player.Inventory playerInventory)	Constructs a new synced GUI description without a block inventory or a property delegate.
SyncedGuiDescription(net.minecraft.world.inventory.MenuType<?> type, int syncId, net.minecraft.world.entity.player.Inventory playerInventory, @Nullable net.minecraft.world.Container blockInventory, @Nullable net.minecraft.world.inventory.ContainerData containerData)	Constructs a new synced GUI description.

Method Summary

Modifier and Type	Method	Description
void	addFocusChangeListener(GuiDescription.FocusChangeListener listener)	Adds a listener that is called when the focused widget changes.
void	addPainters()	Guis should use this method to add clientside styles and BackgroundPainters to their controls
void	addSlotPeer(ValidatedSlot slot)	Typical users won't call this.
void	broadcastChanges()
WPlayerInvPanel	createPlayerInventoryPanel()	Creates a player inventory widget from this panel's player inventory.
WPlayerInvPanel	createPlayerInventoryPanel(boolean hasLabel)	Creates a player inventory widget from this panel's player inventory.
WPlayerInvPanel	createPlayerInventoryPanel(WWidget label)	Creates a player inventory widget from this panel's player inventory.
static net.minecraft.world.Container	getBlockInventory(net.minecraft.world.inventory.ContainerLevelAccess ctx)	Gets the block inventory at the context.
static net.minecraft.world.Container	getBlockInventory(net.minecraft.world.inventory.ContainerLevelAccess ctx, int size)	Gets the block inventory at the context.
static net.minecraft.world.inventory.ContainerData	getBlockPropertyDelegate(net.minecraft.world.inventory.ContainerLevelAccess ctx)	Gets the property delegate at the context.
static net.minecraft.world.inventory.ContainerData	getBlockPropertyDelegate(net.minecraft.world.inventory.ContainerLevelAccess ctx, int size)	Gets the property delegate at the context.
@Nullable net.minecraft.world.inventory.ContainerData	getContainerData()	Gets the object which manages the integer properties used by WBars and such.
@Nullable WWidget	getFocus()	Gets the currently-focused WWidget.
net.minecraft.world.level.Level	getLevel()	Returns the level of this GUI description's player.
final ScreenNetworking	getNetworking(NetworkSide side)	Gets a networking handler for the GUI description that is active on the specified side.
final NetworkSide	getNetworkSide()	Gets the network side this GUI description runs on.
final PacketSender	getPacketSender()	Gets the packet sender corresponding to this GUI's network side.
WPanel	getRootPanel()
HorizontalAlignment	getTitleAlignment()	Gets the horizontal alignment of the GUI title.
int	getTitleColor()
Vec2i	getTitlePos()	Gets the position of the screen title.
boolean	getUseDefaultRootBackground()	Tests whether the root panel should get a vanilla background in the default GuiDescription.addPainters() implementations.
net.minecraft.world.level.Level	getWorld()	Deprecated, for removal: This API element is subject to removal in a future version. Replaced with getLevel().
boolean	isFocused(WWidget widget)	Tests whether the widget is the currently-focused one.
boolean	isFullscreen()	Gets whether this GUI is fullscreen.
boolean	isTitleVisible()	Gets whether the title of this GUI should be rendered by the screen.
net.minecraft.world.item.ItemStack	quickMoveStack(net.minecraft.world.entity.player.Player player, int index)
<T> DataSlot<T>	registerDataSlot(ScreenMessageKey<T> key, T initialValue)	Registers an S2C data slot.
<T> DataSlot<T>	registerDataSlot(ScreenMessageKey<T> key, T initialValue, NetworkDirection networkDirection)	Registers a data slot.
void	releaseFocus(WWidget widget)	Notifies this gui that the widget wants to give up its hold over focus.
void	removed(net.minecraft.world.entity.player.Player player)
void	requestFocus(WWidget widget)	Notifies this gui that the widget wants to acquire focus.
void	sendDataSlotUpdates()	Checks for and sends data slot content updates.
GuiDescription	setContainerData(net.minecraft.world.inventory.ContainerData data)	Sets the object which manages the integer properties used by WBars.
void	setFullscreen(boolean fullscreen)	Sets whether this GUI is fullscreen.
SyncedGuiDescription	setRootPanel(WPanel panel)
void	setTitleAlignment(HorizontalAlignment titleAlignment)	Sets the horizontal alignment of the GUI title.
SyncedGuiDescription	setTitleColor(int color)	Sets the title color of this GUI.
SyncedGuiDescription	setTitleColor(int lightColor, int darkColor)	Sets the light and dark title colors of this GUI.
void	setTitlePos(Vec2i titlePos)	Sets the position of the screen title.
void	setTitleVisible(boolean titleVisible)	Sets whether the title of this GUI should be rendered by the screen.
void	setUseDefaultRootBackground(boolean useDefaultRootBackground)	Enables or disables the default vanilla background for root panels.
boolean	stillValid(net.minecraft.world.entity.player.Player entity)

Methods inherited from class net.minecraft.world.inventory.AbstractContainerMenu

addDataSlot, addDataSlots, addInventoryExtendedSlots, addInventoryHotbarSlots, addSlot, addSlotListener, addStandardInventorySlots, broadcastFullState, canDragTo, canItemQuickReplace, canTakeItemForPickAll, checkContainerDataCount, checkContainerSize, clearContainer, clicked, clickMenuButton, findSlot, getCarried, getItems, getQuickcraftHeader, getQuickcraftMask, getQuickCraftPlaceCount, getQuickcraftType, getRedstoneSignalFromBlockEntity, getRedstoneSignalFromContainer, getSlot, getStateId, getType, incrementStateId, initializeContents, isValidQuickcraftType, isValidSlotIndex, moveItemStackTo, removeSlotListener, resetQuickCraft, resumeRemoteUpdates, sendAllDataToRemote, setCarried, setData, setItem, setRemoteCarried, setRemoteSlot, setRemoteSlotUnsafe, setSelectedBundleItemIndex, setSynchronizer, slotsChanged, stillValid, suppressRemoteUpdates, transferState

Methods inherited from class Object

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

Methods inherited from interface GuiDescription

getPropertyDelegate, isDarkMode, setPropertyDelegate

Field Details

blockInventory

protected @Nullable net.minecraft.world.Container blockInventory

playerInventory

protected net.minecraft.world.entity.player.Inventory playerInventory

world

@Deprecated(forRemoval=true)
protected net.minecraft.world.level.Level world

Deprecated, for removal: This API element is subject to removal in a future version.

Use the method getLevel() instead.

propertyDelegate

@Deprecated(forRemoval=true)
protected @Nullable net.minecraft.world.inventory.ContainerData propertyDelegate

Deprecated, for removal: This API element is subject to removal in a future version.

Use the methods getContainerData() and setContainerData(ContainerData) instead.

rootPanel

protected WPanel rootPanel

titleColor

protected int titleColor

darkTitleColor

protected int darkTitleColor

fullscreen

protected boolean fullscreen

titleVisible

protected boolean titleVisible

titleAlignment

protected HorizontalAlignment titleAlignment

focus

protected @Nullable WWidget focus

Constructor Details

SyncedGuiDescription

public SyncedGuiDescription(net.minecraft.world.inventory.MenuType<?> type,
 int syncId,
 net.minecraft.world.entity.player.Inventory playerInventory)

Constructs a new synced GUI description without a block inventory or a property delegate.

Parameters:

type - the MenuType of this GUI description

syncId - the current sync ID

playerInventory - the player inventory of the player viewing this screen

SyncedGuiDescription

public SyncedGuiDescription(net.minecraft.world.inventory.MenuType<?> type,
 int syncId,
 net.minecraft.world.entity.player.Inventory playerInventory,
 @Nullable net.minecraft.world.Container blockInventory,
 @Nullable net.minecraft.world.inventory.ContainerData containerData)

Constructs a new synced GUI description.

Parameters:

type - the MenuType of this GUI description

syncId - the current sync ID

playerInventory - the player inventory of the player viewing this screen

blockInventory - the block inventory of a corresponding container block, or null if not found or applicable

containerData - a container data holder whose properties, if any, will automatically be added

Method Details

getRootPanel

public WPanel getRootPanel()

Specified by:

getRootPanel in interface GuiDescription

getTitleColor

public int getTitleColor()

Specified by:

getTitleColor in interface GuiDescription

setRootPanel

public SyncedGuiDescription setRootPanel(WPanel panel)

Specified by:

setRootPanel in interface GuiDescription

setTitleColor

public SyncedGuiDescription setTitleColor(int color)

Description copied from interface: GuiDescription

Sets the title color of this GUI.

The dark-mode title color will also be set by this method. If the specified color is WLabel.DEFAULT_TEXT_COLOR, the dark-mode color will be WLabel.DEFAULT_DARKMODE_TEXT_COLOR; otherwise it will be the specified color.

Specified by:

setTitleColor in interface GuiDescription

Parameters:

color - the new title color

Returns:

this GUI

setTitleColor

public SyncedGuiDescription setTitleColor(int lightColor,
 int darkColor)

Description copied from interface: GuiDescription

Sets the light and dark title colors of this GUI.

Specified by:

setTitleColor in interface GuiDescription

Parameters:

lightColor - the light-mode color

darkColor - the dark-mode color

Returns:

this GUI

addPainters

@Environment(CLIENT)
public void addPainters()

Description copied from interface: GuiDescription

Guis should use this method to add clientside styles and BackgroundPainters to their controls

Specified by:

addPainters in interface GuiDescription

getUseDefaultRootBackground

public boolean getUseDefaultRootBackground()

Description copied from interface: GuiDescription

Tests whether the root panel should get a vanilla background in the default GuiDescription.addPainters() implementations.

Specified by:

getUseDefaultRootBackground in interface GuiDescription

Returns:

true if the default background painter is applied, false otherwise

setUseDefaultRootBackground

public void setUseDefaultRootBackground(boolean useDefaultRootBackground)

Description copied from interface: GuiDescription

Enables or disables the default vanilla background for root panels.

Specified by:

setUseDefaultRootBackground in interface GuiDescription

Parameters:

useDefaultRootBackground - true if the default background painter is applied, false otherwise

See Also:

• GuiDescription.getUseDefaultRootBackground()

addSlotPeer

public void addSlotPeer(ValidatedSlot slot)

Description copied from interface: GuiDescription

Typical users won't call this. This adds a Slot to Container/Controller-based guis, and does nothing on lightweight guis.

Specified by:

addSlotPeer in interface GuiDescription

quickMoveStack

public net.minecraft.world.item.ItemStack quickMoveStack(net.minecraft.world.entity.player.Player player,
 int index)

Specified by:

quickMoveStack in class net.minecraft.world.inventory.AbstractContainerMenu

getContainerData

public @Nullable net.minecraft.world.inventory.ContainerData getContainerData()

Description copied from interface: GuiDescription

Gets the object which manages the integer properties used by WBars and such.

Specified by:

getContainerData in interface GuiDescription

setContainerData

public GuiDescription setContainerData(net.minecraft.world.inventory.ContainerData data)

Description copied from interface: GuiDescription

Sets the object which manages the integer properties used by WBars.

Specified by:

setContainerData in interface GuiDescription

createPlayerInventoryPanel

public WPlayerInvPanel createPlayerInventoryPanel()

Creates a player inventory widget from this panel's player inventory.

Returns:

the created inventory widget

createPlayerInventoryPanel

public WPlayerInvPanel createPlayerInventoryPanel(boolean hasLabel)

Creates a player inventory widget from this panel's player inventory.

Parameters:

hasLabel - whether the "Inventory" label should be displayed

Returns:

the created inventory widget

Since:

2.0.0

createPlayerInventoryPanel

public WPlayerInvPanel createPlayerInventoryPanel(WWidget label)

Creates a player inventory widget from this panel's player inventory.

Parameters:

label - the inventory label widget

Returns:

the created inventory widget

Since:

2.0.0

getBlockInventory

public static net.minecraft.world.Container getBlockInventory(net.minecraft.world.inventory.ContainerLevelAccess ctx)

Gets the block inventory at the context.

If no inventory is found, returns EmptyInventory.INSTANCE.

Searches for these implementations in the following order:

1. Blocks implementing InventoryProvider
2. Block entities implementing InventoryProvider
3. Block entities implementing Inventory

Parameters:

ctx - the context

Returns:

the found inventory

getBlockInventory

public static net.minecraft.world.Container getBlockInventory(net.minecraft.world.inventory.ContainerLevelAccess ctx,
 int size)

Gets the block inventory at the context.

If no inventory is found, returns a simple mutable inventory with the specified number of slots.

Searches for these implementations in the following order:

1. Blocks implementing InventoryProvider
2. Block entities implementing InventoryProvider
3. Block entities implementing Inventory

Parameters:

ctx - the context

size - the fallback inventory size

Returns:

the found inventory

Since:

2.0.0

getBlockPropertyDelegate

public static net.minecraft.world.inventory.ContainerData getBlockPropertyDelegate(net.minecraft.world.inventory.ContainerLevelAccess ctx)

Gets the property delegate at the context.

If no property delegate is found, returns an empty property delegate with no properties.

Searches for block entities implementing PropertyDelegateHolder.

Parameters:

ctx - the context

Returns:

the found property delegate

getBlockPropertyDelegate

public static net.minecraft.world.inventory.ContainerData getBlockPropertyDelegate(net.minecraft.world.inventory.ContainerLevelAccess ctx,
 int size)

Gets the property delegate at the context.

If no property delegate is found, returns an array property delegate with the specified number of properties.

Searches for block entities implementing PropertyDelegateHolder.

Parameters:

ctx - the context

size - the number of properties

Returns:

the found property delegate

Since:

2.0.0

stillValid

public boolean stillValid(net.minecraft.world.entity.player.Player entity)

Specified by:

stillValid in class net.minecraft.world.inventory.AbstractContainerMenu

removed

public void removed(net.minecraft.world.entity.player.Player player)

Overrides:

removed in class net.minecraft.world.inventory.AbstractContainerMenu

broadcastChanges

public void broadcastChanges()

Overrides:

broadcastChanges in class net.minecraft.world.inventory.AbstractContainerMenu

isFocused

public boolean isFocused(WWidget widget)

Description copied from interface: GuiDescription

Tests whether the widget is the currently-focused one.

Specified by:

isFocused in interface GuiDescription

getFocus

public @Nullable WWidget getFocus()

Description copied from interface: GuiDescription

Gets the currently-focused WWidget. May be null.

Specified by:

getFocus in interface GuiDescription

requestFocus

public void requestFocus(WWidget widget)

Description copied from interface: GuiDescription

Notifies this gui that the widget wants to acquire focus.

Specified by:

requestFocus in interface GuiDescription

releaseFocus

public void releaseFocus(WWidget widget)

Description copied from interface: GuiDescription

Notifies this gui that the widget wants to give up its hold over focus.

Specified by:

releaseFocus in interface GuiDescription

isFullscreen

public boolean isFullscreen()

Description copied from interface: GuiDescription

Gets whether this GUI is fullscreen.

Fullscreen GUIs have no default background painter and have the root panel stretched to fit the entire screen on the client.

Specified by:

isFullscreen in interface GuiDescription

Returns:

true if this GUI is fullscreen, false otherwise

setFullscreen

public void setFullscreen(boolean fullscreen)

Description copied from interface: GuiDescription

Sets whether this GUI is fullscreen.

Specified by:

setFullscreen in interface GuiDescription

Parameters:

fullscreen - true if this GUI is fullscreen, false otherwise

isTitleVisible

public boolean isTitleVisible()

Description copied from interface: GuiDescription

Gets whether the title of this GUI should be rendered by the screen.

Modders can disable this to render the title themselves with a widget.

Specified by:

isTitleVisible in interface GuiDescription

Returns:

true if the title is visible, false otherwise

setTitleVisible

public void setTitleVisible(boolean titleVisible)

Description copied from interface: GuiDescription

Sets whether the title of this GUI should be rendered by the screen.

Specified by:

setTitleVisible in interface GuiDescription

Parameters:

titleVisible - true if the title is visible, false otherwise

getTitleAlignment

public HorizontalAlignment getTitleAlignment()

Description copied from interface: GuiDescription

Gets the horizontal alignment of the GUI title.

Specified by:

getTitleAlignment in interface GuiDescription

Returns:

the alignment

setTitleAlignment

public void setTitleAlignment(HorizontalAlignment titleAlignment)

Description copied from interface: GuiDescription

Sets the horizontal alignment of the GUI title.

Specified by:

setTitleAlignment in interface GuiDescription

Parameters:

titleAlignment - the new alignment

getTitlePos

public Vec2i getTitlePos()

Description copied from interface: GuiDescription

Gets the position of the screen title.

Specified by:

getTitlePos in interface GuiDescription

Returns:

the title position

setTitlePos

public void setTitlePos(Vec2i titlePos)

Description copied from interface: GuiDescription

Sets the position of the screen title.

Specified by:

setTitlePos in interface GuiDescription

Parameters:

titlePos - the new title position

getWorld

@Deprecated(forRemoval=true)
public net.minecraft.world.level.Level getWorld()

Deprecated, for removal: This API element is subject to removal in a future version.

Replaced with getLevel().

Returns the world of this GUI description's player.

Returns:

the world of this GUI description's player

Since:

10.0.0

getLevel

public net.minecraft.world.level.Level getLevel()

Returns the level of this GUI description's player.

Returns:

the level of this GUI description's player

Since:

16.0.0

getNetworkSide

public final NetworkSide getNetworkSide()

Gets the network side this GUI description runs on.

Returns:

this GUI's network side

Since:

3.3.0

getPacketSender

public final PacketSender getPacketSender()

Gets the packet sender corresponding to this GUI's network side.

Returns:

the packet sender

Since:

3.3.0

getNetworking

public final ScreenNetworking getNetworking(NetworkSide side)

Gets a networking handler for the GUI description that is active on the specified side.

If the network side doesn't match the side of this GUI, returns a no-op networking handler that is still safe to use.

Parameters:

side - the network side, cannot be null

Returns:

the networking handler corresponding to the side

Since:

13.1.0

registerDataSlot

public <T> DataSlot<T> registerDataSlot(ScreenMessageKey<T> key,
 T initialValue,
 NetworkDirection networkDirection)

Registers a data slot.

This method must be called on both network sides in order for the data slot to sync properly.

The initial value of a data slot will not be synced.

For S2C item stack and int data slots, you should usually use vanilla/LibGui slots and property delegates, respectively.

Type Parameters:

T - the data slot content type

Parameters:

key - the key of the sync message, cannot be null

initialValue - the initial value of the data slot

networkDirection - the network direction to sync, cannot be null

Returns:

the data slot

Since:

13.1.0

registerDataSlot

public <T> DataSlot<T> registerDataSlot(ScreenMessageKey<T> key,
 T initialValue)

Registers an S2C data slot.

This method must be called on both network sides in order for the data slot to sync properly.

The initial value of a data slot will not be synced.

For item stack and int data slots, you should usually use vanilla/LibGui slots and property delegates, respectively.

Type Parameters:

T - the data slot content type

Parameters:

key - the key of the sync message, cannot be null

initialValue - the initial value of the data slot

Returns:

the data slot

Since:

13.1.0

sendDataSlotUpdates

public void sendDataSlotUpdates()

Checks for and sends data slot content updates.

This method is generally called automatically. If you need to manually sync data slots from the server to the client, prefer broadcastChanges().

Since:

13.1.0

addFocusChangeListener

public void addFocusChangeListener(GuiDescription.FocusChangeListener listener)

Description copied from interface: GuiDescription

Adds a listener that is called when the focused widget changes.

Specified by:

addFocusChangeListener in interface GuiDescription

Parameters:

listener - the listener