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

Class NestedItemGroup

java.lang.Object

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

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

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

All Implemented Interfaces:

net.kyori.adventure.key.Keyed, org.bukkit.Keyed

public class NestedItemGroup
extends FlexItemGroup

Field Summary

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

crossAddonItemGroup, item, items, key, tier

Constructor Summary

Constructors

Constructor	Description
NestedItemGroup(org.bukkit.NamespacedKey key, org.bukkit.inventory.ItemStack item)
NestedItemGroup(org.bukkit.NamespacedKey key, org.bukkit.inventory.ItemStack item, int tier)

Method Summary

Modifier and Type	Method	Description
void	addSubGroup(SubItemGroup group)	This will add the given SubItemGroup to this NestedItemGroup.
boolean	isVisible(org.bukkit.entity.Player p, PlayerProfile profile, SlimefunGuideMode mode)	This method returns whether this FlexItemGroup is visible under the given context.
void	open(org.bukkit.entity.Player p, PlayerProfile profile, SlimefunGuideMode mode)	This method is called when a Player opens this FlexItemGroup.
void	removeSubGroup(SubItemGroup group)	This will remove the given SubItemGroup from this NestedItemGroup (if present).

Methods inherited from class io.github.thebusybiscuit.slimefun4.api.items.groups.FlexItemGroup

add, contains, getItems, isVisible, remove

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

equals, getAddon, getDisplayName, getItem, getKey, getTier, getUnlocalizedName, hashCode, isAccessible, isCrossAddonItemGroup, isHidden, isRegistered, register, setCrossAddonItemGroup, setTier, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bukkit.Keyed

key

Constructor Details

NestedItemGroup

@ParametersAreNonnullByDefault
public NestedItemGroup(org.bukkit.NamespacedKey key,
 org.bukkit.inventory.ItemStack item)

NestedItemGroup

@ParametersAreNonnullByDefault
public NestedItemGroup(org.bukkit.NamespacedKey key,
 org.bukkit.inventory.ItemStack item,
 int tier)

Method Details

addSubGroup

public void addSubGroup(@Nonnull
 SubItemGroup group)

This will add the given SubItemGroup to this NestedItemGroup.

Parameters:

group - The SubItemGroup to add.

removeSubGroup

public void removeSubGroup(@Nonnull
 SubItemGroup group)

This will remove the given SubItemGroup from this NestedItemGroup (if present).

Parameters:

group - The SubItemGroup to remove.

isVisible

@ParametersAreNonnullByDefault
public boolean isVisible(org.bukkit.entity.Player p,
 PlayerProfile profile,
 SlimefunGuideMode mode)

Description copied from class: FlexItemGroup

This method returns whether this FlexItemGroup is visible under the given context. Implementing this method gives full flexibility over who can see the ItemGroup when and where.

Specified by:

isVisible in class FlexItemGroup

Parameters:

p - The Player who opened his SlimefunGuide

profile - The PlayerProfile of the Player

mode - The SlimefunGuideMode in which this FlexItemGroup is viewed

Returns:

Whether to display this FlexItemGroup

open

@ParametersAreNonnullByDefault
public void open(org.bukkit.entity.Player p,
 PlayerProfile profile,
 SlimefunGuideMode mode)

Description copied from class: FlexItemGroup

This method is called when a Player opens this FlexItemGroup. This is an abstract method which needs to be implemented in order to determine what this FlexItemGroup should actually do as it cannot hold any items.

Specified by:

open in class FlexItemGroup

Parameters:

p - The Player who wants to open this FlexItemGroup

profile - The corresponding PlayerProfile for that Player

mode - The current SlimefunGuideMode