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

Class SeasonalItemGroup

java.lang.Object

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

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

All Implemented Interfaces:

Keyed

public class SeasonalItemGroup
extends ItemGroup

Represents a ItemGroup that is only displayed in the Guide during a specified Month.

Author:

TheBusyBiscuit

See Also:

• ItemGroup
• LockedItemGroup

Field Summary

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

crossAddonItemGroup, item, items, key, tier

Constructor Summary

Constructors

Constructor	Description
SeasonalItemGroup(NamespacedKey key, Month month, int tier, ItemStack item)	The constructor for a SeasonalItemGroup.

Method Summary

Modifier and Type	Method	Description
Month	getMonth()	This method returns the Month in which this SeasonalItemGroup will appear.
boolean	isAccessible(Player p)	This method returns whether this ItemGroup can be accessed by the given Player.

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, isVisible, register, remove, setCrossAddonItemGroup, setTier, toString

Methods inherited from class java.lang.Object

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

Constructor Details

SeasonalItemGroup

@ParametersAreNonnullByDefault
public SeasonalItemGroup(NamespacedKey key,
 Month month,
 int tier,
 ItemStack item)

The constructor for a SeasonalItemGroup.

Parameters:

key - The NamespacedKey that is used to identify this ItemGroup

month - The month when the ItemGroup should be displayed (from 1 = January ; to 12 = December)

tier - The tier of this ItemGroup

item - The display item for this ItemGroup

Method Details

getMonth

@Nonnull
public Month getMonth()

This method returns the Month in which this SeasonalItemGroup will appear.

Returns:

the Month in which this SeasonalItemGroup appears

isAccessible

public 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