net.minecraftforge.oredict

Class OreDictionary

java.lang.Object

net.minecraftforge.oredict.OreDictionary

public class OreDictionary
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OreDictionary.OreRegisterEvent

Field Summary

Fields

Modifier and Type	Field and Description
static NonNullList<ItemStack>	EMPTY_LIST
static int	WILDCARD_VALUE Minecraft changed from -1 to Short.MAX_VALUE in 1.5 release for the "block wildcard".

Constructor Summary

Constructors

Constructor and Description
OreDictionary()

Method Summary

Modifier and Type	Method and Description
static boolean	containsMatch(boolean strict, NonNullList<ItemStack> inputs, ItemStack... targets)
static boolean	doesOreNameExist(java.lang.String name) Returns whether or not an oreName exists in the dictionary.
static int	getOreID(java.lang.String name) Gets the integer ID for the specified ore name.
static int[]	getOreIDs(ItemStack stack) Gets all the integer ID for the ores that the specified item stack is registered to.
static java.lang.String	getOreName(int id) Reverse of getOreID, will not create new entries.
static java.lang.String[]	getOreNames() Retrieves a list of all unique ore names that are already registered.
static NonNullList<ItemStack>	getOres(java.lang.String name) Retrieves the ArrayList of items that are registered to this ore type.
static NonNullList<ItemStack>	getOres(java.lang.String name, boolean alwaysCreateEntry) Retrieves the List of items that are registered to this ore type at this instant.
static boolean	itemMatches(ItemStack target, ItemStack input, boolean strict)
static void	rebakeMap()
static void	registerOre(java.lang.String name, Block ore)
static void	registerOre(java.lang.String name, Item ore)
static void	registerOre(java.lang.String name, ItemStack ore)

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_LIST

public static final NonNullList<ItemStack> EMPTY_LIST

WILDCARD_VALUE

public static final int WILDCARD_VALUE

Minecraft changed from -1 to Short.MAX_VALUE in 1.5 release for the "block wildcard". Use this in case it changes again.

See Also:

Constant Field Values

Constructor Detail

OreDictionary

public OreDictionary()

Method Detail

getOreID

public static int getOreID(java.lang.String name)

Gets the integer ID for the specified ore name. If the name does not have a ID it assigns it a new one.

Parameters:

name - The unique name for this ore 'oreIron', 'ingotIron', etc..

Returns:

A number representing the ID for this ore type

getOreName

public static java.lang.String getOreName(int id)

Reverse of getOreID, will not create new entries.

Parameters:

id - The ID to translate to a string

Returns:

The String name, or "Unknown" if not found.

getOreIDs

public static int[] getOreIDs(@Nonnull
                              ItemStack stack)

Gets all the integer ID for the ores that the specified item stack is registered to. If the item stack is not linked to any ore, this will return an empty array and no new entry will be created.

Parameters:

stack - The item stack of the ore.

Returns:

An array of ids that this ore is registered as.

getOres

public static NonNullList<ItemStack> getOres(java.lang.String name)

Retrieves the ArrayList of items that are registered to this ore type. Creates the list as empty if it did not exist. The returned List is unmodifiable, but will be updated if a new ore is registered using registerOre

Parameters:

name - The ore name, directly calls getOreID

Returns:

An arrayList containing ItemStacks registered for this ore

getOres

public static NonNullList<ItemStack> getOres(java.lang.String name,
                                             boolean alwaysCreateEntry)

Retrieves the List of items that are registered to this ore type at this instant. If the flag is TRUE, then it will create the list as empty if it did not exist. This option should be used by modders who are doing blanket scans in postInit. It greatly reduces clutter in the OreDictionary is the responsible and proper way to use the dictionary in a large number of cases. The other function above is utilized in OreRecipe and is required for the operation of that code.

Parameters:

name - The ore name, directly calls getOreID if the flag is TRUE

alwaysCreateEntry - Flag - should a new entry be created if empty

Returns:

An arraylist containing ItemStacks registered for this ore

doesOreNameExist

public static boolean doesOreNameExist(java.lang.String name)

Returns whether or not an oreName exists in the dictionary. This function can be used to safely query the Ore Dictionary without adding needless clutter to the underlying map structure. Please use this when possible and appropriate.

Parameters:

name - The ore name

Returns:

Whether or not that name is in the Ore Dictionary.

getOreNames

public static java.lang.String[] getOreNames()

Retrieves a list of all unique ore names that are already registered.

Returns:

All unique ore names that are currently registered.

containsMatch

public static boolean containsMatch(boolean strict,
                                    NonNullList<ItemStack> inputs,
                                    @Nonnull
                                    ItemStack... targets)

itemMatches

public static boolean itemMatches(@Nonnull
                                  ItemStack target,
                                  @Nonnull
                                  ItemStack input,
                                  boolean strict)

registerOre

public static void registerOre(java.lang.String name,
                               Item ore)

registerOre

public static void registerOre(java.lang.String name,
                               Block ore)

registerOre

public static void registerOre(java.lang.String name,
                               @Nonnull
                               ItemStack ore)

rebakeMap

public static void rebakeMap()