Interface DataResourceLoader

All Superinterfaces:

ResourceLoader

@NonExtendable
public interface DataResourceLoader
extends ResourceLoader

Provides various hooks into the server data resource loader.

Field Summary

Fields

Modifier and Type	Field	Description
static final net.minecraft.server.packs.resources.PreparableReloadListener.StateKey<DataResourceStore.Mutable>	DATA_RESOURCE_STORE_KEY	The reload listener state key for the data resource store.

Fields inherited from interface ResourceLoader

FEATURE_FLAG_SET_KEY, REGISTRY_LOOKUP_KEY

Method Summary

Modifier and Type	Method	Description
static DataResourceLoader	get()
void	registerReloadListener(net.minecraft.resources.Identifier id, Function<net.minecraft.core.HolderLookup.Provider, net.minecraft.server.packs.resources.PreparableReloadListener> factory)	Registers a data reload listener.

Methods inherited from interface ResourceLoader

addListenerOrdering, registerReloadListener

Field Details

DATA_RESOURCE_STORE_KEY

static final net.minecraft.server.packs.resources.PreparableReloadListener.StateKey<DataResourceStore.Mutable> DATA_RESOURCE_STORE_KEY

The reload listener state key for the data resource store.

API Note:

The data resource store is only available in server data reload listeners.
It should only be mutated in the application phase of the reload listeners.

Method Details

get

static DataResourceLoader get()

registerReloadListener

void registerReloadListener(net.minecraft.resources.Identifier id,
 Function<net.minecraft.core.HolderLookup.Provider, net.minecraft.server.packs.resources.PreparableReloadListener> factory)

Registers a data reload listener.

Parameters:

id - the identifier of the reload listener

factory - the factory function of the reload listener

See Also:

• ResourceLoader.registerReloadListener(Identifier, PreparableReloadListener)
• ResourceLoader.addListenerOrdering(Identifier, Identifier)

API Note:

In most cases ResourceLoader.registerReloadListener(Identifier, PreparableReloadListener) is sufficient and should be preferred, but for some reload listeners like SimpleJsonResourceReloadListener constructing the reload listener with a known instance of the holder lookup is required.
While this may encourage stateful reload listeners, it is best to primarily use reload listeners as stateless loaders, as storing a state may easily lead to incomplete or leaking data.