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

Class LockedItemGroup

java.lang.Object

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

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

All Implemented Interfaces:

Keyed

public class LockedItemGroup
extends ItemGroup

Represents a ItemGroup that cannot be opened until the parent group(s) are fully unlocked.

See ItemGroup for the complete documentation.

Author:

TheBusyBiscuit

See Also:

• ItemGroup
• SeasonalItemGroup

Field Summary

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

crossAddonItemGroup, item, items, key, tier

Constructor Summary

Constructors

Constructor	Description
LockedItemGroup(NamespacedKey key, ItemStack item, int tier, NamespacedKey... parents)	The constructor for a LockedItemGroup.
LockedItemGroup(NamespacedKey key, ItemStack item, NamespacedKey... parents)	The basic constructor for a LockedItemGroup.

Method Summary

Modifier and Type	Method	Description
void	addParent(ItemGroup group)	Adds a parent ItemGroup to this LockedItemGroup.
Set<ItemGroup>	getParents()	Gets the list of parent item groups for this LockedItemGroup.
boolean	hasUnlocked(Player p, PlayerProfile profile)	Checks if the Player has fully unlocked all parent categories.
void	register(SlimefunAddon addon)	Registers this ItemGroup.
void	removeParent(ItemGroup group)	Removes a ItemGroup from the parents of this LockedItemGroup.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

LockedItemGroup

@ParametersAreNonnullByDefault
public LockedItemGroup(NamespacedKey key,
 ItemStack item,
 NamespacedKey... parents)

The basic constructor for a LockedItemGroup. Like ItemGroup, the default tier is automatically set to 3.

Parameters:

key - A unique identifier for this group

item - The display item for this group

parents - The parent categories for this group

LockedItemGroup

@ParametersAreNonnullByDefault
public LockedItemGroup(NamespacedKey key,
 ItemStack item,
 int tier,
 NamespacedKey... parents)

The constructor for a LockedItemGroup.

Parameters:

key - A unique identifier for this group

item - The display item for this group

tier - The tier of this group

parents - The parent categories for this group

Method Details

register

public 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

getParents

@Nonnull
public Set<ItemGroup> getParents()

Gets the list of parent item groups for this LockedItemGroup.

Returns:

the list of parent item groups

See Also:

• addParent(ItemGroup)
• removeParent(ItemGroup)

addParent

public void addParent(ItemGroup group)

Adds a parent ItemGroup to this LockedItemGroup.

Parameters:

group - The ItemGroup to add as a parent

See Also:

• getParents()
• removeParent(ItemGroup)

removeParent

public void removeParent(@Nonnull
 ItemGroup group)

Removes a ItemGroup from the parents of this LockedItemGroup.

Parameters:

group - The ItemGroup to remove from the parents of this LockedItemGroup

See Also:

• getParents()
• addParent(ItemGroup)

hasUnlocked

public boolean hasUnlocked(@Nonnull
 Player p,
 @Nonnull
 PlayerProfile profile)

Checks if the Player has fully unlocked all parent categories.

Parameters:

p - The Player to check

profile - The PlayerProfile that belongs to the given Player

Returns:

Whether the Player has fully completed all parent categories, otherwise false