Record Class CommonRegisterTask

java.lang.Object

java.lang.Record

net.neoforged.neoforge.network.configuration.CommonRegisterTask

All Implemented Interfaces:

ConfigurationTask, ICustomConfigurationTask

@Internal
public record CommonRegisterTask()
extends Record
implements ICustomConfigurationTask

Common Register configuration task. After completion of CommonVersionTask, sends a CommonRegisterPayload to the client containing all known serverbound channels, and awaits a response containing the client's known clientbound channels.

Nested Class Summary

Nested classes/interfaces inherited from interface ConfigurationTask

ConfigurationTask.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final ConfigurationTask.Type	TYPE

Constructor Summary

Constructors

Constructor	Description
CommonRegisterTask()	Creates an instance of a CommonRegisterTask 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.
void	run(Consumer<CustomPacketPayload> sender)	Invoked when it is time for this configuration to run.
final String	toString()	Returns a string representation of this record class.
ConfigurationTask.Type	type()

Methods inherited from class Object

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

Methods inherited from interface ConfigurationTask

tick

Methods inherited from interface ICustomConfigurationTask

start

Field Details

TYPE

public static final ConfigurationTask.Type TYPE

Constructor Details

CommonRegisterTask

public CommonRegisterTask()

Creates an instance of a CommonRegisterTask record class.

Method Details

type

public ConfigurationTask.Type type()

Specified by:

type in interface ConfigurationTask

run

public void run(Consumer<CustomPacketPayload> sender)

Description copied from interface: ICustomConfigurationTask

Invoked when it is time for this configuration to run.

Specified by:

run in interface ICustomConfigurationTask

Parameters:

sender - A consumer that accepts a CustomPacketPayload to send to the client.

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.

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.