Module net.minestom.server

Package net.minestom.server.item.component

Record Class TooltipDisplay

java.lang.Object

java.lang.Record

net.minestom.server.item.component.TooltipDisplay

public record TooltipDisplay(boolean hideTooltip, Set<DataComponent<?>> hiddenComponents)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
static final Codec<TooltipDisplay>	CODEC
static final TooltipDisplay	EMPTY
static final NetworkBuffer.Type<TooltipDisplay>	NETWORK_TYPE

Constructor Summary

Constructors

Constructor	Description
TooltipDisplay(boolean hideTooltip, Set<DataComponent<?>> hiddenComponents)	Creates an instance of a TooltipDisplay 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.
Set<DataComponent<?>>	hiddenComponents()	Returns the value of the hiddenComponents record component.
boolean	hideTooltip()	Returns the value of the hideTooltip record component.
final String	toString()	Returns a string representation of this record class.
TooltipDisplay	with(DataComponent<?> component)
TooltipDisplay	withHideTooltip(boolean hide)
TooltipDisplay	without(DataComponent<?> component)

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final TooltipDisplay EMPTY

NETWORK_TYPE

public static final NetworkBuffer.Type<TooltipDisplay> NETWORK_TYPE

CODEC

public static final Codec<TooltipDisplay> CODEC

Constructor Details

TooltipDisplay

public TooltipDisplay(boolean hideTooltip,
 Set<DataComponent<?>> hiddenComponents)

Creates an instance of a TooltipDisplay record class.

Parameters:

hideTooltip - the value for the hideTooltip record component

hiddenComponents - the value for the hiddenComponents record component

Method Details

withHideTooltip

public TooltipDisplay withHideTooltip(boolean hide)

with

public TooltipDisplay with(DataComponent<?> component)

without

public TooltipDisplay without(DataComponent<?> component)

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 '=='.

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.

hideTooltip

public boolean hideTooltip()

Returns the value of the hideTooltip record component.

Returns:

the value of the hideTooltip record component

hiddenComponents

public Set<DataComponent<?>> hiddenComponents()

Returns the value of the hiddenComponents record component.

Returns:

the value of the hiddenComponents record component