Package io.github.thebusybiscuit.slimefun4.api.items.groups

Class SubItemGroup

java.lang.Object

io.github.thebusybiscuit.slimefun4.api.items.ItemGroup

io.github.thebusybiscuit.slimefun4.api.items.groups.SubItemGroup

All Implemented Interfaces:

Keyed

public class SubItemGroup
extends ItemGroup

The SubItemGroup is a child ItemGroup of the NestedItemGroup.

Author:

TheBusyBiscuit

See Also:

• NestedItemGroup

Field Summary

Fields inherited from class io.github.thebusybiscuit.slimefun4.api.items.ItemGroup

crossAddonItemGroup, item, items, key, tier

Constructor Summary

Constructors

Constructor	Description
SubItemGroup(NamespacedKey key, NestedItemGroup parent, ItemStack item)
SubItemGroup(NamespacedKey key, NestedItemGroup parent, ItemStack item, int tier)

Method Summary

Modifier and Type	Method	Description
final NestedItemGroup	getParent()	This method returns the parent NestedItemGroup which this SubItemGroup belongs to.
final boolean	isAccessible(Player p)	This method returns whether this ItemGroup can be accessed by the given Player.
final boolean	isVisible(Player p)	This method returns whether this ItemGroup can be viewed by the given Player.
final boolean	isVisibleInNested(Player p)	This method returns whether this SubItemGroup can be viewed by the given Player in a NestedItemGroup.
final void	register(SlimefunAddon addon)	Registers this ItemGroup.

Methods inherited from class io.github.thebusybiscuit.slimefun4.api.items.ItemGroup

add, contains, equals, getAddon, getDisplayName, getItem, getItems, getKey, getTier, getUnlocalizedName, hashCode, isCrossAddonItemGroup, isHidden, isRegistered, remove, setCrossAddonItemGroup, setTier, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SubItemGroup

@ParametersAreNonnullByDefault
public SubItemGroup(NamespacedKey key,
 NestedItemGroup parent,
 ItemStack item)

SubItemGroup

@ParametersAreNonnullByDefault
public SubItemGroup(NamespacedKey key,
 NestedItemGroup parent,
 ItemStack item,
 int tier)

Method Details

isVisible

public final boolean isVisible(@Nonnull
 Player p)

Description copied from class: ItemGroup

This method returns whether this ItemGroup can be viewed by the given Player. Empty ItemGroups will not be visible. This includes ItemGroups where every SlimefunItem is disabled. If an ItemGroup is not accessible by the Player, see ItemGroup.isAccessible(Player), this method will also return false.

Overrides:

isVisible in class ItemGroup

Parameters:

p - The Player to check for

Returns:

Whether this ItemGroup is visible to the given Player

isAccessible

public final boolean isAccessible(@Nonnull
 Player p)

Description copied from class: ItemGroup

This method returns whether this ItemGroup can be accessed by the given Player. If an ItemGroup is not accessible, it will not show up in the SlimefunGuide nor will items from this ItemGroup show up in the guide search.

Overrides:

isAccessible in class ItemGroup

Parameters:

p - The Player to check for

Returns:

Whether this ItemGroup is accessible by the given Player

isVisibleInNested

public final boolean isVisibleInNested(@Nonnull
 Player p)

This method returns whether this SubItemGroup can be viewed by the given Player in a NestedItemGroup. Empty ItemGroups will not be visible. This includes ItemGroups where every SlimefunItem is disabled. If an ItemGroup is not accessible by the Player, see isAccessible(Player), this method will also return false.

Parameters:

p - The Player to check for

Returns:

Whether this SubItemGroup is visible to the given Player in the NestedItemGroup

getParent

@Nonnull
public final NestedItemGroup getParent()

This method returns the parent NestedItemGroup which this SubItemGroup belongs to.

Returns:

The parent NestedItemGroup

register

public final void register(@Nonnull
 SlimefunAddon addon)

Description copied from class: ItemGroup

Registers this ItemGroup.

By default, an ItemGroup is automatically registered when a SlimefunItem was added to it.

Overrides:

register in class ItemGroup

Parameters:

addon - The SlimefunAddon that wants to register this ItemGroup