cpw.mods.fml.common.registry

Class GameRegistry

java.lang.Object

cpw.mods.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
static interface	GameRegistry.ObjectHolder This will cause runtime injection of public static final fields to occur at various points where mod blocks and items could be subject to change.
static class	GameRegistry.Type
static class	GameRegistry.UniqueIdentifier

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 Block	findBlock(java.lang.String modId, java.lang.String name) Look up a mod block in the global "named item list"
static Item	findItem(java.lang.String modId, java.lang.String name) Look up a mod item in the global "named item list"
static ItemStack	findItemStack(java.lang.String modId, java.lang.String name, int stackSize) Lookup an itemstack based on mod and name.
static GameRegistry.UniqueIdentifier	findUniqueIdentifierFor(Block block) Look up the mod identifier data for a block.
static GameRegistry.UniqueIdentifier	findUniqueIdentifierFor(Item item) Look up the mod identifier data for an item.
static void	generateWorld(int chunkX, int chunkZ, World world, IChunkProvider 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 Block	registerBlock(Block block, java.lang.Class<? extends ItemBlock> itemclass, java.lang.String name) Register a block with the world, with the specified item class and block name
static Block	registerBlock(Block block, java.lang.Class<? extends ItemBlock> itemclass, java.lang.String name, java.lang.Object... itemCtorArgs) Register a block with the world, with the specified item class, block name and owning modId
static Block	registerBlock(Block block, java.lang.Class<? extends ItemBlock> itemclass, java.lang.String name, java.lang.String modId, java.lang.Object... itemCtorArgs) Deprecated. Use the registerBlock version without the modId parameter instead.
static Block	registerBlock(Block block, java.lang.String name) Register a block with the specified mod specific name
static void	registerCustomItemStack(java.lang.String name, ItemStack itemStack) Manually register a custom item stack with FML for later tracking.
static void	registerFuelHandler(IFuelHandler handler)
static void	registerItem(Item item, java.lang.String name) Register an item with the item registry with a custom name : this allows for easier server->client resolution
static Item	registerItem(Item item, java.lang.String name, java.lang.String modId) Register the specified Item with a mod specific name : overrides the standard type based name
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 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,
                                 IChunkProvider 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 -

chunkZ -

world -

chunkGenerator -

chunkProvider -

registerItem

public static void registerItem(Item item,
                                java.lang.String name)

Register an item with the item registry with a custom name : this allows for easier server->client resolution

Parameters:

item - The item to register

name - The mod-unique name of the item

registerItem

public static Item registerItem(Item item,
                                java.lang.String name,
                                java.lang.String modId)

Register the specified Item with a mod specific name : overrides the standard type based name

Parameters:

item - The item to register

name - The mod-unique name to register it as - null will remove a custom name

modId - deprecated, unused where one mod should "own" all the blocks of all the mods, null defaults to the active mod

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

registerBlock

public static Block registerBlock(Block block,
                                  java.lang.String name)

Register a block with the specified mod specific name

Parameters:

block - The block to register

name - The mod-unique name to register it as, will get prefixed by your modid.

registerBlock

public static Block registerBlock(Block block,
                                  java.lang.Class<? extends ItemBlock> itemclass,
                                  java.lang.String name)

Register a block with the world, with the specified item class and block name

Parameters:

block - The block to register

itemclass - The item type to register with it : null registers a block without associated item.

name - The mod-unique name to register it as, will get prefixed by your modid.

registerBlock

@Deprecated
public static Block registerBlock(Block block,
                                               java.lang.Class<? extends ItemBlock> itemclass,
                                               java.lang.String name,
                                               java.lang.String modId,
                                               java.lang.Object... itemCtorArgs)

Deprecated. Use the registerBlock version without the modId parameter instead.

registerBlock

public static Block registerBlock(Block block,
                                  java.lang.Class<? extends ItemBlock> itemclass,
                                  java.lang.String name,
                                  java.lang.Object... itemCtorArgs)

Register a block with the world, with the specified item class, block name and owning modId

Parameters:

block - The block to register

itemclass - The item type to register with it : null registers a block without associated item.

name - The mod-unique name to register it as, will get prefixed by your modid.

itemCtorArgs - Arguments to pass (after the required Block parameter) to the ItemBlock constructor (optional).

addRecipe

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

addShapedRecipe

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

addShapelessRecipe

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

addRecipe

public static void addRecipe(IRecipe recipe)

addSmelting

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

addSmelting

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

addSmelting

public static void addSmelting(ItemStack input,
                               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(ItemStack itemStack)

findBlock

public static Block findBlock(java.lang.String modId,
                              java.lang.String name)

Look up a mod block in the global "named item list"

Parameters:

modId - The modid owning the block

name - The name of the block itself

Returns:

The block or null if not found

findItem

public static Item findItem(java.lang.String modId,
                            java.lang.String name)

Look up a mod item in the global "named item list"

Parameters:

modId - The modid owning the item

name - The name of the item itself

Returns:

The item or null if not found

registerCustomItemStack

public static void registerCustomItemStack(java.lang.String name,
                                           ItemStack itemStack)

Manually register a custom item stack with FML for later tracking. It is automatically scoped with the active modid

Parameters:

name - The name to register it under

itemStack - The itemstack to register

findItemStack

public static ItemStack findItemStack(java.lang.String modId,
                                      java.lang.String name,
                                      int stackSize)

Lookup an itemstack based on mod and name. It will create "default" itemstacks from blocks and items if no explicit itemstack is found. If it is built from a block, the metadata is by default the "wildcard" value. Custom itemstacks can be dumped from minecraft by setting the system property fml.dumpRegistry to true (-Dfml.dumpRegistry=true on the command line will work)

Parameters:

modId - The modid of the stack owner

name - The name of the stack

stackSize - The size of the stack returned

Returns:

The custom itemstack or null if no such itemstack was found

findUniqueIdentifierFor

public static GameRegistry.UniqueIdentifier findUniqueIdentifierFor(Block block)

Look up the mod identifier data for a block. Returns null if there is no mod specified mod identifier data, or it is part of a custom itemstack definition registerCustomItemStack(java.lang.String, net.minecraft.item.ItemStack) Note: uniqueness and persistence is only guaranteed by mods using the game registry correctly.

Parameters:

block - to lookup

Returns:

a GameRegistry.UniqueIdentifier for the block or null

findUniqueIdentifierFor

public static GameRegistry.UniqueIdentifier findUniqueIdentifierFor(Item item)

Look up the mod identifier data for an item. Returns null if there is no mod specified mod identifier data, or it is part of a custom itemstack definition registerCustomItemStack(java.lang.String, net.minecraft.item.ItemStack) Note: uniqueness and persistence is only guaranteed by mods using the game registry correctly.

Parameters:

item - to lookup

Returns:

a GameRegistry.UniqueIdentifier for the item or null

makeItemStack

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