Record Class CommonButtonData

java.lang.Object

java.lang.Record

net.minecraft.server.dialog.CommonButtonData

public record CommonButtonData(Component label, Optional<Component> tooltip, int width)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_WIDTH
private final Component	label	The field for the label record component.
static final com.mojang.serialization.MapCodec<CommonButtonData>	MAP_CODEC
private final Optional<Component>	tooltip	The field for the tooltip record component.
private final int	width	The field for the width record component.

Constructor Summary

Constructors

Constructor	Description
CommonButtonData(Component label, int width)
CommonButtonData(Component label, Optional<Component> tooltip, int width)	Creates an instance of a CommonButtonData record class.

Method Summary

Modifier and Type	Method	Description
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.
Component	label()	Returns the value of the label record component.
Optional<Component>	tooltip()	Returns the value of the tooltip 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

label

private final Component label

The field for the label record component.

tooltip

private final Optional<Component> tooltip

The field for the tooltip record component.

width

private final int width

The field for the width record component.

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

See Also:

• Constant Field Values

MAP_CODEC

public static final com.mojang.serialization.MapCodec<CommonButtonData> MAP_CODEC

Constructor Details

CommonButtonData

public CommonButtonData(Component label,
 int width)

CommonButtonData

public CommonButtonData(Component label,
 Optional<Component> tooltip,
 int width)

Creates an instance of a CommonButtonData record class.

Parameters:

label - the value for the label record component

tooltip - the value for the tooltip record component

width - the value for the width 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.

label

public Component label()

Returns the value of the label record component.

Returns:

the value of the label record component

tooltip

public Optional<Component> tooltip()

Returns the value of the tooltip record component.

Returns:

the value of the tooltip record component

width

public int width()

Returns the value of the width record component.

Returns:

the value of the width record component