Package net.fabricmc.fabric.api.itemgroup.v1

Class FabricItemGroupEntries

java.lang.Object

net.fabricmc.fabric.api.itemgroup.v1.FabricItemGroupEntries

All Implemented Interfaces:

ItemGroup.Entries

@Experimental
public class FabricItemGroupEntries
extends Object
implements ItemGroup.Entries

This class allows the entries of item groups to be modified by the events in ItemGroupEvents.

Constructor Summary

Constructors

Constructor	Description
FabricItemGroupEntries(ItemGroup.DisplayContext context, List<ItemStack> displayStacks, List<ItemStack> searchTabStacks)

Method Summary

Modifier and Type	Method	Description
void	add(ItemStack stack, ItemGroup.StackVisibility visibility)	Adds a stack to the end of the item group.
void	addAfter(Predicate<ItemStack> afterLast, Collection<ItemStack> newStacks, ItemGroup.StackVisibility visibility)	Adds stacks after the last group entry matching a predicate, or at the end, if no entries match.
void	addAfter(ItemConvertible afterLast, Collection<ItemStack> newStacks)	See addAfter(ItemConvertible, Collection, net.minecraft.item.ItemGroup.StackVisibility).
void	addAfter(ItemConvertible afterLast, Collection<ItemStack> newStacks, ItemGroup.StackVisibility visibility)	Adds stacks after an existing item in the group, or at the end, if the item isn't in the group.
void	addAfter(ItemConvertible afterLast, ItemConvertible... newItem)	See addAfter(ItemConvertible, Collection).
void	addAfter(ItemConvertible afterLast, ItemStack... newStack)	See addAfter(ItemConvertible, Collection).
void	addAfter(ItemStack afterLast, Collection<ItemStack> newStacks)	See addAfter(ItemStack, Collection, net.minecraft.item.ItemGroup.StackVisibility).
void	addAfter(ItemStack afterLast, Collection<ItemStack> newStacks, ItemGroup.StackVisibility visibility)	Adds stacks after an existing stack in the group, or at the end, if the stack isn't in the group.
void	addAfter(ItemStack afterLast, ItemConvertible... newItem)	See addAfter(ItemStack, Collection).
void	addAfter(ItemStack afterLast, ItemStack... newStack)	See addAfter(ItemStack, Collection).
void	addBefore(Predicate<ItemStack> beforeFirst, Collection<ItemStack> newStacks, ItemGroup.StackVisibility visibility)	Adds stacks before the first group entry matching a predicate, or at the end, if no entries match.
void	addBefore(ItemConvertible beforeFirst, Collection<ItemStack> newStacks)	See addBefore(ItemConvertible, Collection, net.minecraft.item.ItemGroup.StackVisibility).
void	addBefore(ItemConvertible beforeFirst, Collection<ItemStack> newStacks, ItemGroup.StackVisibility visibility)	Adds stacks before an existing item in the group, or at the end, if the item isn't in the group.
void	addBefore(ItemConvertible beforeFirst, ItemConvertible... newItem)	See addBefore(ItemConvertible, Collection).
void	addBefore(ItemConvertible beforeFirst, ItemStack... newStack)	See addBefore(ItemConvertible, Collection).
void	addBefore(ItemStack beforeFirst, Collection<ItemStack> newStacks)	See addBefore(ItemStack, Collection, net.minecraft.item.ItemGroup.StackVisibility).
void	addBefore(ItemStack beforeFirst, Collection<ItemStack> newStacks, ItemGroup.StackVisibility visibility)	Adds stacks before an existing stack to the group, or at the end, if the stack isn't in the group.
void	addBefore(ItemStack beforeFirst, ItemConvertible... newItem)	See addBefore(ItemStack, Collection).
void	addBefore(ItemStack beforeFirst, ItemStack... newStack)	See addBefore(ItemStack, Collection).
ItemGroup.DisplayContext	getContext()
List<ItemStack>	getDisplayStacks()
FeatureSet	getEnabledFeatures()
List<ItemStack>	getSearchTabStacks()
void	prepend(ItemConvertible item)	See prepend(ItemStack).
void	prepend(ItemConvertible item, ItemGroup.StackVisibility visibility)	See prepend(ItemStack, net.minecraft.item.ItemGroup.StackVisibility).
void	prepend(ItemStack stack)	See prepend(ItemStack, ItemGroup.StackVisibility).
void	prepend(ItemStack stack, ItemGroup.StackVisibility visibility)	Adds a stack to the beginning of the item group.
boolean	shouldShowOpRestrictedItems()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.item.ItemGroup.Entries

add, add, add, addAll, addAll

Constructor Details

FabricItemGroupEntries

@Internal
public FabricItemGroupEntries(ItemGroup.DisplayContext context,
 List<ItemStack> displayStacks,
 List<ItemStack> searchTabStacks)

Method Details

getContext

public ItemGroup.DisplayContext getContext()

getEnabledFeatures

public FeatureSet getEnabledFeatures()

Returns:

the currently enabled feature set

shouldShowOpRestrictedItems

public boolean shouldShowOpRestrictedItems()

Returns:

whether to show items restricted to operators, such as command blocks

getDisplayStacks

public List<ItemStack> getDisplayStacks()

Returns:

the stacks that will be shown in the tab in the creative mode inventory

API Note:

This list can be modified.

getSearchTabStacks

public List<ItemStack> getSearchTabStacks()

Returns:

the stacks that will be searched by the creative mode inventory search

API Note:

This list can be modified.

add

public void add(ItemStack stack,
 ItemGroup.StackVisibility visibility)

Adds a stack to the end of the item group. Duplicate stacks will be removed.

Specified by:

add in interface ItemGroup.Entries

Parameters:

visibility - Determines whether the stack will be shown in the tab itself, returned for searches, or both.

prepend

public void prepend(ItemStack stack)

See prepend(ItemStack, ItemGroup.StackVisibility). Will use ItemGroup.StackVisibility.PARENT_AND_SEARCH_TABS for visibility.

prepend

public void prepend(ItemStack stack,
 ItemGroup.StackVisibility visibility)

Adds a stack to the beginning of the item group. Duplicate stacks will be removed.

Parameters:

visibility - Determines whether the stack will be shown in the tab itself, returned for searches, or both.

prepend

public void prepend(ItemConvertible item)

See prepend(ItemStack). Automatically creates an ItemStack from the given item.

prepend

public void prepend(ItemConvertible item,
 ItemGroup.StackVisibility visibility)

See prepend(ItemStack, net.minecraft.item.ItemGroup.StackVisibility). Automatically creates an ItemStack from the given item.

addAfter

public void addAfter(ItemConvertible afterLast,
 ItemStack... newStack)

See addAfter(ItemConvertible, Collection).

addAfter

public void addAfter(ItemStack afterLast,
 ItemStack... newStack)

See addAfter(ItemStack, Collection).

addAfter

public void addAfter(ItemConvertible afterLast,
 ItemConvertible... newItem)

See addAfter(ItemConvertible, Collection).

addAfter

public void addAfter(ItemStack afterLast,
 ItemConvertible... newItem)

See addAfter(ItemStack, Collection).

addAfter

public void addAfter(ItemConvertible afterLast,
 Collection<ItemStack> newStacks)

See addAfter(ItemConvertible, Collection, net.minecraft.item.ItemGroup.StackVisibility).

addAfter

public void addAfter(ItemStack afterLast,
 Collection<ItemStack> newStacks)

See addAfter(ItemStack, Collection, net.minecraft.item.ItemGroup.StackVisibility).

addAfter

public void addAfter(ItemConvertible afterLast,
 Collection<ItemStack> newStacks,
 ItemGroup.StackVisibility visibility)

Adds stacks after an existing item in the group, or at the end, if the item isn't in the group.

Parameters:

afterLast - Add newStacks after the last entry of this item in the group.

newStacks - The stacks to add. Only enabled stacks will be added.

visibility - Determines whether the stack will be shown in the tab itself, returned for searches, or both.

addAfter

public void addAfter(ItemStack afterLast,
 Collection<ItemStack> newStacks,
 ItemGroup.StackVisibility visibility)

Adds stacks after an existing stack in the group, or at the end, if the stack isn't in the group.

Parameters:

afterLast - Add newStacks after the last group entry matching this stack (compared using ItemStack.canCombine(net.minecraft.item.ItemStack, net.minecraft.item.ItemStack)).

newStacks - The stacks to add. Only enabled stacks will be added.

visibility - Determines whether the stack will be shown in the tab itself, returned for searches, or both.

addAfter

public void addAfter(Predicate<ItemStack> afterLast,
 Collection<ItemStack> newStacks,
 ItemGroup.StackVisibility visibility)

Adds stacks after the last group entry matching a predicate, or at the end, if no entries match.

Parameters:

afterLast - Add newStacks after the last group entry matching this predicate.

newStacks - The stacks to add. Only enabled stacks will be added.

visibility - Determines whether the stack will be shown in the tab itself, returned for searches, or both.

addBefore

public void addBefore(ItemConvertible beforeFirst,
 ItemStack... newStack)

See addBefore(ItemConvertible, Collection).

addBefore

public void addBefore(ItemStack beforeFirst,
 ItemStack... newStack)

See addBefore(ItemStack, Collection).

addBefore

public void addBefore(ItemConvertible beforeFirst,
 ItemConvertible... newItem)

See addBefore(ItemConvertible, Collection).

addBefore

public void addBefore(ItemStack beforeFirst,
 ItemConvertible... newItem)

See addBefore(ItemStack, Collection).

addBefore

public void addBefore(ItemConvertible beforeFirst,
 Collection<ItemStack> newStacks)

See addBefore(ItemConvertible, Collection, net.minecraft.item.ItemGroup.StackVisibility).

addBefore

public void addBefore(ItemStack beforeFirst,
 Collection<ItemStack> newStacks)

See addBefore(ItemStack, Collection, net.minecraft.item.ItemGroup.StackVisibility).

addBefore

public void addBefore(ItemConvertible beforeFirst,
 Collection<ItemStack> newStacks,
 ItemGroup.StackVisibility visibility)

Adds stacks before an existing item in the group, or at the end, if the item isn't in the group.

Parameters:

beforeFirst - Add newStacks before the first entry of this item in the group.

newStacks - The stacks to add. Only enabled stacks will be added.

visibility - Determines whether the stack will be shown in the tab itself, returned for searches, or both.

addBefore

public void addBefore(ItemStack beforeFirst,
 Collection<ItemStack> newStacks,
 ItemGroup.StackVisibility visibility)

Adds stacks before an existing stack to the group, or at the end, if the stack isn't in the group.

Parameters:

beforeFirst - Add newStacks before the first group entry matching this stack (compared using ItemStack.canCombine(net.minecraft.item.ItemStack, net.minecraft.item.ItemStack)).

newStacks - The stacks to add. Only enabled stacks will be added.

visibility - Determines whether the stack will be shown in the tab itself, returned for searches, or both.

addBefore

public void addBefore(Predicate<ItemStack> beforeFirst,
 Collection<ItemStack> newStacks,
 ItemGroup.StackVisibility visibility)

Adds stacks before the first group entry matching a predicate, or at the end, if no entries match.

Parameters:

beforeFirst - Add newStacks before the first group entry matching this predicate.

newStacks - The stacks to add. Only enabled stacks will be added.

visibility - Determines whether the stack will be shown in the tab itself, returned for searches, or both.