Package io.github.thebusybiscuit.slimefun4.implementation.items.backpacks

Class SlimefunBackpack

java.lang.Object

io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem

io.github.thebusybiscuit.slimefun4.implementation.items.SimpleSlimefunItem<ItemUseHandler>

io.github.thebusybiscuit.slimefun4.implementation.items.backpacks.SlimefunBackpack

All Implemented Interfaces:

DistinctiveItem, ItemAttribute, Placeable

Direct Known Subclasses:

Cooler, RestoredBackpack, SoulboundBackpack

public class SlimefunBackpack
extends SimpleSlimefunItem<ItemUseHandler>
implements DistinctiveItem

This class represents a SlimefunItem that is considered a Backpack. Right-Clicking will open the Inventory of the currently held Backpack.

Author:

TheBusyBiscuit

See Also:

• BackpackListener
• PlayerBackpack

Field Summary

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

addon, disenchantable, enchantable, hidden, recipeOutput, useableInWorkbench

Constructor Summary

Constructors

Constructor	Description
SlimefunBackpack(int size, ItemGroup itemGroup, SlimefunItemStack item, RecipeType recipeType, ItemStack[] recipe)

Method Summary

Modifier and Type	Method	Description
boolean	canStack(ItemMeta itemMetaOne, ItemMeta itemMetaTwo)	This method is called by SlimefunUtils.isItemSimilar(org.bukkit.inventory.ItemStack, org.bukkit.inventory.ItemStack, boolean) when two SlimefunItemStack IDs match on a DistinctiveItem and should return if the two items can stack with one another.
ItemUseHandler	getItemHandler()	This returns the ItemHandler that will be added to this SlimefunItem.
int	getSize()	This returns the size of this SlimefunBackpack.
boolean	isItemAllowed(ItemStack item, SlimefunItem itemAsSlimefunItem)	This method returns whether a given ItemStack is allowed to be stored in this SlimefunBackpack.

Methods inherited from class io.github.thebusybiscuit.slimefun4.implementation.items.SimpleSlimefunItem

preRegister

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

addItemHandler, addItemSetting, addOfficialWikipage, callItemHandler, canUse, equals, error, getAddon, getBlockTicker, getById, getByItem, getDrops, getDrops, getHandlers, getId, getItem, getItemGroup, getItemName, getItemSetting, getItemSettings, getOptionalById, getOptionalByItem, getRecipe, getRecipeOutput, getRecipeType, getResearch, getState, getWikipage, hashCode, hasResearch, info, isDisabled, isDisabledIn, isDisenchantable, isEnchantable, isHidden, isItem, isItemStackImmutable, isTicking, isUseableInWorkbench, load, postRegister, register, sendDeprecationWarning, setHidden, setItemGroup, setRecipe, setRecipeOutput, setRecipeType, setResearch, setUseableInWorkbench, toString, warn

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.thebusybiscuit.slimefun4.core.attributes.ItemAttribute

getId

Methods inherited from interface io.github.thebusybiscuit.slimefun4.core.attributes.Placeable

useVanillaBlockBreaking

Constructor Details

SlimefunBackpack

@ParametersAreNonnullByDefault
public SlimefunBackpack(int size,
 ItemGroup itemGroup,
 SlimefunItemStack item,
 RecipeType recipeType,
 ItemStack[] recipe)

Method Details

getSize

public int getSize()

This returns the size of this SlimefunBackpack.

Returns:

The size of this backpack

isItemAllowed

public boolean isItemAllowed(@Nonnull
 ItemStack item,
 @Nullable
 SlimefunItem itemAsSlimefunItem)

This method returns whether a given ItemStack is allowed to be stored in this SlimefunBackpack.

Parameters:

item - The ItemStack to check for

itemAsSlimefunItem - The same ItemStack as a SlimefunItem, might be null

Returns:

Whether the given ItemStack is allowed to be put into this SlimefunBackpack

getItemHandler

public ItemUseHandler getItemHandler()

Description copied from class: SimpleSlimefunItem

This returns the ItemHandler that will be added to this SlimefunItem.

Specified by:

getItemHandler in class SimpleSlimefunItem<ItemUseHandler>

Returns:

The ItemHandler that should be added to this SlimefunItem

canStack

public boolean canStack(@Nonnull
 ItemMeta itemMetaOne,
 @Nonnull
 ItemMeta itemMetaTwo)

Description copied from interface: DistinctiveItem

This method is called by SlimefunUtils.isItemSimilar(org.bukkit.inventory.ItemStack, org.bukkit.inventory.ItemStack, boolean) when two SlimefunItemStack IDs match on a DistinctiveItem and should return if the two items can stack with one another.

Specified by:

canStack in interface DistinctiveItem

Parameters:

itemMetaOne - The ItemMeta of the first stack being compared.

itemMetaTwo - The ItemMeta of the second stack being compared.

Returns:

Whether the two ItemMetas are stackable