Package net.neoforged.neoforge.network.payload

Record Class ModdedNetworkComponent

java.lang.Object

java.lang.Record

net.neoforged.neoforge.network.payload.ModdedNetworkComponent

Record Components:

id - The mod id

version - The mod version, if present

@Internal
public record ModdedNetworkComponent(ResourceLocation id, Optional<String> version)
extends Record

Represents a modded network component, indicates what channel and version the client and server agreed upon.

Field Summary

Fields

Modifier and Type	Field	Description
private final ResourceLocation	id	The field for the id record component.
private final Optional<String>	version	The field for the version record component.

Constructor Summary

Constructors

Constructor	Description
ModdedNetworkComponent(FriendlyByteBuf buf)
ModdedNetworkComponent(ResourceLocation id, Optional<String> version)	Creates an instance of a ModdedNetworkComponent 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.
ResourceLocation	id()	Returns the value of the id record component.
final String	toString()	Returns a string representation of this record class.
Optional<String>	version()	Returns the value of the version record component.
void	write(FriendlyByteBuf buf)

Methods inherited from class java.lang.Object

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

Field Details

id

private final ResourceLocation id

The field for the id record component.

version

private final Optional<String> version

The field for the version record component.

Constructor Details

ModdedNetworkComponent

public ModdedNetworkComponent(FriendlyByteBuf buf)

ModdedNetworkComponent

public ModdedNetworkComponent(ResourceLocation id,
 Optional<String> version)

Creates an instance of a ModdedNetworkComponent record class.

Parameters:

id - the value for the id record component

version - the value for the version record component

Method Details

write

public void write(FriendlyByteBuf buf)

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

id

public ResourceLocation id()

Returns the value of the id record component.

Returns:

the value of the id record component

version

public Optional<String> version()

Returns the value of the version record component.

Returns:

the value of the version record component