Package net.neoforged.neoforge.registries.datamaps

Class DataMapsUpdatedEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.registries.datamaps.DataMapsUpdatedEvent

public class DataMapsUpdatedEvent
extends net.neoforged.bus.api.Event

Event fired on the game event bus when the data maps of a registry have either been synced to the client or reloaded on the server.

This event can be used to build caches (like weighed lists) or for post-processing the data map values.
Remember however that the data map values should not end up referencing their owner, as they're not copied when attached to tags.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DataMapsUpdatedEvent.UpdateCause

Field Summary

Fields

Modifier and Type	Field	Description
private final DataMapsUpdatedEvent.UpdateCause	cause
private final Registry<?>	registry
private final RegistryAccess	registryAccess

Constructor Summary

Constructors

Constructor	Description
DataMapsUpdatedEvent(RegistryAccess registryAccess, Registry<?> registry, DataMapsUpdatedEvent.UpdateCause cause)

Method Summary

Modifier and Type	Method	Description
DataMapsUpdatedEvent.UpdateCause	getCause()	Returns the reason for the update.
RegistryAccess	getRegistries()	Returns a registry access.
Registry<?>	getRegistry()	Returns the registry that had its data maps updated.
ResourceKey<? extends Registry<?>>	getRegistryKey()	Returns the key of the registry that had its data maps updated.
<T> void	ifRegistry(ResourceKey<Registry<T>> type, Consumer<Registry<T>> consumer)	Runs the given consumer if the registry is of the given type.

Methods inherited from class java.lang.Object

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

Field Details

registryAccess

private final RegistryAccess registryAccess

registry

private final Registry<?> registry

cause

private final DataMapsUpdatedEvent.UpdateCause cause

Constructor Details

DataMapsUpdatedEvent

@Internal
public DataMapsUpdatedEvent(RegistryAccess registryAccess,
 Registry<?> registry,
 DataMapsUpdatedEvent.UpdateCause cause)

Method Details

getRegistries

public RegistryAccess getRegistries()

Returns a registry access.

Returns:

a registry access

getRegistry

public Registry<?> getRegistry()

Returns the registry that had its data maps updated.

Returns:

the registry that had its data maps updated

getRegistryKey

public ResourceKey<? extends Registry<?>> getRegistryKey()

Returns the key of the registry that had its data maps updated.

Returns:

the key of the registry that had its data maps updated

ifRegistry

public <T> void ifRegistry(ResourceKey<Registry<T>> type,
 Consumer<Registry<T>> consumer)

Runs the given consumer if the registry is of the given type.

Type Parameters:

T - the registry type

Parameters:

type - the registry key

consumer - the consumer

getCause

public DataMapsUpdatedEvent.UpdateCause getCause()

Returns the reason for the update.

Returns:

the reason for the update