IIngredient
This is IIngredient!!!
Importing the class
It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.
import crafttweaker.api.item.IIngredient;
Implemented Interfaces
IIngredient implements the following interfaces. That means all methods defined in these interfaces are also available in IIngredient
Casters
Methods
Return Type: void
IIngredient.addShiftTooltip(content as MCTextComponent, showMessage as MCTextComponent) as void
Return Type: void
IIngredient.addTooltip(content as MCTextComponent) as void
Create a Vanilla ingredient matching this one.
Return Type: Ingredient
IIngredient.asVanillaIngredient() as Ingredient
<tag:items:forge:ingots>.asVanillaIngredient();
Return Type: void
IIngredient.clearTooltip() as void
<tag:items:forge:ingots>.clearTooltip();
Does the ingredient contain the given ingredient?
Return Type: boolean
IIngredient.contains(ingredient as IIngredient) as boolean
<tag:items:forge:ingots>.contains((<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>));
| Parameter | Type | Description |
|---|
| ingredient | IIngredient | The ingredient to check |
When this ingredient stack is crafted, what will remain in the grid? Does not check if the stack matches though! Used e.g. in Crafting Table recipes.
Return Type: IItemStack
IIngredient.getRemainingItem(stack as IItemStack) as IItemStack
<tag:items:forge:ingots>.getRemainingItem(<item:minecraft:iron_ingot>);
| Parameter | Type | Description |
|---|
| stack | IItemStack | The stack to provide for this ingredient. |
Does the given stack match the ingredient?
Return Type: boolean
IIngredient.matches(stack as IItemStack) as boolean
<tag:items:forge:ingots>.matches(<item:minecraft:iron_ingot>);
| Parameter | Type | Description |
|---|
| stack | IItemStack | The stack to check |
Does the given stack match the ingredient?
Return Type: boolean
IIngredient.matches(stack as IItemStack, ignoreDamage as boolean) as boolean
| Parameter | Type | Description |
|---|
| stack | IItemStack | The stack to check |
| ignoreDamage | boolean | Should damage be checked? |
Return Type: void
IIngredient.modifyTooltip(function as ITooltipFunction) as void
Use this if you already have the condition from another ingredient
Return Type: MCIngredientConditioned<IIngredient>
IIngredient.only(condition as IIngredientCondition<IIngredient>) as MCIngredientConditioned<IIngredient>
Return Type: MCIngredientConditioned<IIngredient>
IIngredient.onlyIf(uid as string, function as Predicate<IItemStack>) as MCIngredientConditioned<IIngredient>
| Parameter | Type | Description | Optional | DefaultValue |
|---|
| uid | string | No Description Provided | false | |
| function | Predicate<IItemStack> | No Description Provided | true | |
Return Type: void
IIngredient.removeTooltip(regex as string) as void
| Parameter | Type | Description |
|---|
| regex | string | No Description Provided |
Operators
Does the ingredient contain the given ingredient?
ingredient as IIngredient in myIIngredient
(<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>) in <tag:items:forge:ingots>
myIIngredient | other as IIngredient
Properties
| Name | Type | Has Getter | Has Setter |
|---|
| burnTime | void | false | true |
| commandString | string | true | false |
| items | IItemStack[] | true | false |
