Package net.neoforged.neoforge.network.event

Class RegisterConfigurationTasksEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.network.event.RegisterConfigurationTasksEvent

All Implemented Interfaces:

net.neoforged.fml.event.IModBusEvent

public class RegisterConfigurationTasksEvent
extends net.neoforged.bus.api.Event
implements net.neoforged.fml.event.IModBusEvent

Fired when the server configuration packet listener collects all the configuration tasks that should be run on the server to configure the client.

Field Summary

Fields

Modifier and Type	Field	Description
private final Queue<ConfigurationTask>	configurationTasks
private final ServerConfigurationPacketListener	listener

Constructor Summary

Constructors

Constructor	Description
RegisterConfigurationTasksEvent(ServerConfigurationPacketListener listener)

Method Summary

Modifier and Type	Method	Description
Queue<ConfigurationTask>	getConfigurationTasks()	Get the configuration tasks that have been registered.
ServerConfigurationPacketListener	getListener()	Get the server configuration packet listener.
void	register(ConfigurationTask task)	Register a configuration task to be run on the server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

listener

private final ServerConfigurationPacketListener listener

configurationTasks

private final Queue<ConfigurationTask> configurationTasks

Constructor Details

RegisterConfigurationTasksEvent

@Internal
public RegisterConfigurationTasksEvent(ServerConfigurationPacketListener listener)

Method Details

register

public void register(ConfigurationTask task)

Register a configuration task to be run on the server.

If you need to send payloads during your task, extend ICustomConfigurationTask instead of ConfigurationTask.

Parameters:

task - The task to run.

getConfigurationTasks

@Internal
public Queue<ConfigurationTask> getConfigurationTasks()

Get the configuration tasks that have been registered.

Returns:

The configuration tasks.

getListener

public ServerConfigurationPacketListener getListener()

Get the server configuration packet listener.

Returns:

The server configuration packet listener.