crafttweaker.api.item

Interface IItemUtils

public interface IItemUtils

Class for various Item utils can be called with itemUtils.function

Method Summary

Modifier and Type	Method and Description
IData	combineEnchantments(IEnchantment... enchantments)
IData	combineEnchantments(java.lang.String baseKey, IEnchantment... enchantments)
IItemStack	createEnchantedBook(IEnchantment... enchantments)
IItemStack	createPotion(IPotionEffect... params)
IItemStack	createPotion(java.lang.Object[]... params)
IItemStack	createSpawnEgg(IEntityDefinition entity, IData customNBT) Creates a Spawnegg of the given entity
IItemStack	enchantItem(IItemStack item, IEnchantment... enchantments)
IItemStack	getItem(java.lang.String location, int meta) Invokes the Bracket Handler Item method
IItemStack[]	getItemsByRegexRegistryName(java.lang.String regex) Gets all Items where the Regex matches the Registry name check in syntax "mod:item:meta" meta is always present
IItemStack[]	getItemsByRegexUnlocalizedName(java.lang.String regex) Gets all Items where the Regex matches the Unlocalized name check in syntax "mod:item:meta" meta is always present

Method Detail

createPotion

IItemStack createPotion(java.lang.Object[]... params)

Parameters:

params - has to be in this syntax: [, strength, time], [, strength, time], ...

Returns:

returns the IItemStack of the potion

createPotion

IItemStack createPotion(IPotionEffect... params)

Parameters:

params - list of IPotionEffects

Returns:

retursn the IItemStack of the potion

enchantItem

IItemStack enchantItem(IItemStack item,
                       IEnchantment... enchantments)

Parameters:

item - An item to be enchanted. Outside of checking for or (to determine which key to use), no checks are made to make sure that the enchantments can actually be applied to the item. If the item is already enchanted, this will attempt to merge the new enchantments into the existing list.

enchantments - List of enchantments, the result of (eg): .makeEnchantment(3);

Returns:

returns the IItemStack of the item with new enchantments.

createEnchantedBook

IItemStack createEnchantedBook(IEnchantment... enchantments)

Parameters:

enchantments - List of enchantment, the result of (eg): .makeEnchantment(3);

Returns:

returns the IItemStack of the enchanted book.

combineEnchantments

IData combineEnchantments(java.lang.String baseKey,
                          IEnchantment... enchantments)

Parameters:

baseKey - The base key, one of either "ench" or "StoredEnchantments". The former functions for enchanted items (swords, weapons, tools, etc) while the latter is specifically for Enchanted Books.

enchantments - Contains the enchantment to combine, result of (eg): .makeEnchantment(3)

Returns:

A combined list of enchantments as though you had manually combined using makeTag. This unoverloaded method allows for specifying the base key, unlike its overloaded counterpart.

combineEnchantments

IData combineEnchantments(IEnchantment... enchantments)

Parameters:

enchantments - Contains the enchantment to combine, result of (eg): .makeEnchantment(3)

Returns:

A combined list of enchantments as though you had manually combined using makeTag. By default this method overloads with the key "ench", making it suitable for application to the end-result product enchanted items. Use the unoverloaded method with the key "StoredEnchantments" to create an enchanted book, or use createEnchantedBook.

getItemsByRegexRegistryName

IItemStack[] getItemsByRegexRegistryName(java.lang.String regex)

Gets all Items where the Regex matches the Registry name check in syntax "mod:item:meta" meta is always present

Parameters:

regex - to compare agains

Returns:

Array of Items that match

getItem

IItemStack getItem(java.lang.String location,
                   int meta)

Invokes the Bracket Handler Item method

Parameters:

location - What you would write in the BH, e.g. "minecraft:dirt"

meta - The metadata, default to 0

Returns:

The same thing the Bracket handler would return.

getItemsByRegexUnlocalizedName

IItemStack[] getItemsByRegexUnlocalizedName(java.lang.String regex)

Gets all Items where the Regex matches the Unlocalized name check in syntax "mod:item:meta" meta is always present

Parameters:

regex - to compare agains

Returns:

Array of Items that match

createSpawnEgg

IItemStack createSpawnEgg(IEntityDefinition entity,
                          IData customNBT)

Creates a Spawnegg of the given entity

Parameters:

entity -

customNBT - NBT that the Item should have, entity gets overwritten by function example: itemUtils.createSpawnEgg(, {EntityTag:{id:"minecraft:creeper",NoAI:1 as byte,PersistenceRequired:1 as byte}})