Package net.neoforged.neoforge.network.configuration

Record Class SyncConfig

java.lang.Object

java.lang.Record

net.neoforged.neoforge.network.configuration.SyncConfig

Record Components:

listener - the listener to indicate to that the task is complete

All Implemented Interfaces:

ConfigurationTask, ICustomConfigurationTask

@Internal
public record SyncConfig(ServerConfigurationPacketListener listener)
extends Record
implements ICustomConfigurationTask

Configuration task that syncs the config files to the client

Nested Class Summary

Nested classes/interfaces inherited from interface net.minecraft.server.network.ConfigurationTask

ConfigurationTask.Type

Field Summary

Fields

Modifier and Type	Field	Description
private static final ResourceLocation	ID
private final ServerConfigurationPacketListener	listener	The field for the listener record component.
static ConfigurationTask.Type	TYPE

Constructor Summary

Constructors

Constructor	Description
SyncConfig(ServerConfigurationPacketListener listener)	Creates an instance of a SyncConfig 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.
ServerConfigurationPacketListener	listener()	Returns the value of the listener record component.
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 java.lang.Object

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

Methods inherited from interface net.neoforged.neoforge.network.configuration.ICustomConfigurationTask

start

Field Details

listener

private final ServerConfigurationPacketListener listener

The field for the listener record component.

ID

private static final ResourceLocation ID

TYPE

public static ConfigurationTask.Type TYPE

Constructor Details

SyncConfig

public SyncConfig(ServerConfigurationPacketListener listener)

Creates an instance of a SyncConfig record class.

Parameters:

listener - the value for the listener record component

Method Details

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.

type

public ConfigurationTask.Type type()

Specified by:

type in interface ConfigurationTask

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.

listener

public ServerConfigurationPacketListener listener()

Returns the value of the listener record component.

Returns:

the value of the listener record component