Record Class AdvancementsPacket

java.lang.Object

java.lang.Record

net.minestom.server.network.packet.server.play.AdvancementsPacket

All Implemented Interfaces:

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

public record AdvancementsPacket(boolean reset, List<AdvancementsPacket.AdvancementMapping> advancementMappings, List<String> identifiersToRemove, List<AdvancementsPacket.ProgressMapping> progressMappings, boolean showAdvancements)
extends Record
implements ServerPacket.Play, ServerPacket.ComponentHolding

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AdvancementsPacket.Advancement
static final record	AdvancementsPacket.AdvancementMapping	AdvancementMapping maps the namespaced ID to the Advancement.
static final record	AdvancementsPacket.AdvancementProgress
static final record	AdvancementsPacket.Criteria
static final record	AdvancementsPacket.CriterionProgress
static final record	AdvancementsPacket.DisplayData
static final record	AdvancementsPacket.ProgressMapping
static final record	AdvancementsPacket.Requirement

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 int	MAX_ADVANCEMENTS
static final NetworkBuffer.Type<AdvancementsPacket>	SERIALIZER

Constructor Summary

Constructors

Constructor	Description
AdvancementsPacket(boolean reset, List<AdvancementsPacket.AdvancementMapping> advancementMappings, List<String> identifiersToRemove, List<AdvancementsPacket.ProgressMapping> progressMappings, boolean showAdvancements)	Creates an instance of a AdvancementsPacket record class.

Method Summary

Modifier and Type	Method	Description
List<AdvancementsPacket.AdvancementMapping>	advancementMappings()	Returns the value of the advancementMappings record component.
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.
List<String>	identifiersToRemove()	Returns the value of the identifiersToRemove record component.
List<AdvancementsPacket.ProgressMapping>	progressMappings()	Returns the value of the progressMappings record component.
boolean	reset()	Returns the value of the reset record component.
boolean	showAdvancements()	Returns the value of the showAdvancements record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Methods inherited from interface ComponentHolder

visitComponents

Field Details

MAX_ADVANCEMENTS

public static final int MAX_ADVANCEMENTS

See Also:

• Constant Field Values

SERIALIZER

public static final NetworkBuffer.Type<AdvancementsPacket> SERIALIZER

Constructor Details

AdvancementsPacket

public AdvancementsPacket(boolean reset,
 List<AdvancementsPacket.AdvancementMapping> advancementMappings,
 List<String> identifiersToRemove,
 List<AdvancementsPacket.ProgressMapping> progressMappings,
 boolean showAdvancements)

Creates an instance of a AdvancementsPacket record class.

Parameters:

reset - the value for the reset record component

advancementMappings - the value for the advancementMappings record component

identifiersToRemove - the value for the identifiersToRemove record component

progressMappings - the value for the progressMappings record component

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

reset

public boolean reset()

Returns the value of the reset record component.

Returns:

the value of the reset record component

advancementMappings

public List<AdvancementsPacket.AdvancementMapping> advancementMappings()

Returns the value of the advancementMappings record component.

Returns:

the value of the advancementMappings record component

identifiersToRemove

public List<String> identifiersToRemove()

Returns the value of the identifiersToRemove record component.

Returns:

the value of the identifiersToRemove record component

progressMappings

public List<AdvancementsPacket.ProgressMapping> progressMappings()

Returns the value of the progressMappings record component.

Returns:

the value of the progressMappings record component

showAdvancements

public boolean showAdvancements()

Returns the value of the showAdvancements record component.

Returns:

the value of the showAdvancements record component