net.minecraftforge.fml.common.registry

Class GameRegistry

java.lang.Object

net.minecraftforge.fml.common.registry.GameRegistry

public class GameRegistry
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GameRegistry.ItemStackHolder ItemStackHolder can be used to automatically populate public static final fields with ItemStack instances, referring a specific item, potentially configured with NBT.
static interface	GameRegistry.ObjectHolder ObjectHolder can be used to automatically populate public static final fields with entries from the registry.
static class	GameRegistry.Type

Constructor Summary

Constructors

Constructor and Description
GameRegistry()

Method Summary

Modifier and Type	Method and Description
static void	addRecipe(IRecipe recipe)
static void	addRecipe(ItemStack output, java.lang.Object... params)
static IRecipe	addShapedRecipe(ItemStack output, java.lang.Object... params)
static void	addShapelessRecipe(ItemStack output, java.lang.Object... params)
static void	addSmelting(Block input, ItemStack output, float xp)
static void	addSmelting(Item input, ItemStack output, float xp)
static void	addSmelting(ItemStack input, ItemStack output, float xp)
static void	addSubstitutionAlias(java.lang.String nameToSubstitute, GameRegistry.Type type, java.lang.Object object) Add a forced persistent substitution alias for the block or item to another block or item.
static <K extends IForgeRegistryEntry<K>> IForgeRegistry<K>	findRegistry(java.lang.Class<K> registryType) Retrieves the registry associated with this super class type.
static void	generateWorld(int chunkX, int chunkZ, World world, IChunkGenerator chunkGenerator, IChunkProvider chunkProvider) Callback hook for world gen - if your mod wishes to add extra mod related generation to the world call this
static int	getFuelValue(ItemStack itemStack)
static ItemStack	makeItemStack(java.lang.String itemName, int meta, int stackSize, java.lang.String nbtString) Makes an ItemStack based on the itemName reference, with supplied meta, stackSize and nbt, if possible Will return null if the item doesn't exist (because it's not from a loaded mod for example) Will throw a RuntimeException if the nbtString is invalid for use in an ItemStack
static <K extends IForgeRegistryEntry<?>> K	register(K object) Register the previously named IForgeRegistry object with the registry system.
static <K extends IForgeRegistryEntry<?>> K	register(K object, ResourceLocation name) Register the unnamed IForgeRegistry object with the registry system.
static void	registerFuelHandler(IFuelHandler handler)
static void	registerTileEntity(java.lang.Class<? extends TileEntity> tileEntityClass, java.lang.String id)
static void	registerTileEntityWithAlternatives(java.lang.Class<? extends TileEntity> tileEntityClass, java.lang.String id, java.lang.String... alternatives) Register a tile entity, with alternative TileEntity identifiers.
static Block	registerWithItem(Block block) Deprecated.
static void	registerWorldGenerator(IWorldGenerator generator, int modGenerationWeight) Register a world generator - something that inserts new block types into the world

Methods inherited from class java.lang.Object

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

Constructor Detail

GameRegistry

public GameRegistry()

Method Detail

registerWorldGenerator

public static void registerWorldGenerator(IWorldGenerator generator,
                                          int modGenerationWeight)

Register a world generator - something that inserts new block types into the world

Parameters:

generator - the generator

modGenerationWeight - a weight to assign to this generator. Heavy weights tend to sink to the bottom of list of world generators (i.e. they run later)

generateWorld

public static void generateWorld(int chunkX,
                                 int chunkZ,
                                 World world,
                                 IChunkGenerator chunkGenerator,
                                 IChunkProvider chunkProvider)

Callback hook for world gen - if your mod wishes to add extra mod related generation to the world call this

Parameters:

chunkX - Chunk X coordinate

chunkZ - Chunk Z coordinate

world - World we're generating into

chunkGenerator - The chunk generator

chunkProvider - The chunk provider

register

public static <K extends IForgeRegistryEntry<?>> K register(K object)

Register the previously named IForgeRegistry object with the registry system. Always ensure the object is already named using IForgeRegistryEntry.setRegistryName(ResourceLocation) or another mechanism. Note: That DOES NOT create the ItemBlock for you if this is a Block, you should register that item separately.

Type Parameters:

K - The registry supertype

Parameters:

object - The object to register with a registry

Returns:

The object

Throws:

java.lang.IllegalArgumentException - if the object is not yet named (use register(IForgeRegistryEntry, ResourceLocation) instead)

register

public static <K extends IForgeRegistryEntry<?>> K register(K object,
                                                            ResourceLocation name)

Register the unnamed IForgeRegistry object with the registry system. Always make sure you have not previously named the object. It is advised that you set the object's registry name and use register(IForgeRegistryEntry) instead. Note: That DOES NOT create the ItemBlock for you if this is a Block, you should register that item separately.

Type Parameters:

K - The registry supertype

Parameters:

object - The object to register

name - The name to register it with

Returns:

The object

Throws:

java.lang.IllegalStateException - if the object already has an existing name (use register(IForgeRegistryEntry) instead)

registerWithItem

@Deprecated
public static Block registerWithItem(Block block)

Deprecated.

Registers a named block with the Block registry. This WILL create a new ItemBlock for you with the same name and register it with the ItemRegistry. This method is created as a convince method for modder and SHOULD NOT be used. Modders should create and register their ItemBlocks like normal items.

Parameters:

block - The block to register with a registry

Returns:

The block

Throws:

java.lang.IllegalArgumentException - if the object is not yet named

findRegistry

public static <K extends IForgeRegistryEntry<K>> IForgeRegistry<K> findRegistry(java.lang.Class<K> registryType)

Retrieves the registry associated with this super class type. If the return is non-null it is HIGHLY recommended that modders cache this value as the return will never change for a given type in a single run of Minecraft once set.

Parameters:

registryType - The base class of items in this registry.

Returns:

The registry, Null if none is registered.

addSubstitutionAlias

public static void addSubstitutionAlias(java.lang.String nameToSubstitute,
                                        GameRegistry.Type type,
                                        java.lang.Object object)
                                 throws ExistingSubstitutionException

Add a forced persistent substitution alias for the block or item to another block or item. This will have the effect of using the substituted block or item instead of the original, where ever it is referenced.

Parameters:

nameToSubstitute - The name to link to (this is the NEW block or item)

type - The type (Block or Item)

object - a NEW instance that is type compatible with the existing instance

Throws:

ExistingSubstitutionException - if someone else has already registered an alias either from or to one of the names

IncompatibleSubstitutionException - if the substitution is incompatible

addRecipe

public static void addRecipe(@Nonnull
                             ItemStack output,
                             java.lang.Object... params)

addShapedRecipe

public static IRecipe addShapedRecipe(@Nonnull
                                      ItemStack output,
                                      java.lang.Object... params)

addShapelessRecipe

public static void addShapelessRecipe(@Nonnull
                                      ItemStack output,
                                      java.lang.Object... params)

addRecipe

public static void addRecipe(IRecipe recipe)

addSmelting

public static void addSmelting(Block input,
                               @Nonnull
                               ItemStack output,
                               float xp)

addSmelting

public static void addSmelting(Item input,
                               @Nonnull
                               ItemStack output,
                               float xp)

addSmelting

public static void addSmelting(@Nonnull
                               ItemStack input,
                               @Nonnull
                               ItemStack output,
                               float xp)

registerTileEntity

public static void registerTileEntity(java.lang.Class<? extends TileEntity> tileEntityClass,
                                      java.lang.String id)

registerTileEntityWithAlternatives

public static void registerTileEntityWithAlternatives(java.lang.Class<? extends TileEntity> tileEntityClass,
                                                      java.lang.String id,
                                                      java.lang.String... alternatives)

Register a tile entity, with alternative TileEntity identifiers. Use with caution! This method allows for you to "rename" the 'id' of the tile entity.

Parameters:

tileEntityClass - The tileEntity class to register

id - The primary ID, this will be the ID that the tileentity saves as

alternatives - A list of alternative IDs that will also map to this class. These will never save, but they will load

registerFuelHandler

public static void registerFuelHandler(IFuelHandler handler)

getFuelValue

public static int getFuelValue(@Nonnull
                               ItemStack itemStack)

makeItemStack

@Nonnull
public static ItemStack makeItemStack(java.lang.String itemName,
                                                int meta,
                                                int stackSize,
                                                java.lang.String nbtString)

Makes an ItemStack based on the itemName reference, with supplied meta, stackSize and nbt, if possible

Will return null if the item doesn't exist (because it's not from a loaded mod for example) Will throw a RuntimeException if the nbtString is invalid for use in an ItemStack

Parameters:

itemName - a registry name reference

meta - the meta

stackSize - the stack size

nbtString - an nbt stack as a string, will be processed by JsonToNBT

Returns:

a new itemstack