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.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.List<IEntitySelectorFactory>	entitySelectorFactories
private static java.util.List<IFuelHandler>	fuelHandlers
private static java.util.List<IWorldGenerator>	sortedGeneratorList
private static java.util.Map<IWorldGenerator,java.lang.Integer>	worldGeneratorIndex
private static java.util.Set<IWorldGenerator>	worldGenerators

Constructor Summary

Constructors

Constructor and Description
GameRegistry()

Method Summary

Modifier and Type	Method and Description
static void	addShapedRecipe(ResourceLocation name, ResourceLocation group, ItemStack output, java.lang.Object... params)
static void	addShapelessRecipe(ResourceLocation name, ResourceLocation group, ItemStack output, Ingredient... 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)
private static void	computeSortedGeneratorList()
static java.util.List<com.google.common.base.Predicate<Entity>>	createEntitySelectors(java.util.Map<java.lang.String,java.lang.String> arguments, java.lang.String mainSelector, ICommandSender sender, Vec3d position) Creates a list of entity selectors using the registered factories.
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) Deprecated. use ForgeEventFactory.getItemBurnTime(ItemStack)
static int	getFuelValueLegacy(ItemStack itemStack) Deprecated. use ForgeEventFactory.getItemBurnTime(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
private static <K extends IForgeRegistryEntry<K>> K	register(K object) This is now private, you should use either ForgeRegistries constants.
static void	registerEntitySelector(IEntitySelectorFactory factory, java.lang.String... arguments) Registers a entity selector factory which is used to create predicates whenever a command containing selectors is executed Any non vanilla arguments that you expect has to be registered.
static void	registerFuelHandler(IFuelHandler handler) Deprecated. set your item's Item.getItemBurnTime(ItemStack) or subscribe to FurnaceFuelBurnTimeEvent instead.
static void	registerTileEntity(java.lang.Class<? extends TileEntity> tileEntityClass, ResourceLocation key)
static void	registerTileEntity(java.lang.Class<? extends TileEntity> tileEntityClass, java.lang.String key) 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

Field Detail

worldGenerators

private static java.util.Set<IWorldGenerator> worldGenerators

worldGeneratorIndex

private static java.util.Map<IWorldGenerator,java.lang.Integer> worldGeneratorIndex

fuelHandlers

private static java.util.List<IFuelHandler> fuelHandlers

sortedGeneratorList

private static java.util.List<IWorldGenerator> sortedGeneratorList

entitySelectorFactories

private static java.util.List<IEntitySelectorFactory> entitySelectorFactories

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)

registerEntitySelector

public static void registerEntitySelector(IEntitySelectorFactory factory,
                                          java.lang.String... arguments)

Registers a entity selector factory which is used to create predicates whenever a command containing selectors is executed Any non vanilla arguments that you expect has to be registered. Otherwise Minecraft will throw an CommandException on usage. If you want to react to a command like "/kill @e[xyz=5]", you would have to register the argument "xyz" here and check for that argument in the factory. One factory can listen to any number of arguments as long as they are registered here. For inter mod compatibility you might want to use "modid:xyz" (e.g. "forge:min_health") as argument. For an example usage, see CustomEntitySelectorTest

Parameters:

arguments - Expected string arguments in commands

createEntitySelectors

public static java.util.List<com.google.common.base.Predicate<Entity>> createEntitySelectors(java.util.Map<java.lang.String,java.lang.String> arguments,
                                                                                             java.lang.String mainSelector,
                                                                                             ICommandSender sender,
                                                                                             Vec3d position)

Creates a list of entity selectors using the registered factories. Should probably only be called by Forge

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

computeSortedGeneratorList

private static void computeSortedGeneratorList()

register

private static <K extends IForgeRegistryEntry<K>> K register(K object)

This is now private, you should use either ForgeRegistries constants. Or the registry passed in during the RegistryEvent.Register event.

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.

addShapedRecipe

public static void addShapedRecipe(ResourceLocation name,
                                   ResourceLocation group,
                                   @Nonnull
                                   ItemStack output,
                                   java.lang.Object... params)

addShapelessRecipe

public static void addShapelessRecipe(ResourceLocation name,
                                      ResourceLocation group,
                                      @Nonnull
                                      ItemStack output,
                                      Ingredient... params)

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

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

Deprecated.

registerTileEntity

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

registerFuelHandler

@Deprecated
public static void registerFuelHandler(IFuelHandler handler)

Deprecated. set your item's Item.getItemBurnTime(ItemStack) or subscribe to FurnaceFuelBurnTimeEvent instead.

getFuelValue

@Deprecated
public static int getFuelValue(@Nonnull
                                           ItemStack itemStack)

Deprecated. use ForgeEventFactory.getItemBurnTime(ItemStack)

getFuelValueLegacy

@Deprecated
public static int getFuelValueLegacy(@Nonnull
                                                 ItemStack itemStack)

Deprecated. use ForgeEventFactory.getItemBurnTime(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