Package net.neoforged.neoforge.registries

Class IdMappingEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.registries.IdMappingEvent

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

Called whenever the ID mapping might have changed. If you register for this event, you will be called back whenever the client or server loads an ID set. This includes both when the ID maps are loaded from disk, as well as when the ID maps revert to the initial state.

Note: you cannot change the IDs that have been allocated, but you might want to use this event to update caches or other in-mod artifacts that might be impacted by an ID change.

Fired on the forge bus.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	IdMappingEvent.IdRemapping
static class	IdMappingEvent.ModRemapping

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	isFrozen
private final com.google.common.collect.ImmutableSet<ResourceLocation>	keys
private final Map<ResourceLocation,com.google.common.collect.ImmutableList<IdMappingEvent.ModRemapping>>	remaps

Constructor Summary

Constructors

Constructor	Description
IdMappingEvent(Map<ResourceLocation,Map<ResourceLocation,IdMappingEvent.IdRemapping>> remaps, boolean isFrozen)

Method Summary

Modifier and Type	Method	Description
com.google.common.collect.ImmutableSet<ResourceLocation>	getRegistries()
com.google.common.collect.ImmutableList<IdMappingEvent.ModRemapping>	getRemaps(ResourceLocation registry)
boolean	isFrozen()

Methods inherited from class java.lang.Object

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

Field Details

remaps

private final Map<ResourceLocation,com.google.common.collect.ImmutableList<IdMappingEvent.ModRemapping>> remaps

keys

private final com.google.common.collect.ImmutableSet<ResourceLocation> keys

isFrozen

private final boolean isFrozen

Constructor Details

IdMappingEvent

public IdMappingEvent(Map<ResourceLocation,Map<ResourceLocation,IdMappingEvent.IdRemapping>> remaps,
 boolean isFrozen)

Method Details

getRegistries

public com.google.common.collect.ImmutableSet<ResourceLocation> getRegistries()

getRemaps

public com.google.common.collect.ImmutableList<IdMappingEvent.ModRemapping> getRemaps(ResourceLocation registry)

isFrozen

public boolean isFrozen()