Package net.neoforged.neoforge.event

Class SortedReloadListenerEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.SortedReloadListenerEvent

Direct Known Subclasses:

AddClientReloadListenersEvent, AddServerReloadListenersEvent

public abstract class SortedReloadListenerEvent
extends net.neoforged.bus.api.Event

Base class for AddServerReloadListenersEvent and AddClientReloadListenersEvent.

This class holds the sorting logic that allows for the creation of dependency ordering.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SortedReloadListenerEvent.NameLookup

Field Summary

Fields

Modifier and Type	Field	Description
private final MutableGraph<PreparableReloadListener>	graph
private final Map<PreparableReloadListener,ResourceLocation>	keys
private final PreparableReloadListener	lastVanilla
private final Map<ResourceLocation,PreparableReloadListener>	registry

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SortedReloadListenerEvent(List<PreparableReloadListener> vanillaListeners, SortedReloadListenerEvent.NameLookup lookup)

Method Summary

Modifier and Type	Method	Description
void	addDependency(ResourceLocation first, ResourceLocation second)	Adds a new dependency entry, such that first must run before second.
void	addListener(ResourceLocation key, PreparableReloadListener listener)	Adds a new reload listener to the resource manager.
Graph<PreparableReloadListener>	getGraph()	Returns an immutable view of the dependency graph.
PreparableReloadListener	getLastVanillaListener()	Returns a reference to the last vanilla listener, used during the final sort.
SortedReloadListenerEvent.NameLookup	getNameLookup()	Returns a SortedReloadListenerEvent.NameLookup for all reload listeners known by this event.
private PreparableReloadListener	getOrThrow(ResourceLocation key)
private ResourceLocation	getOrThrow(PreparableReloadListener listener)
Map<ResourceLocation,PreparableReloadListener>	getRegistry()	Returns an immutable view of the reload listener registry.

Methods inherited from class java.lang.Object

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

Field Details

registry

private final Map<ResourceLocation,PreparableReloadListener> registry

keys

private final Map<PreparableReloadListener,ResourceLocation> keys

graph

private final MutableGraph<PreparableReloadListener> graph

lastVanilla

private final PreparableReloadListener lastVanilla

Constructor Details

SortedReloadListenerEvent

@Internal
protected SortedReloadListenerEvent(List<PreparableReloadListener> vanillaListeners,
 SortedReloadListenerEvent.NameLookup lookup)

Method Details

addListener

public void addListener(ResourceLocation key,
 PreparableReloadListener listener)

Adds a new reload listener to the resource manager.

Unless explicitly specified, this listener will run after all vanilla listeners, in the order it was registered.

Parameters:

key - The resource location that identifies the reload listener for dependency sorting.

listener - The listener to add.

Throws:

IllegalArgumentException - if another listener with that key was already registered.

addDependency

public void addDependency(ResourceLocation first,
 ResourceLocation second)

Adds a new dependency entry, such that first must run before second.

Introduction of dependency cycles (first->second->first) will cause an error when the event is finished.

Parameters:

first - The key of the reload listener that must run first.

second - The key of the reload listener that must run after first.

Throws:

IllegalArgumentException - if either first or second has not been registered via addListener(net.minecraft.resources.ResourceLocation, net.minecraft.server.packs.resources.PreparableReloadListener).

getGraph

public Graph<PreparableReloadListener> getGraph()

Returns an immutable view of the dependency graph.

getRegistry

public Map<ResourceLocation,PreparableReloadListener> getRegistry()

Returns an immutable view of the reload listener registry.

The registry is linked, meaning the iteration order depends on the registration order.

getNameLookup

public SortedReloadListenerEvent.NameLookup getNameLookup()

Returns a SortedReloadListenerEvent.NameLookup for all reload listeners known by this event.

getLastVanillaListener

@Internal
public PreparableReloadListener getLastVanillaListener()

Returns a reference to the last vanilla listener, used during the final sort.

getOrThrow

private PreparableReloadListener getOrThrow(ResourceLocation key)

getOrThrow

private ResourceLocation getOrThrow(PreparableReloadListener listener)