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

Class SlimefunItemStack

java.lang.Object

org.bukkit.inventory.ItemStack

io.github.thebusybiscuit.slimefun4.api.items.SlimefunItemStack

All Implemented Interfaces:

io.papermc.paper.persistence.PersistentDataViewHolder, Cloneable, net.kyori.adventure.text.event.HoverEventSource<net.kyori.adventure.text.event.HoverEvent.ShowItem>, net.kyori.adventure.translation.Translatable, org.bukkit.configuration.serialization.ConfigurationSerializable, org.bukkit.Translatable

public class SlimefunItemStack
extends org.bukkit.inventory.ItemStack

The SlimefunItemStack functions as the base for any SlimefunItem.

Author:

TheBusyBiscuit, Walshy

Constructor Summary

Constructors

Constructor	Description
SlimefunItemStack(SlimefunItemStack item, int amount)
SlimefunItemStack(String id, HeadTexture head, String name, String... lore)
SlimefunItemStack(String id, String texture, String name, String... lore)
SlimefunItemStack(String id, String texture, String name, Consumer<org.bukkit.inventory.meta.ItemMeta> consumer)
SlimefunItemStack(String id, String texture, Consumer<org.bukkit.inventory.meta.ItemMeta> consumer)
SlimefunItemStack(String id, org.bukkit.Color color, org.bukkit.potion.PotionEffect effect, String name, String... lore)
SlimefunItemStack(String id, org.bukkit.inventory.ItemStack item)
SlimefunItemStack(String id, org.bukkit.inventory.ItemStack item, String name, String... lore)
SlimefunItemStack(String id, org.bukkit.inventory.ItemStack item, Consumer<org.bukkit.inventory.meta.ItemMeta> consumer)
SlimefunItemStack(String id, org.bukkit.Material type, String name, String... lore)
SlimefunItemStack(String id, org.bukkit.Material type, String name, Consumer<org.bukkit.inventory.meta.ItemMeta> consumer)
SlimefunItemStack(String id, org.bukkit.Material type, Consumer<org.bukkit.inventory.meta.ItemMeta> consumer)
SlimefunItemStack(String id, org.bukkit.Material type, org.bukkit.Color color, String name, String... lore)

Method Summary

Modifier and Type	Method	Description
org.bukkit.inventory.ItemStack	clone()
final boolean	equals(Object obj)
String	getDisplayName()
SlimefunItem	getItem()	Gets the SlimefunItem associated for this SlimefunItemStack.
<T extends SlimefunItem> T	getItem(Class<T> type)	This method returns the associated SlimefunItem and casts it to the provided Class.
final String	getItemId()	Returns the id that was given to this SlimefunItemStack.
io.github.bakedlibs.dough.items.ItemMetaSnapshot	getItemMetaSnapshot()
Optional<String>	getSkullTexture()
final int	hashCode()
void	lock()
void	setAmount(int amount)
boolean	setItemMeta(org.bukkit.inventory.meta.ItemMeta meta)
void	setType(org.bukkit.Material type)
String	toString()

Methods inherited from class org.bukkit.inventory.ItemStack

add, add, addEnchantment, addEnchantments, addItemFlags, addUnsafeEnchantment, addUnsafeEnchantments, asHoverEvent, asOne, asQuantity, canRepair, computeTooltipLines, containsEnchantment, copyDataFrom, damage, deserialize, deserializeBytes, deserializeItemsFromBytes, displayName, editMeta, editMeta, editPersistentDataContainer, effectiveName, empty, enchantWithLevels, enchantWithLevels, ensureServerConversions, getAmount, getData, getData, getDataOrDefault, getDataTypes, getDurability, getEnchantmentLevel, getEnchantments, getI18NDisplayName, getItemFlags, getItemMeta, getLore, getMaxItemUseDuration, getMaxItemUseDuration, getMaxStackSize, getPersistentDataContainer, getRarity, getTranslationKey, getType, hasData, hasItemFlag, hasItemMeta, isDataOverridden, isEmpty, isRepairableBy, isSimilar, lore, lore, matchesWithoutData, matchesWithoutData, of, of, removeEnchantment, removeEnchantments, removeItemFlags, resetData, serialize, serializeAsBytes, serializeItemsAsBytes, serializeItemsAsBytes, setData, setData, setData, setData, setDurability, setLore, subtract, subtract, translationKey, unsetData, withType

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent

Constructor Details

SlimefunItemStack

public SlimefunItemStack(@Nonnull
 String id,
 @Nonnull
 org.bukkit.inventory.ItemStack item)

SlimefunItemStack

public SlimefunItemStack(@Nonnull
 String id,
 @Nonnull
 org.bukkit.inventory.ItemStack item,
 @Nonnull
 Consumer<org.bukkit.inventory.meta.ItemMeta> consumer)

SlimefunItemStack

public SlimefunItemStack(@Nonnull
 String id,
 @Nonnull
 org.bukkit.Material type,
 @Nonnull
 Consumer<org.bukkit.inventory.meta.ItemMeta> consumer)

SlimefunItemStack

public SlimefunItemStack(@Nonnull
 String id,
 @Nonnull
 org.bukkit.Material type,
 @Nullable
 String name,
 @Nonnull
 Consumer<org.bukkit.inventory.meta.ItemMeta> consumer)

SlimefunItemStack

public SlimefunItemStack(@Nonnull
 String id,
 @Nonnull
 org.bukkit.inventory.ItemStack item,
 @Nullable
 String name,
 String... lore)

SlimefunItemStack

public SlimefunItemStack(@Nonnull
 String id,
 @Nonnull
 org.bukkit.Material type,
 @Nullable
 String name,
 String... lore)

SlimefunItemStack

public SlimefunItemStack(@Nonnull
 String id,
 @Nonnull
 org.bukkit.Material type,
 @Nonnull
 org.bukkit.Color color,
 @Nullable
 String name,
 String... lore)

SlimefunItemStack

public SlimefunItemStack(@Nonnull
 String id,
 @Nonnull
 org.bukkit.Color color,
 @Nonnull
 org.bukkit.potion.PotionEffect effect,
 @Nullable
 String name,
 String... lore)

SlimefunItemStack

public SlimefunItemStack(@Nonnull
 SlimefunItemStack item,
 int amount)

SlimefunItemStack

public SlimefunItemStack(@Nonnull
 String id,
 @Nonnull
 String texture,
 @Nullable
 String name,
 String... lore)

SlimefunItemStack

public SlimefunItemStack(@Nonnull
 String id,
 @Nonnull
 HeadTexture head,
 @Nullable
 String name,
 String... lore)

SlimefunItemStack

public SlimefunItemStack(@Nonnull
 String id,
 @Nonnull
 String texture,
 @Nullable
 String name,
 @Nonnull
 Consumer<org.bukkit.inventory.meta.ItemMeta> consumer)

SlimefunItemStack

public SlimefunItemStack(@Nonnull
 String id,
 @Nonnull
 String texture,
 @Nonnull
 Consumer<org.bukkit.inventory.meta.ItemMeta> consumer)

Method Details

getItemId

@Nonnull
public final String getItemId()

Returns the id that was given to this SlimefunItemStack.

Returns:

The SlimefunItem id for this SlimefunItemStack

getItem

@Nullable
public SlimefunItem getItem()

Gets the SlimefunItem associated for this SlimefunItemStack. Null if no item is found.

Returns:

The SlimefunItem for this SlimefunItemStack, null if not found.

getItem

@Nullable
public <T extends SlimefunItem> T getItem(@Nonnull
 Class<T> type)

This method returns the associated SlimefunItem and casts it to the provided Class. If no item was found or the found SlimefunItem is not of the requested type, the method will return null.

Type Parameters:

T - The type of SlimefunItem to cast this to

Parameters:

type - The Class of the target SlimefunItem

Returns:

The SlimefunItem this SlimefunItem represents, casted to the given type

getItemMetaSnapshot

@Nonnull
public io.github.bakedlibs.dough.items.ItemMetaSnapshot getItemMetaSnapshot()

setItemMeta

public boolean setItemMeta(org.bukkit.inventory.meta.ItemMeta meta)

Overrides:

setItemMeta in class org.bukkit.inventory.ItemStack

setType

public void setType(org.bukkit.Material type)

Overrides:

setType in class org.bukkit.inventory.ItemStack

setAmount

public void setAmount(int amount)

Overrides:

setAmount in class org.bukkit.inventory.ItemStack

lock

public void lock()

getSkullTexture

@Nonnull
public Optional<String> getSkullTexture()

getDisplayName

@Nullable
public String getDisplayName()

clone

public org.bukkit.inventory.ItemStack clone()

Overrides:

clone in class org.bukkit.inventory.ItemStack

toString

public String toString()

Overrides:

toString in class org.bukkit.inventory.ItemStack

equals

public final boolean equals(Object obj)

Overrides:

equals in class org.bukkit.inventory.ItemStack

hashCode

public final int hashCode()

Overrides:

hashCode in class org.bukkit.inventory.ItemStack