Version:

Language:

ItemGroup

An ItemGroup is a group of Items that is shown in the Creative mode inventory.

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 crafttweaker.api.item.ItemGroup;

Methods

fill

Name: fill

Fills the given List with this ItemGroup's Items.

Return Type: void

ZenScript
 Copy
// ItemGroup.fill(items as stdlib.List<IItemStack>) as void

<itemgroup:misc>.fill(new List<IItemStack>(););

Parameter	Type	Description
Parameter items	Type stdlib.List<IItemStack>	Description The list to fill.

getGroupName

Name: getGroupName

Gets the translated ItemGroup name.

Returns: The translated ItemGroup name.
Return Type: MCTextComponent

ZenScript
 Copy
// ItemGroup.getGroupName() as MCTextComponent

<itemgroup:misc>.getGroupName();

getItems

Name: getItems

Gets the items in this ItemGroup.

Returns: A list containing all the items in this ItemGroup.
Return Type: stdlib.List<IItemStack>

ZenScript
 Copy
// ItemGroup.getItems() as stdlib.List<IItemStack>

<itemgroup:misc>.getItems();

getLabelColor

Name: getLabelColor

Gets the color of the ItemGroup's name.

Returns: The color of the ItemGroup's name.
Return Type: int

ZenScript
 Copy
// ItemGroup.getLabelColor() as int

<itemgroup:misc>.getLabelColor();

getPath

Name: getPath

Gets the path of this ItemGroup. The path is the name of the ItemGroup.

Returns: The path of this ItemGroup.
Return Type: string

ZenScript
 Copy
// ItemGroup.getPath() as string

<itemgroup:misc>.getPath();

getRelevantEnchantmentTypes

Name: getRelevantEnchantmentTypes

Gets the relevant EnchantmentTypes of this ItemGroup. The EnchantmentTypes are used to determine what enchanted books should be put in the tab.

Returns: This ItemGroup's enchantment types.
Return Type: EnchantmentType[]

ZenScript
 Copy
// ItemGroup.getRelevantEnchantmentTypes() as EnchantmentType[]

<itemgroup:misc>.getRelevantEnchantmentTypes();

getSearchbarWidth

Name: getSearchbarWidth

Gets the width of the searchbar.

Returns: The width of the searchbar.
Return Type: int

ZenScript
 Copy
// ItemGroup.getSearchbarWidth() as int

<itemgroup:misc>.getSearchbarWidth();

getSlotColor

Name: getSlotColor

Gets the slot color that this ItemGroup uses.

Returns: The slot color that this ItemGroup uses.
Return Type: int

ZenScript
 Copy
// ItemGroup.getSlotColor() as int

<itemgroup:misc>.getSlotColor();

getTabPage

Name: getTabPage

Gets the page in the Creative Menu that this ItemGroup is on.

Returns: The page that this ItemGroup is on.
Return Type: int

ZenScript
 Copy
// ItemGroup.getTabPage() as int

<itemgroup:misc>.getTabPage();

hasRelevantEnchantmentType

Name: hasRelevantEnchantmentType

Checks if this ItemGroup has the given EnchantmentType.

Returns: True if it contains the EnchantmentType. False otherwise.
Return Type: boolean

ZenScript
 Copy
// ItemGroup.hasRelevantEnchantmentType(enchantmentType as EnchantmentType?) as boolean

<itemgroup:misc>.hasRelevantEnchantmentType(EnchantmentType.ARMOR);

Parameter	Type	Description
Parameter enchantmentType	Type EnchantmentType?	Description The EnchantmentType to check.

hasSearchBar

Name: hasSearchBar

Checks if this ItemGroup has a search bar.

Returns: True if this ItemGroup has a search bar. False otherwise.
Return Type: boolean

ZenScript
 Copy
// ItemGroup.hasSearchBar() as boolean

<itemgroup:misc>.hasSearchBar();

Properties

Name	Type	Has Getter	Has Setter	Description
Name commandString	Type string	Has Getter true	Has Setter false	Description No Description Provided
Name groupName	Type MCTextComponent	Has Getter true	Has Setter false	Description Gets the translated ItemGroup name.
Name items	Type stdlib.List<IItemStack>	Has Getter true	Has Setter false	Description Gets the items in this ItemGroup.
Name labelColor	Type int	Has Getter true	Has Setter false	Description Gets the color of the ItemGroup's name.
Name page	Type int	Has Getter true	Has Setter false	Description Gets the page in the Creative Menu that this ItemGroup is on.
Name path	Type string	Has Getter true	Has Setter false	Description Gets the path of this ItemGroup. The path is the name of the ItemGroup.
Name relevantEnchantmentTypes	Type EnchantmentType[]	Has Getter true	Has Setter false	Description Gets the relevant EnchantmentTypes of this ItemGroup. The EnchantmentTypes are used to determine what enchanted books should be put in the tab.
Name searchBar	Type boolean	Has Getter true	Has Setter false	Description Checks if this ItemGroup has a search bar.
Name searchBarWidth	Type int	Has Getter true	Has Setter false	Description Gets the width of the searchbar.
Name slotColor	Type int	Has Getter true	Has Setter false	Description Gets the slot color that this ItemGroup uses.