io.github.cottonmc.cotton.gui

Interface GuiDescription

All Known Implementing Classes:

ConfigGui, LightweightGuiDescription, SyncedGuiDescription

public interface GuiDescription

A GUI description represents a GUI without depending on screens.

GUI descriptions contain the root panel and the property delegate of the GUI. They also manage the focused widget.

See Also:

LightweightGuiDescription, SyncedGuiDescription

Method Summary

Modifier and Type	Method and Description
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.
default void	cycleFocus(boolean lookForwards) Cycles the focused widget in the GUI.
@Nullable WWidget	getFocus() Gets the currently-focused WWidget.
@Nullable net.minecraft.screen.PropertyDelegate	getPropertyDelegate() Gets the object which manages the integer properties used by WBars and such.
WPanel	getRootPanel()
HorizontalAlignment	getTitleAlignment() Gets the horizontal alignment of the GUI title.
int	getTitleColor()
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.
void	releaseFocus(WWidget widget) Notifies this gui that the widget wants to give up its hold over focus.
void	requestFocus(WWidget widget) Notifies this gui that the widget wants to acquire focus.
void	setFullscreen(boolean fullscreen) Sets whether this GUI is fullscreen.
GuiDescription	setPropertyDelegate(net.minecraft.screen.PropertyDelegate delegate) Sets the object which manages the integer properties used by WBars
GuiDescription	setRootPanel(WPanel panel)
void	setTitleAlignment(HorizontalAlignment alignment) Sets the horizontal alignment of the GUI title.
GuiDescription	setTitleColor(int color) Sets the title color of this GUI.
GuiDescription	setTitleColor(int lightColor, int darkColor) Sets the light and dark title colors of this GUI.
void	setTitleVisible(boolean titleVisible) Sets whether the title of this GUI should be rendered by the screen.

Method Detail

getRootPanel

WPanel getRootPanel()

getTitleColor

int getTitleColor()

setRootPanel

GuiDescription setRootPanel(WPanel panel)

setTitleColor

GuiDescription setTitleColor(int color)

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.

Parameters:

color - the new title color

Returns:

this GUI

setTitleColor

GuiDescription setTitleColor(int lightColor,
                             int darkColor)

Sets the light and dark title colors of this GUI.

Parameters:

lightColor - the light-mode color

darkColor - the dark-mode color

Returns:

this GUI

Since:

2.1.0

setPropertyDelegate

GuiDescription setPropertyDelegate(net.minecraft.screen.PropertyDelegate delegate)

Sets the object which manages the integer properties used by WBars

addSlotPeer

void addSlotPeer(ValidatedSlot slot)

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

addPainters

@Environment(value=CLIENT)
void addPainters()

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

getPropertyDelegate

@Nullable
@Nullable net.minecraft.screen.PropertyDelegate getPropertyDelegate()

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

isFocused

boolean isFocused(WWidget widget)

Tests whether the widget is the currently-focused one.

getFocus

@Nullable
@Nullable WWidget getFocus()

Gets the currently-focused WWidget. May be null.

requestFocus

void requestFocus(WWidget widget)

Notifies this gui that the widget wants to acquire focus.

releaseFocus

void releaseFocus(WWidget widget)

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

cycleFocus

default void cycleFocus(boolean lookForwards)

Cycles the focused widget in the GUI.

Parameters:

lookForwards - whether this should cycle forwards (true) or backwards (false)

Since:

2.0.0

isFullscreen

boolean isFullscreen()

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.

Returns:

true if this GUI is fullscreen, false otherwise

Since:

2.0.0

setFullscreen

void setFullscreen(boolean fullscreen)

Sets whether this GUI is fullscreen.

Parameters:

fullscreen - true if this GUI is fullscreen, false otherwise

Since:

2.0.0

isTitleVisible

boolean isTitleVisible()

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.

Returns:

true if the title is visible, false otherwise

Since:

2.0.0

setTitleVisible

void setTitleVisible(boolean titleVisible)

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

Parameters:

titleVisible - true if the title is visible, false otherwise

Since:

2.0.0

getTitleAlignment

HorizontalAlignment getTitleAlignment()

Gets the horizontal alignment of the GUI title.

Returns:

the alignment

Since:

2.1.0

setTitleAlignment

void setTitleAlignment(HorizontalAlignment alignment)

Sets the horizontal alignment of the GUI title.

Parameters:

alignment - the new alignment

Since:

2.1.0