99 lines
3.8 KiB
Java
99 lines
3.8 KiB
Java
![]() |
/*
|
||
|
* Minecraft Forge
|
||
|
* Copyright (c) 2016-2019.
|
||
|
*
|
||
|
* This library is free software; you can redistribute it and/or
|
||
|
* modify it under the terms of the GNU Lesser General Public
|
||
|
* License as published by the Free Software Foundation version 2.1
|
||
|
* of the License.
|
||
|
*
|
||
|
* This library is distributed in the hope that it will be useful,
|
||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||
|
* Lesser General Public License for more details.
|
||
|
*
|
||
|
* You should have received a copy of the GNU Lesser General Public
|
||
|
* License along with this library; if not, write to the Free Software
|
||
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||
|
*/
|
||
|
|
||
|
package net.minecraftforge.registries;
|
||
|
|
||
|
import java.util.ArrayList;
|
||
|
import java.util.List;
|
||
|
import java.util.function.Supplier;
|
||
|
|
||
|
import net.minecraft.util.ResourceLocation;
|
||
|
import net.minecraftforge.event.RegistryEvent;
|
||
|
import net.minecraftforge.eventbus.api.IEventBus;
|
||
|
import net.minecraftforge.fml.RegistryObject;
|
||
|
|
||
|
/**
|
||
|
* 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:
|
||
|
*<pre>
|
||
|
* private static final DeferredRegister<Item> ITEMS = new DeferredRegister<>(ForgeRegistries.ITEMS, MODID);
|
||
|
* private static final DeferredRegister<Block> BLOCKS = new DeferredRegister<>(ForgeRegistries.BLOCKS, MODID);
|
||
|
*
|
||
|
* public static final RegistryObject<Block> ROCK_BLOCK = BLOCKS.register("rock", () -> new Block(Block.Properties.create(Material.ROCK)));
|
||
|
* public static final RegistryObject<Item> 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());
|
||
|
* }
|
||
|
*</pre>
|
||
|
*
|
||
|
* @param <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>>
|
||
|
{
|
||
|
private final IForgeRegistry<T> type;
|
||
|
private final String modid;
|
||
|
private List<Supplier<? extends T>> entries = new ArrayList<>();
|
||
|
|
||
|
public DeferredRegister(IForgeRegistry<T> reg, String modid)
|
||
|
{
|
||
|
this.type = reg;
|
||
|
this.modid = modid;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* 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.
|
||
|
*
|
||
|
* @param name The new entry's name, it will automatically have the modid prefixed.
|
||
|
* @param sup A factory for the new entry, it should return a new instance every time it is called.
|
||
|
* @return A RegistryObject that will be updated with when the entries in the registry change.
|
||
|
*/
|
||
|
public <I extends T> RegistryObject<I> register(final String name, final Supplier<I> sup)
|
||
|
{
|
||
|
final ResourceLocation key = new ResourceLocation(modid, name);
|
||
|
entries.add(() -> sup.get().setRegistryName(key));
|
||
|
return RegistryObject.of(key.toString(), this.type);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Adds our event handler to the specified event bus, this MUST be called in order for this class to function.
|
||
|
* See the example usage.
|
||
|
*
|
||
|
* @param bus The Mod Specific event bus.
|
||
|
*/
|
||
|
public void register(IEventBus bus)
|
||
|
{
|
||
|
bus.addListener(this::addEntries);
|
||
|
}
|
||
|
|
||
|
private void addEntries(RegistryEvent.Register<?> event)
|
||
|
{
|
||
|
if (event.getGenericType() == this.type.getRegistrySuperType())
|
||
|
{
|
||
|
@SuppressWarnings("unchecked")
|
||
|
IForgeRegistry<T> reg = (IForgeRegistry<T>)event.getRegistry();
|
||
|
entries.stream().map(Supplier::get).forEach(reg::register);
|
||
|
}
|
||
|
}
|
||
|
}
|