Package net.neoforged.neoforge.network.configuration

Interface ICustomConfigurationTask

All Superinterfaces:

ConfigurationTask

All Known Implementing Classes:

RegistryDataMapNegotiation, SyncConfig, SyncRegistries

public interface ICustomConfigurationTask
extends ConfigurationTask

Defines a custom configuration task that should be run when a client connects.

This interface is a wrapper functional interface around ConfigurationTask. Allowing for easily sending custom payloads to the client, without having to perform the wrapping in ClientboundCustomPayloadPacket yourself.
It is recommended to use this interface over ConfigurationTask when you need to send custom payloads. It's functionality is otherwise identical.

Nested Class Summary

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

ConfigurationTask.Type

Method Summary

Modifier and Type	Method	Description
void	run(Consumer<CustomPacketPayload> sender)	Invoked when it is time for this configuration to run.
default void	start(Consumer<Packet<?>> sender)	Invoked when it is time for this configuration to run.

Methods inherited from interface net.minecraft.server.network.ConfigurationTask

type

Method Details

run

void run(Consumer<CustomPacketPayload> sender)

Invoked when it is time for this configuration to run.

Parameters:

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

start

@Internal
@NonExtendable
default void start(Consumer<Packet<?>> sender)

Invoked when it is time for this configuration to run.

Specified by:

start in interface ConfigurationTask

Parameters:

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