Version:

Language:

Invalid leaf directive! `since`

JEI

Manages all interactions between JeiTweaker plugins and JEI itself.

This class was added by a mod with mod-id jeitweaker. So you need to have this mod installed if you want to use this feature.

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.

ZenScript
 Copy
import mods.jei.JEI;

Static Methods

addCategory

Name: addCategory

Adds the given category to the list of categories shown by JEI.

Return Type: void

ZenScript
 Copy
JEI.addCategory(category as JeiCategory) as void

Parameter	Type	Description
Parameter category	Type JeiCategory	Description The category that should be added to JEI.

addDescription

Name: addDescription

Adds a description for the given JeiIngredient.

The description is defined as the text that is shown in the info box that appears as one of the recipe
categories for the queried ingredient.

Return Type: void

ZenScript
 Copy
JEI.addDescription(ingredient as JeiIngredient, description as MCTextComponent[]) as void

Parameter	Type	Description
Parameter ingredient	Type JeiIngredient	Description The ingredient to which the description should be added.
Parameter description	Type MCTextComponent[]	Description A series of MCTextComponents identifying the description.

addInfo

Name: addInfo

Deprecated

Use this#addDescription(RawJeiIngredient, MCTextComponent...) instead. If you are writing a script, conversion between IFluidStack and JeiIngredient is automatic: see com.blamejared.jeitweaker.zen.component.IFluidStackExpansions#asJeiIngredient(IFluidStack). Descriptions need to be converted manually instead: refer to MCTextComponent#createTranslationTextComponent(String).

Adds an information box for the given IFluidStack.

The information box is identified by an information symbol that appears as one of the categories available
when querying an ingredient.

Return Type: void

ZenScript
 Copy
JEI.addInfo(stack as IFluidStack, description as string[]) as void

Parameter	Type	Description
Parameter stack	Type IFluidStack	Description The stack to which the information box should be added to.
Parameter description	Type string[]	Description A series of strings that represent the description. These information boxes are treated as {

addInfo

Name: addInfo

Deprecated

Use this#addDescription(RawJeiIngredient, MCTextComponent...) instead. If you are writing a script, conversion between IItemStack and JeiIngredient is automatic: see com.blamejared.jeitweaker.zen.component.IItemStackExpansions#asJeiIngredient(IItemStack). Descriptions need to be converted manually instead: refer to MCTextComponent#createTranslationTextComponent(String).

Adds an information box for the given IItemStack.

The information box is identified by an information symbol that appears as one of the categories available
when querying an ingredient.

Return Type: void

ZenScript
 Copy
JEI.addInfo(stack as IItemStack, description as string[]) as void

Parameter	Type	Description
Parameter stack	Type IItemStack	Description The stack to which the information box should be added to.
Parameter description	Type string[]	Description A series of strings that represent the description. These information boxes are treated as {

addIngredient

Name: addIngredient

Adds the given JeiIngredient as a custom ingredient to be shown in JEI.

Return Type: void

ZenScript
 Copy
JEI.addIngredient(ingredient as JeiIngredient) as void

Parameter	Type	Description
Parameter ingredient	Type JeiIngredient	Description The ingredient that should be shown in JEI.

addItem

Name: addItem

Deprecated

Use this#addIngredient(RawJeiIngredient) instead. If you are writing a script, you can use the same syntax as conversion between IItemStack and JeiIngredient is automatic: see com.blamejared.jeitweaker.zen.component.IItemStackExpansions#asJeiIngredient(IItemStack).

Adds the given IItemStack to the list of ingredients that JEI should display.

Return Type: void

ZenScript
 Copy
JEI.addItem(stack as IItemStack) as void

Parameter	Type	Description
Parameter stack	Type IItemStack	Description The stack to be added to JEI.

hideCategory

Name: hideCategory

Hides the category identified by the given category ID from displaying within JEI.

A full list of categories is available through the /ct dump jeiCategories command.

Return Type: void

ZenScript
 Copy
JEI.hideCategory(category as string) as void

Parameter	Type	Description
Parameter category	Type string	Description The ID of the category to hide.

hideFluid

Name: hideFluid

Deprecated

Use this#hideIngredient(RawJeiIngredient) instead. If you are writing a script, the conversion between IFluidStack and JeiIngredient is automatic: see com.blamejared.jeitweaker.zen.component.IFluidStackExpansions#asJeiIngredient(IFluidStack).

Hides the given IFluidStack from within JEI.

Return Type: void

ZenScript
 Copy
JEI.hideFluid(stack as IFluidStack) as void

Parameter	Type	Description
Parameter stack	Type IFluidStack	Description The stack that should be hidden from JEI.

hideIngredient

Name: hideIngredient

Hides the given JeiIngredient, so that it does not show up in JEI.

Return Type: void

ZenScript
 Copy
JEI.hideIngredient(ingredient as JeiIngredient) as void

Parameter	Type	Description
Parameter ingredient	Type JeiIngredient	Description The ingredient that should be hidden from JEI.

hideItem

Name: hideItem

Deprecated

Use this#hideIngredient(RawJeiIngredient) instead. If you are writing a script, the conversion between IItemStack and JeiIngredient is automatic: see com.blamejared.jeitweaker.zen.component.IItemStackExpansions#asJeiIngredient(IItemStack).

Hides the given IItemStack from within JEI.

Return Type: void

ZenScript
 Copy
JEI.hideItem(stack as IItemStack) as void

Parameter	Type	Description
Parameter stack	Type IItemStack	Description The stack that should be hidden from JEI.

hideMod

Name: hideMod

Hides all JeiIngredients of a given mod, making sure that they do not show up in JEI.

Optionally, some ingredients can be excluded based on their registry name from the hiding by making use of the
RecipeFilter.

Return Type: void

ZenScript
 Copy
JEI.hideMod(modId as string, exclude as RecipeFilter) as void

Parameter	Type	Description	Optional	DefaultValue
Parameter modId	Type string	Description The mod ID of the ingredients that should be hidden.	Optional false	DefaultValue
Parameter exclude	Type RecipeFilter	Description An optional exclusion filter.	Optional true	DefaultValue (name as string) => {return false;}

hideRecipe

Name: hideRecipe

Hides the recipe with the given name from appearing within the JEI category with the given ID.

Return Type: void

ZenScript
 Copy
JEI.hideRecipe(categoryId as string, recipeName as string) as void

Parameter	Type	Description
Parameter categoryId	Type string	Description The ID of the category where the recipe to hide is located.
Parameter recipeName	Type string	Description The name of the recipe that should be hidden from JEI.

hideRegex

Name: hideRegex

Hides all JeiIngredients whose name matches the given regular expression.

Return Type: void

ZenScript
 Copy
JEI.hideRegex(regex as string) as void

Parameter	Type	Description
Parameter regex	Type string	Description The regular expression that identifies ingredient names that should be hidden from JEI.