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

Class FlexItemGroup

java.lang.Object

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

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

All Implemented Interfaces:

Keyed

Direct Known Subclasses:

NestedItemGroup

public abstract class FlexItemGroup
extends ItemGroup

A FlexItemGroup is a ItemGroup inside the SlimefunGuide that can be completely modified. It cannot hold any SlimefunItem but can be completely overridden to perform any action upon being opened.

Author:

TheBusyBiscuit

Field Summary

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

crossAddonItemGroup, item, items, key, tier

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FlexItemGroup(NamespacedKey key, ItemStack item)
protected	FlexItemGroup(NamespacedKey key, ItemStack item, int tier)

Method Summary

Modifier and Type	Method	Description
final void	add(SlimefunItem item)	Adds the given SlimefunItem to this ItemGroup.
final boolean	contains(SlimefunItem item)	This method returns whether a given SlimefunItem exists in this ItemGroup.
final List<SlimefunItem>	getItems()	Returns all instances of SlimefunItem bound to this ItemGroup.
final boolean	isVisible(Player p)	This method returns whether this ItemGroup can be viewed by the given Player.
abstract boolean	isVisible(Player p, PlayerProfile profile, SlimefunGuideMode layout)	This method returns whether this FlexItemGroup is visible under the given context.
abstract void	open(Player p, PlayerProfile profile, SlimefunGuideMode layout)	This method is called when a Player opens this FlexItemGroup.
final void	remove(SlimefunItem item)	Removes the given SlimefunItem from this ItemGroup.

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

Constructor Details

FlexItemGroup

@ParametersAreNonnullByDefault
protected FlexItemGroup(NamespacedKey key,
 ItemStack item)

FlexItemGroup

@ParametersAreNonnullByDefault
protected FlexItemGroup(NamespacedKey key,
 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

isVisible

@ParametersAreNonnullByDefault
public abstract boolean isVisible(Player p,
 PlayerProfile profile,
 SlimefunGuideMode layout)

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.

Parameters:

p - The Player who opened his SlimefunGuide

profile - The PlayerProfile of the Player

layout - The SlimefunGuideMode in which this FlexItemGroup is viewed

Returns:

Whether to display this FlexItemGroup

open

public abstract void open(Player p,
 PlayerProfile profile,
 SlimefunGuideMode layout)

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.

Parameters:

p - The Player who wants to open this FlexItemGroup

profile - The corresponding PlayerProfile for that Player

layout - The current SlimefunGuideMode

add

public final void add(@Nonnull
 SlimefunItem item)

Description copied from class: ItemGroup

Adds the given SlimefunItem to this ItemGroup.

Overrides:

add in class ItemGroup

Parameters:

item - the SlimefunItem that should be added to this ItemGroup

getItems

@Nonnull
public final List<SlimefunItem> getItems()

Description copied from class: ItemGroup

Returns all instances of SlimefunItem bound to this ItemGroup.

Overrides:

getItems in class ItemGroup

Returns:

the list of SlimefunItems bound to this ItemGroup

contains

public final boolean contains(SlimefunItem item)

Description copied from class: ItemGroup

This method returns whether a given SlimefunItem exists in this ItemGroup.

Overrides:

contains in class ItemGroup

Parameters:

item - The SlimefunItem to find

Returns:

Whether the given SlimefunItem was found in this ItemGroup

remove

public final void remove(@Nonnull
 SlimefunItem item)

Description copied from class: ItemGroup

Removes the given SlimefunItem from this ItemGroup.

Overrides:

remove in class ItemGroup

Parameters:

item - the SlimefunItem that should be removed from this ItemGroup