Registries

This library adds two basic registries.

Item Registrar

Creating the Registry

1. Create a new child class of ItemRegistrar.

public class ModItems extends ItemRegistrar {
    // You can replace mod with your modid.
    public ModItems(String modid) {
        super(modid);
    }

    @Override
    protected void registerItems() {
        // register your items here.
    }
}

2. Create your items class.

@Mod(PaintPaletteExampleMod.MODID)
public class PaintPaletteExampleMod {
    public static final String MODID = "paint_palette_example_mod";
    private static final Logger LOGGER = LogUtils.getLogger();

    private static final ItemRegistrar MOD_ITEMS = new ModItems(MODID);

and then in your mod constructor:

public PaintPaletteExampleMod(IEventBus modEventBus, ModContainer modContainer) {
    MOD_ITEMS.register(modEventBus);
}

Registering Items

You can place these methods in your registerItems() method.

Method	Function
basicItem(name, supplier)	Returns a DeferredItem<T extends Item>
funnyStick(name, supplier)	Returns a <DeferredItem<T extends FunnyStick>>
conditionalItem(run, supplier)	Returns an Optional<DeferredItem<T extends Item>> if run is true.

Accessing Registered Items

To access your registered item call, getItem(name) where the name is the name you registered the item with.

Block Registrar

Creating the Registry

1. Create a new child class of BlockRegistrar.

public class ModBlocks extends BlockRegistrar {
    public ModBlocks(String modid, ItemRegistrar itemRegistrar) {
        // You can replace these with your existing values.
        super(modid, itemRegistrar);
    }

    @Override
    protected void registerBlocks() {
        // Register your blocks here.
    }
}

2. Create your blocks class.

@Mod(PaintPaletteExampleMod.MODID)
public class PaintPaletteExampleMod {
    public static final String MODID = "paint_palette_example_mod";
    private static final Logger LOGGER = LogUtils.getLogger();

    private static final ItemRegistrar MOD_ITEMS = new ModItems(MODID);
    private static final BlockRegistrar MOD_BLOCKS = new ModBlocks(MODID, MOD_ITEMS);

and then in your mod constructor:

public PaintPaletteExampleMod(IEventBus modEventBus, ModContainer modContainer) {
    MOD_ITEMS.register(modEventBus);
    MOD_BLOCKS.register(modEventBus);
}

Registering Blocks

You can place the following methods in your registerBlocks() method.

Method	Function
basicBlock(name, supplier, registerItem = true)	Returns a DeferredBlock<T extends Block> with an item if register item is true.
conditionalBlock(run, supplier)	Returns an Optional<DeferredBlock<T extends Block>>, the optional will be empty if run is false.

Accessing Registered Blocks

To access your registered block, call getBlock(name) where the name is the name you registered the item with.