Package xyz.gmitch215.socketmc.screen.util

Class Sprite

java.lang.Object

xyz.gmitch215.socketmc.screen.util.Sprite

All Implemented Interfaces:

Serializable

public final class Sprite
extends Object
implements Serializable

Represents a Sprite to be displayed on a Screen.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Sprite	BUTTON	Represents an AbstractButton without a specified sprite.
static final Sprite	CHECKBOX	Represents a CheckboxButton.
static final Sprite	CROSS_BUTTON_REALMS	Represents the Cross Button used in the realms screen.
static final Sprite	RECIPE_BUTTON	Represents the Crafting Table Recipe Book Button.
static final Sprite	SCREEN_TAB_BUTTON	Represents the Tab Button for switch to a new screen.

Constructor Summary

Constructors

Constructor	Description
Sprite(@NotNull String enabled, @NotNull String disabled)	Constructs a new Sprite using Identifier.minecraft(String).
Sprite(@NotNull String enabled, @NotNull String enabledHovered, @NotNull String disabled, @NotNull String disabledHovered)	Constructs a new Sprite using Identifier.minecraft(String).
Sprite(@NotNull Identifier enabled, @NotNull Identifier disabled)	Constructs a new Sprite.
Sprite(@NotNull Identifier enabled, @NotNull Identifier enabledHovered, @NotNull Identifier disabled, @NotNull Identifier disabledHovered)	Constructs a new Sprite.

Method Summary

Modifier and Type	Method	Description
@NotNull Identifier	getDisabled()	Gets the Identifier for the Sprite when Disabled.
@NotNull Identifier	getDisabledHovered()	Gets the Identifier for the Sprite when Disabled, and mouse is hovering.
@NotNull Identifier	getEnabled()	Gets the Identifier for the Sprite when Enabled.
@NotNull Identifier	getEnabledHovered()	Gets the Identifier for the Sprite when Enabled, and mouse is hovering.
void	setDisabled(@NotNull Identifier disabled)	Sets the Identifier for the Sprite when Disabled.
void	setDisabledHovered(@NotNull Identifier disabledHovered)	Sets the Identifier for the Sprite when Disabled, and mouse is hovering.
void	setEnabled(@NotNull Identifier enabled)	Sets the Identifier for the Sprite when Enabled.
void	setEnabledHovered(@NotNull Identifier enabledHovered)	Sets the Identifier for the Sprite when Enabled, and mouse is hovering.

Methods inherited from class java.lang.Object

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

Field Details

BUTTON

public static final Sprite BUTTON

Represents an AbstractButton without a specified sprite.

CHECKBOX

public static final Sprite CHECKBOX

Represents a CheckboxButton.

RECIPE_BUTTON

public static final Sprite RECIPE_BUTTON

Represents the Crafting Table Recipe Book Button.

CROSS_BUTTON_REALMS

public static final Sprite CROSS_BUTTON_REALMS

Represents the Cross Button used in the realms screen.

SCREEN_TAB_BUTTON

public static final Sprite SCREEN_TAB_BUTTON

Represents the Tab Button for switch to a new screen.

Constructor Details

Sprite

public Sprite(@NotNull
 @NotNull String enabled,
 @NotNull
 @NotNull String disabled)

Constructs a new Sprite using Identifier.minecraft(String).

Parameters:

enabled - Sprite to display when Enabled

disabled - Sprite to display when Disabled

Sprite

public Sprite(@NotNull
 @NotNull String enabled,
 @NotNull
 @NotNull String enabledHovered,
 @NotNull
 @NotNull String disabled,
 @NotNull
 @NotNull String disabledHovered)

Constructs a new Sprite using Identifier.minecraft(String).

Parameters:

enabled - Sprite to display when Enabled

enabledHovered - Sprite to display when Enabled, and mouse is hovering

disabled - Sprite to display when Disabled

disabledHovered - Sprite to display when Disabled, and mouse is hovering

Sprite

public Sprite(@NotNull
 @NotNull Identifier enabled,
 @NotNull
 @NotNull Identifier disabled)

Constructs a new Sprite.

Parameters:

enabled - Sprite to display when Enabled

disabled - Sprite to display when Disabled

Sprite

public Sprite(@NotNull
 @NotNull Identifier enabled,
 @NotNull
 @NotNull Identifier enabledHovered,
 @NotNull
 @NotNull Identifier disabled,
 @NotNull
 @NotNull Identifier disabledHovered)
       throws IllegalArgumentException

Constructs a new Sprite.

Parameters:

enabled - Sprite to display when Enabled

enabledHovered - Sprite to display when Enabled, and mouse is hovering

disabled - Sprite to display when Disabled

disabledHovered - Sprite to display when Disabled, and mouse is hovering

Throws:

IllegalArgumentException - if any Identifier is null

Method Details

getEnabled

@NotNull
public @NotNull Identifier getEnabled()

Gets the Identifier for the Sprite when Enabled.

Returns:

Sprite Enabled Identifier

setEnabled

public void setEnabled(@NotNull
 @NotNull Identifier enabled)
                throws IllegalArgumentException

Sets the Identifier for the Sprite when Enabled.

Parameters:

enabled - Sprite Enabled Identifier

Throws:

IllegalArgumentException - if enabled is null

getEnabledHovered

@NotNull
public @NotNull Identifier getEnabledHovered()

Gets the Identifier for the Sprite when Enabled, and mouse is hovering.

Returns:

Sprite Enabled Focused Identifier

setEnabledHovered

public void setEnabledHovered(@NotNull
 @NotNull Identifier enabledHovered)
                       throws IllegalArgumentException

Sets the Identifier for the Sprite when Enabled, and mouse is hovering.

Parameters:

enabledHovered - Sprite Enabled Focused Identifier

Throws:

IllegalArgumentException - if enabledFocused is null

getDisabled

@NotNull
public @NotNull Identifier getDisabled()

Gets the Identifier for the Sprite when Disabled.

Returns:

Sprite Disabled Identifier

setDisabled

public void setDisabled(@NotNull
 @NotNull Identifier disabled)
                 throws IllegalArgumentException

Sets the Identifier for the Sprite when Disabled.

Parameters:

disabled - Sprite Disabled Identifier

Throws:

IllegalArgumentException - if disabled is null

getDisabledHovered

@NotNull
public @NotNull Identifier getDisabledHovered()

Gets the Identifier for the Sprite when Disabled, and mouse is hovering.

Returns:

Sprite Disabled Focused Identifier

setDisabledHovered

@NotNull
public void setDisabledHovered(@NotNull
 @NotNull Identifier disabledHovered)
                        throws IllegalArgumentException

Sets the Identifier for the Sprite when Disabled, and mouse is hovering.

Parameters:

disabledHovered - Sprite Disabled Focused Identifier

Throws:

IllegalArgumentException - if disabledFocused is null