Package net.minecraftforge.registries

Class DeferredRegister<T extends IForgeRegistryEntry<T>>

java.lang.Object

net.minecraftforge.registries.DeferredRegister<T>

Type Parameters:

T - The base registry type, must be a concrete base class, do not use subclasses or wild cards.

public class DeferredRegister<T extends IForgeRegistryEntry<T>>
extends Object

Utility class to help with managing registry entries. Maintains a list of all suppliers for entries and registers them during the proper Register event. Suppliers should return NEW instances every time. Example Usage:

   private static final DeferredRegister ITEMS = DeferredRegister.create(ForgeRegistries.ITEMS, MODID);
   private static final DeferredRegister BLOCKS = DeferredRegister.create(ForgeRegistries.BLOCKS, MODID);

   public static final RegistryObject ROCK_BLOCK = BLOCKS.register("rock", () -> new Block(Block.Properties.create(Material.ROCK)));
   public static final RegistryObject ROCK_ITEM = ITEMS.register("rock", () -> new BlockItem(ROCK_BLOCK.get(), new Item.Properties().group(ItemGroup.MISC)));

   public ExampleMod() {
       ITEMS.register(FMLJavaModLoadingContext.get().getModEventBus());
       BLOCKS.register(FMLJavaModLoadingContext.get().getModEventBus());
   }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeferredRegister.EventDispatcher

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<RegistryObject<T>,Supplier<? extends T>>	entries
private final Set<RegistryObject<T>>	entriesView
private final String	modid
private Supplier<RegistryBuilder<T>>	registryFactory
private boolean	seenRegisterEvent
private final Class<T>	superType
private IForgeRegistry<T>	type

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DeferredRegister(Class<T> base, String modid)
private	DeferredRegister(IForgeRegistry<T> reg, String modid)

Method Summary

Modifier and Type	Method	Description
private void	addEntries(RegistryEvent.Register<?> event)
private void	captureRegistry()
static <B extends IForgeRegistryEntry<B>> DeferredRegister<B>	create(Class<B> base, String modid)	Use for custom registries that are made during the NewRegistry event.
static <B extends IForgeRegistryEntry<B>> DeferredRegister<B>	create(IForgeRegistry<B> reg, String modid)	Use for vanilla/forge registries.
private void	createRegistry(RegistryEvent.NewRegistry event)
Collection<RegistryObject<T>>	getEntries()
Supplier<IForgeRegistry<T>>	makeRegistry(String name, Supplier<RegistryBuilder<T>> sup)	For custom registries only, fills the registryFactory to be called later see register(IEventBus) Calls RegistryBuilder.setName(net.minecraft.util.ResourceLocation) and RegistryBuilder.setType(java.lang.Class<T>) automatically.
<I extends T> RegistryObject<I>	register(String name, Supplier<? extends I> sup)	Adds a new supplier to the list of entries to be registered, and returns a RegistryObject that will be populated with the created entry automatically.
void	register(net.minecraftforge.eventbus.api.IEventBus bus)	Adds our event handler to the specified event bus, this MUST be called in order for this class to function.

Methods inherited from class java.lang.Object

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

Field Details

superType

private final Class<T extends IForgeRegistryEntry<T>> superType

modid

private final String modid

entries

private final Map<RegistryObject<T extends IForgeRegistryEntry<T>>,Supplier<? extends T extends IForgeRegistryEntry<T>>> entries

entriesView

private final Set<RegistryObject<T extends IForgeRegistryEntry<T>>> entriesView

type

private IForgeRegistry<T extends IForgeRegistryEntry<T>> type

registryFactory

private Supplier<RegistryBuilder<T extends IForgeRegistryEntry<T>>> registryFactory

seenRegisterEvent

private boolean seenRegisterEvent

Constructor Details

DeferredRegister

private DeferredRegister(Class<T> base,
 String modid)

DeferredRegister

private DeferredRegister(IForgeRegistry<T> reg,
 String modid)

Method Details

create

public static <B extends IForgeRegistryEntry<B>>
DeferredRegister<B> create(IForgeRegistry<B> reg,
 String modid)

Use for vanilla/forge registries. See example above.

create

public static <B extends IForgeRegistryEntry<B>>
DeferredRegister<B> create(Class<B> base,
 String modid)

Use for custom registries that are made during the NewRegistry event.

register

public <I extends T> RegistryObject<I> register(String name,
 Supplier<? extends I> sup)

Adds a new supplier to the list of entries to be registered, and returns a RegistryObject that will be populated with the created entry automatically.

Parameters:

name - The new entry's name, it will automatically have the modid prefixed.

sup - A factory for the new entry, it should return a new instance every time it is called.

Returns:

A RegistryObject that will be updated with when the entries in the registry change.

makeRegistry

public Supplier<IForgeRegistry<T>> makeRegistry(String name,
 Supplier<RegistryBuilder<T>> sup)

For custom registries only, fills the registryFactory to be called later see register(IEventBus) Calls RegistryBuilder.setName(net.minecraft.util.ResourceLocation) and RegistryBuilder.setType(java.lang.Class<T>) automatically.

Parameters:

name - Path of the registry's ResourceLocation

sup - Supplier of the RegistryBuilder that is called to fill type during the NewRegistry event

Returns:

A supplier of the IForgeRegistry created by the builder.

register

public void register(net.minecraftforge.eventbus.api.IEventBus bus)

Adds our event handler to the specified event bus, this MUST be called in order for this class to function. See the example usage.

Parameters:

bus - The Mod Specific event bus.

getEntries

public Collection<RegistryObject<T>> getEntries()

Returns:

The unmodifiable view of registered entries. Useful for bulk operations on all values.

addEntries

private void addEntries(RegistryEvent.Register<?> event)

createRegistry

private void createRegistry(RegistryEvent.NewRegistry event)

captureRegistry

private void captureRegistry()