Record Class DialogBody.Item

java.lang.Object

java.lang.Record

fr.fidorial.dialog.DialogBody.Item

Record Components:

item - the stack to display

description - an optional label shown next to the item

showDecoration - whether the stack count and damage bar are drawn over the item

showTooltip - whether hovering the item pops its tooltip up

width - horizontal size of the element, between 1 and 256

height - vertical size of the element, between 1 and 256

All Implemented Interfaces:

DialogBody

Enclosing interface:

DialogBody

public static record DialogBody.Item(ItemStack item, @Nullable DialogBody.PlainMessage description, boolean showDecoration, boolean showTooltip, int width, int height)
extends Record
implements DialogBody

An item, rendered as if it were sitting in an inventory slot.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DialogBody.Item.Builder	Fluent builder for DialogBody.Item.

Nested classes/interfaces inherited from interface DialogBody

DialogBody.Item, DialogBody.PlainMessage

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_ITEM_SIZE	Default width and height of an item body element, matching a vanilla inventory slot.
static final int	MAX_ITEM_SIZE	Largest width or height the client accepts for an item body element.

Fields inherited from interface DialogBody

DEFAULT_WIDTH, MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
Item(ItemStack item, @Nullable DialogBody.PlainMessage description, boolean showDecoration, boolean showTooltip, int width, int height)	Creates an instance of a Item record class.

Method Summary

Modifier and Type	Method	Description
@Nullable DialogBody.PlainMessage	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	height()	Returns the value of the height record component.
ItemStack	item()	Returns the value of the item record component.
boolean	showDecoration()	Returns the value of the showDecoration record component.
boolean	showTooltip()	Returns the value of the showTooltip record component.
final String	toString()	Returns a string representation of this record class.
int	width()	Returns the value of the width record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

MAX_ITEM_SIZE

public static final int MAX_ITEM_SIZE

Largest width or height the client accepts for an item body element.

Since:

0.1.0

See Also:

• Constant Field Values

DEFAULT_ITEM_SIZE

public static final int DEFAULT_ITEM_SIZE

Default width and height of an item body element, matching a vanilla inventory slot.

Since:

0.1.0

See Also:

• Constant Field Values

Constructor Details

Item

public Item(ItemStack item,
 @Nullable DialogBody.PlainMessage description,
 boolean showDecoration,
 boolean showTooltip,
 int width,
 int height)

Creates an instance of a Item record class.

Parameters:

item - the value for the item record component

description - the value for the description record component

showDecoration - the value for the showDecoration record component

showTooltip - the value for the showTooltip record component

width - the value for the width record component

height - the value for the height record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

item

public ItemStack item()

Returns the value of the item record component.

Returns:

the value of the item record component

description

public @Nullable DialogBody.PlainMessage description()

Returns the value of the description record component.

Returns:

the value of the description record component

showDecoration

public boolean showDecoration()

Returns the value of the showDecoration record component.

Returns:

the value of the showDecoration record component

showTooltip

public boolean showTooltip()

Returns the value of the showTooltip record component.

Returns:

the value of the showTooltip record component

width

public int width()

Returns the value of the width record component.

Returns:

the value of the width record component

height

public int height()

Returns the value of the height record component.

Returns:

the value of the height record component