Record Class ScoreboardObjectivePacket

java.lang.Object

java.lang.Record

net.minestom.server.network.packet.server.play.ScoreboardObjectivePacket

All Implemented Interfaces:

ComponentHolder<ServerPacket>, SendablePacket, ServerPacket, ServerPacket.ComponentHolding, ServerPacket.Play

public record ScoreboardObjectivePacket(String objectiveName, byte mode, @Nullable Component objectiveValue, @Nullable ScoreboardObjectivePacket.Type type, Sidebar.NumberFormat numberFormat)
extends Record
implements ServerPacket.Play, ServerPacket.ComponentHolding

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ScoreboardObjectivePacket.Type	This enumeration represents all available types for the scoreboard objective

Nested classes/interfaces inherited from interface ServerPacket

ServerPacket.ComponentHolding, ServerPacket.Configuration, ServerPacket.Login, ServerPacket.Play, ServerPacket.Status

Field Summary

Fields

Modifier and Type	Field	Description
static final NetworkBuffer.Type<ScoreboardObjectivePacket>	SERIALIZER

Constructor Summary

Constructors

Constructor	Description
ScoreboardObjectivePacket(String objectiveName, byte mode, @Nullable Component objectiveValue, @Nullable ScoreboardObjectivePacket.Type type, Sidebar.NumberFormat numberFormat)	Creates an instance of a ScoreboardObjectivePacket record class.

Method Summary

Modifier and Type	Method	Description
Collection<Component>	components()	Gets the components held by this object.
ServerPacket	copyWithOperator(UnaryOperator<Component> operator)	Returns a copy of this object.
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.
byte	mode()	Returns the value of the mode record component.
Sidebar.NumberFormat	numberFormat()	Returns the value of the numberFormat record component.
String	objectiveName()	Returns the value of the objectiveName record component.
@Nullable Component	objectiveValue()	Returns the value of the objectiveValue record component.
final String	toString()	Returns a string representation of this record class.
@Nullable ScoreboardObjectivePacket.Type	type()	Returns the value of the type record component.

Methods inherited from class Object

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

Methods inherited from interface ComponentHolder

visitComponents

Field Details

SERIALIZER

public static final NetworkBuffer.Type<ScoreboardObjectivePacket> SERIALIZER

Constructor Details

ScoreboardObjectivePacket

public ScoreboardObjectivePacket(String objectiveName,
 byte mode,
 @Nullable
 @Nullable Component objectiveValue,
 @Nullable
 @Nullable ScoreboardObjectivePacket.Type type,
 @Nullable
 Sidebar.NumberFormat numberFormat)

Creates an instance of a ScoreboardObjectivePacket record class.

Parameters:

objectiveName - the value for the objectiveName record component

mode - the value for the mode record component

objectiveValue - the value for the objectiveValue record component

type - the value for the type record component

numberFormat - the value for the numberFormat record component

Method Details

components

public Collection<Component> components()

Description copied from interface: ComponentHolder

Gets the components held by this object.

Specified by:

components in interface ComponentHolder<ServerPacket>

Returns:

the components

copyWithOperator

public ServerPacket copyWithOperator(UnaryOperator<Component> operator)

Description copied from interface: ComponentHolder

Returns a copy of this object. For each component this object holds, the operator is applied to the copy before returning.

Specified by:

copyWithOperator in interface ComponentHolder<ServerPacket>

Parameters:

operator - the operator

Returns:

the copy

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.

objectiveName

public String objectiveName()

Returns the value of the objectiveName record component.

Returns:

the value of the objectiveName record component

mode

public byte mode()

Returns the value of the mode record component.

Returns:

the value of the mode record component

objectiveValue

@Nullable
public @Nullable Component objectiveValue()

Returns the value of the objectiveValue record component.

Returns:

the value of the objectiveValue record component

type

@Nullable
public @Nullable ScoreboardObjectivePacket.Type type()

Returns the value of the type record component.

Returns:

the value of the type record component

numberFormat

@Nullable
public Sidebar.NumberFormat numberFormat()

Returns the value of the numberFormat record component.

Returns:

the value of the numberFormat record component