Package net.tnemc.item

Interface AbstractItemStack<T>

Type Parameters:

T - The implementation-specific type of this item stack.

All Superinterfaces:

Cloneable

All Known Implementing Classes:

BukkitItemStack, PaperItemStack

public interface AbstractItemStack<T>
extends Cloneable

Represents a generic abstraction for an item stack with various attributes and properties. This interface allows for chaining multiple properties and supports serialization.

Author:

creatorfromhell

Method Summary

Modifier and Type	Method	Description
default AbstractItemStack<T>	add(int amount)	Adds the specified amount to the current amount of this item stack.
int	amount()	The quantity of the item stack.
AbstractItemStack<T>	amount(int amount)	Sets the quantity of the item stack.
default <C extends SerialComponent<? extends AbstractItemStack<T>, T>> AbstractItemStack<T>	applyComponent(C component)	Applies a serialized component to the item stack.
default AbstractItemStack<T>	applyPersistent(PersistentDataType<?> data)	Applies persistent data to the item stack.
AbstractItemStack<T>	applyPersistentHolder(PersistentDataHolder newHolder, boolean replaceOld)	Replaces the persistent data holder for the item stack.
default Optional<AttributeModifiersComponent<AbstractItemStack<T>,T>>	attributeModifiers()	Retrieves the AttributeModifiersComponent of the item stack if present.
AbstractItemStack<T>	attributeModifiers(List<AttributeModifier> modifiers, boolean showInTooltip)	Updates the attribute modifiers of the item stack.
default Optional<BannerPatternsComponent<AbstractItemStack<T>,T>>	bannerPatterns()	Retrieves the BannerPatternsComponent of the item stack if present.
AbstractItemStack<T>	bannerPatterns(List<PatternData> patterns)	Updates the banner patterns of the item stack.
default Optional<BaseColorComponent<AbstractItemStack<T>,T>>	baseColor()	Retrieves the BaseColorComponent of the item stack if present.
AbstractItemStack<T>	baseColor(String color)	Updates the base color of the item stack.
default Optional<BlocksAttacksComponent<AbstractItemStack<T>,T>>	blocksAttacks()	Retrieves the BlocksAttacksComponent associated with this method.
AbstractItemStack<T>	blocksAttacks(ItemDamage damage)	Blocks attacks with the specified damage type using this item.
default Optional<BreakSoundComponent<AbstractItemStack<T>,T>>	breakSound()	Retrieves the break sound component associated with the object.
AbstractItemStack<T>	breakSound(String sound)	Set the break sound for this item stack.
default Optional<BucketEntityDataComponent<AbstractItemStack<T>,T>>	bucketEntityData()	Retrieves the BucketEntityDataComponent of the item stack if present.
AbstractItemStack<T>	bucketEntityData(boolean noAI, boolean silent, boolean noGravity, boolean glowing, boolean invulnerable, float health, int age, int variant, long huntingCooldown, int bucketVariantTag, String type)	Updates the bucket entity data of the item stack.
default Optional<BundleComponent<AbstractItemStack<T>,T>>	bundle()	Retrieves the bundle component from the components map.
AbstractItemStack<T>	bundle(Map<Integer,AbstractItemStack<T>> items)	Bundles a collection of AbstractItemStack instances into a single collection.
default Optional<CanBreakComponent<AbstractItemStack<T>,T>>	canBreak()	Retrieves the CanBreakComponent of the item stack if present.
AbstractItemStack<T>	canBreak(List<BlockPredicate> predicates)	Updates the blocks that the item stack can break.
default Optional<CanPlaceOnComponent<AbstractItemStack<T>,T>>	canPlaceOn()	Retrieves the CanPlaceOnComponent of the item stack if present.
AbstractItemStack<T>	canPlaceOn(List<BlockPredicate> predicates)	Updates the blocks that the item stack can be placed on.
default <C extends SerialComponent<? extends AbstractItemStack<T>, T>> Optional<C>	component(String identifier)	Retrieves a SerialComponent associated with the specified identifier.
<C extends SerialComponent<? extends AbstractItemStack<T>, T>> Map<String,C>	components()	Retrieves the components applied to the item stack.
default Optional<ConsumableComponent<AbstractItemStack<T>,T>>	consumable()	Retrieves the ConsumableComponent of the item stack if present.
AbstractItemStack<T>	consumable(float consumeSeconds, String animation, String sound, boolean hasConsumeParticles, List<ComponentEffect> effects)	Updates the consumable properties of the item stack.
default Optional<ContainerComponent<AbstractItemStack<T>,T>>	container()	Returns an Optional containing the ContainerComponent with type parameters AbstractItemStack and T stored in this container.
AbstractItemStack<T>	container(Map<Integer,AbstractItemStack<T>> items)	Constructs a container with the given map of items.
default Optional<CustomNameComponent<AbstractItemStack<T>,T>>	customName()	Retrieves the CustomNameComponent of the item stack if present.
AbstractItemStack<T>	customName(net.kyori.adventure.text.Component customName)	Updates the custom name of the item stack.
default Optional<DamageComponent<AbstractItemStack<T>,T>>	damage()	Retrieves the DamageComponent of the item stack if present.
AbstractItemStack<T>	damage(int damage)	Updates the damage of the item stack.
default Optional<DamageResistantComponent<AbstractItemStack<T>,T>>	damageResistant()	Retrieves the DamageResistantComponent of the item stack if present.
AbstractItemStack<T>	damageResistant(List<String> types)	Updates the damage-resistant types of the item stack.
default Optional<DeathProtectionComponent<AbstractItemStack<T>,T>>	deathProtection()	Retrieves the DeathProtectionComponent of the item stack if present.
AbstractItemStack<T>	deathProtection(List<ComponentEffect> deathEffects)	Updates the death protection effects of the item stack.
AbstractItemStack<T>	debug(boolean debug)	Enables or disables debug mode for the item stack.
default Optional<DyedColorComponent<AbstractItemStack<T>,T>>	dyedColor()	Retrieves the DyedColorComponent of the item stack if present.
AbstractItemStack<T>	dyedColor(int rgb)	Updates the dyed color of the item stack.
AbstractItemStack<T>	enchant(String enchantment, int level)	Adds an enchantment to the item stack.
AbstractItemStack<T>	enchant(List<String> enchantments)	Adds enchantments to the item stack by name.
AbstractItemStack<T>	enchant(Map<String,Integer> enchantments)	Adds multiple enchantments to the item stack.
default Optional<EnchantableComponent<AbstractItemStack<T>,T>>	enchantable()	Retrieves the EnchantableComponent of the item stack if present.
AbstractItemStack<T>	enchantable(int value)	Updates the enchantability of the item stack.
default Optional<EnchantmentGlintOverrideComponent<AbstractItemStack<T>,T>>	enchantmentGlintOverride()	Retrieves the EnchantmentGlintOverrideComponent of the item stack if present.
AbstractItemStack<T>	enchantmentGlintOverride(boolean glintOverride)	Updates the enchantment glint override of the item stack.
default Optional<EnchantmentsComponent<AbstractItemStack<T>,T>>	enchantments()	Retrieves the EnchantmentsComponent of the item stack if present.
AbstractItemStack<T>	enchantments(Map<String,Integer> levels)	Updates the enchantments of the item stack.
default Optional<EntityVariantComponent<AbstractItemStack<T>,T>>	entityVariant()	Retrieves the Entity Variant Component for the current stack.
AbstractItemStack<T>	entityVariant(String entity, String variant)	Generates an AbstractItemStack based on the given entity and variant.
default Optional<EquipComponent<AbstractItemStack<T>,T>>	equip()	Retrieves the EquipComponent of the item stack if present.
AbstractItemStack<T>	equip(String cameraKey, String equipSound, String modelKey, EquipSlot slot, boolean damageOnHurt, boolean dispensable, boolean swappable, boolean equipOnInteract, List<String> entities)	Equips an item with specified parameters.
default Optional<FireworkExplosionComponent<AbstractItemStack<T>,T>>	fireworkExplosion()	Retrieves the FireworkExplosionComponent of the item stack if present.
AbstractItemStack<T>	fireworkExplosion(ExplosionData explosion)	Updates the firework explosion properties of the item stack.
default Optional<FireworksComponent<AbstractItemStack<T>,T>>	fireworks()	Retrieves the FireworksComponent of the item stack if present.
AbstractItemStack<T>	fireworks(byte flightDuration, List<ExplosionData> explosions)	Updates the fireworks properties of the item stack.
List<String>	flags()	Retrieves the item flags.
AbstractItemStack<T>	flags(List<String> flags)	Sets the item flags.
default Optional<FoodComponent<AbstractItemStack<T>,T>>	food()	Retrieves the FoodComponent of the item stack if present.
AbstractItemStack<T>	food(boolean noHunger, float saturation, int nutrition)	Updates the food properties of the item stack.
default Optional<GliderComponent<AbstractItemStack<T>,T>>	glider()	Retrieves the GliderComponent of the item stack if present.
AbstractItemStack<T>	gliderTag()	Updates the item stack to enable glider functionality.
default boolean	hasComponent(String identifier)	Checks if a component with the specified identifier is present.
default Optional<HideAdditionalTooltipComponent<AbstractItemStack<T>,T>>	hideAdditionalTooltip()	Retrieves the HideAdditionalTooltipComponent of the item stack if present.
AbstractItemStack<T>	hideAdditionalTooltipTag()	Updates the item stack to hide additional tooltip.
default Optional<HideTooltipComponent<AbstractItemStack<T>,T>>	hideTooltip()	Retrieves the HideTooltipComponent of the item stack if present.
AbstractItemStack<T>	hideTooltipTag()	Updates the item stack to hide its tooltip.
default Optional<InstrumentComponent<AbstractItemStack<T>,T>>	instrument()	Retrieves the InstrumentComponent of the item stack if present.
AbstractItemStack<T>	instrument(String soundEvent, int useDuration, int range)	Updates the instrument properties of the item stack.
default Optional<IntangibleProjectileComponent<AbstractItemStack<T>,T>>	intangibleProjectile()	Retrieves the IntangibleProjectileComponent of the item stack if present.
AbstractItemStack<T>	intangibleProjectileTag()	Updates the item stack as an intangible projectile.
boolean	isDirty()	Checks whether the object is dirty or has unsaved changes.
default Optional<ItemModelComponent<AbstractItemStack<T>,T>>	itemModel()	Retrieves the ItemModelComponent of the item stack if present.
AbstractItemStack<T>	itemModel(String model)	Updates the model properties of the item stack.
default Optional<ItemNameComponent<AbstractItemStack<T>,T>>	itemName()	Retrieves the ItemNameComponent of the item stack if present.
AbstractItemStack<T>	itemName(net.kyori.adventure.text.Component itemName)	Updates the name of the item stack.
String	itemProvider()	This method returns a String representing the item provider.
default Optional<JukeBoxComponent<AbstractItemStack<T>,T>>	jukebox()	Retrieves the JukeBoxComponent of the item stack if present.
AbstractItemStack<T>	jukebox(String song, boolean showInTooltip)	Updates the jukebox properties of the item stack.
default Optional<LodestoneTrackerComponent<AbstractItemStack<T>,T>>	lodestoneTracker()	Retrieves the LodestoneTrackerComponent of the item stack if present.
AbstractItemStack<T>	lodestoneTracker(String target, int[] pos, String dimension, boolean tracked)	Updates the lodestone tracker properties of the item stack.
default Optional<LoreComponent<AbstractItemStack<T>,T>>	lore()	Retrieves the LoreComponent of the item stack if present.
AbstractItemStack<T>	lore(List<net.kyori.adventure.text.Component> lore)	Updates the lore of the item stack.
AbstractItemStack<T>	loreComponent(List<net.kyori.adventure.text.Component> lore)	Sets the lore (descriptive text) of the item stack.
default Optional<MapColorComponent<AbstractItemStack<T>,T>>	mapColor()	Retrieves the MapColorComponent of the item stack if present.
AbstractItemStack<T>	mapColor(int mapColor)	Updates the map color of the item stack.
default Optional<MapIDComponent<AbstractItemStack<T>,T>>	mapId()	Retrieves the MapIDComponent of the item stack if present.
AbstractItemStack<T>	mapId(int mapId)	Updates the map ID of the item stack.
void	markDirty()	Marks the item stack as dirty, indicating changes have been made.
String	material()	Returns the material of the item stack.
AbstractItemStack<T>	material(String material)	Sets the material of the item stack.
default Optional<MaxDamageComponent<AbstractItemStack<T>,T>>	maxDamage()	Retrieves the MaxDamageComponent of the item stack if present.
AbstractItemStack<T>	maxDamage(int maxDamage)	Updates the maximum damage of the item stack.
default Optional<MaxStackSizeComponent<AbstractItemStack<T>,T>>	maxStackSize()	Retrieves the MaxStackSizeComponent of the item stack if present.
AbstractItemStack<T>	maxStackSize(int maxStackSize)	Updates the maximum stack size of the item stack.
default Optional<ModelDataComponent<AbstractItemStack<T>,T>>	modelData()	Retrieves the ModelDataComponent of the item stack if present.
AbstractItemStack<T>	modelData(List<String> colours, List<Float> floats, List<Boolean> flags, List<String> strings)	Updates the model data of the item stack.
default Optional<ModelDataOldComponent<AbstractItemStack<T>,T>>	modelDataOld()	Deprecated. Since MC 1.21.3 Use ItemModelComponent and ModelDataComponent.
AbstractItemStack<T>	modelDataOld(int customModelData)	Deprecated. Since MC 1.21.3 Use ItemModelComponent and ModelDataComponent.
default Optional<NoteBlockSoundComponent<AbstractItemStack<T>,T>>	noteBlockSound()	Retrieves the NoteBlockSoundComponent of the item stack if present.
AbstractItemStack<T>	noteBlockSound(String soundId)	Updates the note block sound of the item stack.
AbstractItemStack<T>	of(String material, int amount)	Creates a new item stack with the specified material and amount.
AbstractItemStack<T>	of(org.json.simple.JSONObject json)	Creates a new item stack from a JSON representation.
AbstractItemStack<T>	of(T locale)	Creates a new item stack from a locale-specific object.
default Optional<OminousBottleAmplifierComponent<AbstractItemStack<T>,T>>	ominousBottleAmplifier()	Retrieves the OminousBottleAmplifierComponent of the item stack if present.
AbstractItemStack<T>	ominousBottleAmplifier(int amplifier)	Updates the ominous bottle amplifier of the item stack.
PersistentDataHolder	persistentHolder()	Retrieves the persistent data holder for the item stack.
default Optional<PotDecorationsComponent<AbstractItemStack<T>,T>>	potDecorations()	Retrieves the PotDecorationsComponent of the item stack if present.
AbstractItemStack<T>	potDecorations(List<String> decorations)	Updates the pot decorations of the item stack.
default Optional<PotionContentsComponent<AbstractItemStack<T>,T>>	potionContents()	Retrieves the PotionContentsComponent of the item stack if present.
AbstractItemStack<T>	potionContents(String potionId, int customColor, String customName, List<EffectInstance> effects)	Updates the potion contents of the item stack.
default Optional<PotionDurationScaleComponent<AbstractItemStack<T>,T>>	potionDuration()	Retrieves the potion duration scale component from the item's components.
AbstractItemStack<T>	potionDuration(float potionDuration)	Sets the duration of a potion effect for the item stack.
default Optional<ProfileComponent<AbstractItemStack<T>,T>>	profile()	Retrieves the profile component from the components map if it exists.
default AbstractItemStack<T>	profile(String name, UUID uuid)	Create a Profile based on the provided name and UUID.
default AbstractItemStack<T>	profile(String name, UUID uuid, String texture)	Profiles the item stack with the given name, UUID, and texture.
AbstractItemStack<T>	profile(SkullProfile profile)	Profiles the given SkullProfile to the AbstractItemStack object.
ItemProvider<T>	provider()	This method is used to return an ItemProvider object.
String	providerItemID()	Retrieves the provider item ID associated with the current object.
default Optional<ProvidesBannerPatternsComponent<AbstractItemStack<T>,T>>	providesPattern()	Retrieves the component that provides banner patterns.
AbstractItemStack<T>	providesPattern(String patternTag)	Retrieve an AbstractItemStack object that provides a specific pattern identified by the patternTag.
default Optional<ProvidesTrimMaterialComponent<AbstractItemStack<T>,T>>	providesTrim()	Retrieves the component responsible for providing trim materials.
AbstractItemStack<T>	providesTrim(String material)	Applies the specified trim material
default Optional<RarityComponent<AbstractItemStack<T>,T>>	rarity()	Retrieves the RarityComponent of the item stack if present.
AbstractItemStack<T>	rarity(String rarity)	Updates the rarity of the item stack.
default Optional<RecipesComponent<AbstractItemStack<T>,T>>	recipes()	Retrieves the RecipesComponent of the item stack if present.
AbstractItemStack<T>	recipes(List<String> recipes)	Updates the recipes of the item stack.
default Optional<RepairableComponent<AbstractItemStack<T>,T>>	repairable()	Retrieves the RepairableComponent of the item stack if present.
AbstractItemStack<T>	repairable(List<String> repairItems)	Updates the repairable items of the item stack.
default Optional<RepairCostComponent<AbstractItemStack<T>,T>>	repairCost()	Retrieves the RepairCostComponent of the item stack if present.
AbstractItemStack<T>	repairCost(int repairCost)	Updates the repair cost of the item stack.
void	resetDirty()	Resets the dirty flag, indicating that the object's state has been synchronized with the database.
AbstractItemStack<T>	setItemProvider(String itemProvider)	Sets the item provider to be used for retrieving items.
AbstractItemStack<T>	setProviderItemID(String providerItemID)	Sets the provider's item ID for the current item.
int	slot()	Represents the inventory slot of the item stack.
AbstractItemStack<T>	slot(int slot)	Sets the inventory slot of the item stack.
default Optional<StoredEnchantmentsComponent<AbstractItemStack<T>,T>>	storedEnchantments()	Retrieves the StoredEnchantmentsComponent of the item stack if present.
AbstractItemStack<T>	storedEnchantments(Map<String,Integer> enchantments)	Updates the stored enchantments of the item stack.
default AbstractItemStack<T>	subtract(int amount)	Subtracts the specified amount from the current item stack.
default Optional<SuspiciousStewEffectsComponent<AbstractItemStack<T>,T>>	suspiciousStewEffects()	Retrieves the SuspiciousStewEffectsComponent of the item stack if present.
AbstractItemStack<T>	suspiciousStewEffects(List<EffectInstance> effects)	Applies the given effects to the suspicious stew item.
AbstractItemStack<T>	suspiciousStewEffects(EffectInstance... effects)	Applies the given effects to a suspicious stew item.
org.json.simple.JSONObject	toJSON()	Converts the object to a JSONObject representation.
default Optional<ToolComponent<AbstractItemStack<T>,T>>	tool()	Retrieves the ToolComponent of the item stack if present.
AbstractItemStack<T>	tool(float defaultSpeed, int blockDamage, boolean canDestroyBlocksCreative, List<ToolRule> rules)	Constructs a new tool item with the specified characteristics.
default Optional<TooltipDisplayComponent<AbstractItemStack<T>,T>>	tooltipDisplay()	Retrieves the tooltip display component associated with the item.
AbstractItemStack<T>	tooltipDisplay(boolean hideTooltip, String... hiddenComponents)	Displays tooltip for the item stack with an option to hide certain components.
default Optional<TooltipStyleComponent<AbstractItemStack<T>,T>>	tooltipStyle()	Retrieves the TooltipStyleComponent of the item stack if present.
AbstractItemStack<T>	tooltipStyle(String style)	Updates the tooltip style of the item stack.
default Optional<TrimComponent<AbstractItemStack<T>,T>>	trim()	Retrieves the TrimComponent of the item stack if present.
AbstractItemStack<T>	trim(String pattern, String material, boolean showInTooltip)	Updates the trim properties of the item stack.
default Optional<UnbreakableComponent<AbstractItemStack<T>,T>>	unbreakable()	Retrieves the UnbreakableComponent of the item stack if present.
AbstractItemStack<T>	unbreakable(boolean showInTooltip)	Updates the unbreakable property of the item stack.
default Optional<UseCooldownComponent<AbstractItemStack<T>,T>>	useCooldown()	Retrieves the UseCooldownComponent of the item stack if present.
AbstractItemStack<T>	useCooldown(String cooldownGroup, float seconds)	Updates the use cooldown properties of the item stack.
default Optional<WeaponComponent<AbstractItemStack<T>,T>>	weapon()	Retrieves the weapon component associated with this item.
AbstractItemStack<T>	weapon(int damagePerAttack, boolean canDisableBlocking)	Represents a weapon item that can be used for combat.
default Optional<WritableBookContentComponent<AbstractItemStack<T>,T>>	writableBookContent()	Retrieves the WritableBookContentComponent of the item stack if present.
AbstractItemStack<T>	writableBookContent(List<String> pages)	Updates the writable book content of the item stack.
default Optional<WrittenBookContentComponent<AbstractItemStack<T>,T>>	writtenBookContent()	Retrieves the WrittenBookContentComponent of the item stack if present.
AbstractItemStack<T>	writtenBookContent(String title, String author, int generation, boolean resolved, List<String> pages)	Updates the written book content of the item stack.

Method Details

of

AbstractItemStack<T> of(String material,
 int amount)

Creates a new item stack with the specified material and amount.

Parameters:

material - The material of the item.

amount - The number of items in the stack.

Returns:

A new item stack instance.

Since:

0.2.0.0

of

AbstractItemStack<T> of(T locale)

Creates a new item stack from a locale-specific object.

Parameters:

locale - The locale-specific representation.

Returns:

A new item stack instance.

Since:

0.2.0.0

of

AbstractItemStack<T> of(org.json.simple.JSONObject json)
                 throws org.json.simple.parser.ParseException

Creates a new item stack from a JSON representation.

Parameters:

json - The JSON object containing item stack data.

Returns:

A new item stack instance.

Throws:

org.json.simple.parser.ParseException - If the JSON structure is invalid.

Since:

0.2.0.0

flags

AbstractItemStack<T> flags(List<String> flags)

Sets the item flags.

Parameters:

flags - A list of flags to apply to the item.

Returns:

The updated item stack instance.

Since:

0.2.0.0

loreComponent

AbstractItemStack<T> loreComponent(List<net.kyori.adventure.text.Component> lore)

Sets the lore (descriptive text) of the item stack.

Parameters:

lore - A list of components representing the lore.

Returns:

The updated item stack instance.

Since:

0.2.0.0

enchant

AbstractItemStack<T> enchant(String enchantment,
 int level)

Adds an enchantment to the item stack.

Parameters:

enchantment - The enchantment name.

level - The level of the enchantment.

Returns:

The updated item stack instance.

Since:

0.2.0.0

enchant

AbstractItemStack<T> enchant(Map<String,Integer> enchantments)

Adds multiple enchantments to the item stack.

Parameters:

enchantments - A map of enchantment names and levels.

Returns:

The updated item stack instance.

Since:

0.2.0.0

enchant

AbstractItemStack<T> enchant(List<String> enchantments)

Adds enchantments to the item stack by name.

Parameters:

enchantments - A list of enchantment names.

Returns:

The updated item stack instance.

Since:

0.2.0.0

material

String material()

Returns the material of the item stack.

Returns:

The material of the item stack.

Since:

0.2.0.0

material

AbstractItemStack<T> material(String material)

Sets the material of the item stack.

Parameters:

material - The material name.

Returns:

The updated item stack instance.

Since:

0.2.0.0

amount

int amount()

The quantity of the item stack.

Returns:

the quantity of the item stack.

Since:

0.2.0.0

amount

AbstractItemStack<T> amount(int amount)

Sets the quantity of the item stack.

Parameters:

amount - The number of items in the stack.

Returns:

The updated item stack instance.

Since:

0.2.0.0

subtract

default AbstractItemStack<T> subtract(int amount)

Subtracts the specified amount from the current item stack.

Parameters:

amount - the amount to subtract from the item stack

Returns:

a new item stack with the specified amount subtracted

Since:

0.2.0.0

add

default AbstractItemStack<T> add(int amount)

Adds the specified amount to the current amount of this item stack.

Parameters:

amount - the amount to be added to the item stack

Returns:

a new AbstractItemStack with the updated amount

Since:

0.2.0.0

slot

int slot()

Represents the inventory slot of the item stack.

Returns:

the inventory slot of the item stack.

Since:

0.2.0.0

slot

AbstractItemStack<T> slot(int slot)

Sets the inventory slot of the item stack.

Parameters:

slot - The slot index.

Returns:

The updated item stack instance.

Since:

0.2.0.0

debug

AbstractItemStack<T> debug(boolean debug)

Enables or disables debug mode for the item stack.

Parameters:

debug - True to enable, false to disable.

Returns:

The updated item stack instance.

Since:

0.2.0.0

hasComponent

default boolean hasComponent(String identifier)

Checks if a component with the specified identifier is present.

Parameters:

identifier - The identifier of the component to check.

Returns:

true if a component with the specified identifier is present, false otherwise.

applyComponent

default <C extends SerialComponent<? extends AbstractItemStack<T>,
T>>
AbstractItemStack<T> applyComponent(C component)

Applies a serialized component to the item stack.

Parameters:

component - The component to apply.

Returns:

The updated item stack instance.

Since:

0.2.0.0

component

default <C extends SerialComponent<? extends AbstractItemStack<T>,
T>>
Optional<C> component(String identifier)

Retrieves a SerialComponent associated with the specified identifier.

Parameters:

identifier - the identifier of the SerialComponent to retrieve

Returns:

an Optional containing the SerialComponent if found, empty Optional otherwise

Since:

0.2.0.0

applyPersistent

default AbstractItemStack<T> applyPersistent(PersistentDataType<?> data)

Applies persistent data to the item stack.

Parameters:

data - The persistent data to apply.

Returns:

The updated item stack instance.

Since:

0.2.0.0

applyPersistentHolder

AbstractItemStack<T> applyPersistentHolder(PersistentDataHolder newHolder,
 boolean replaceOld)

Replaces the persistent data holder for the item stack.

Parameters:

newHolder - The new persistent data holder.

replaceOld - True to replace existing data, false to merge.

Returns:

The updated item stack instance.

Since:

0.2.0.0

flags

List<String> flags()

Retrieves the item flags.

Returns:

A list of flags applied to the item.

Since:

0.2.0.0

components

<C extends SerialComponent<? extends AbstractItemStack<T>,
T>>
Map<String,C> components()

Retrieves the components applied to the item stack.

Returns:

A map of component types and their serialized representations.

Since:

0.2.0.0

persistentHolder

PersistentDataHolder persistentHolder()

Retrieves the persistent data holder for the item stack.

Returns:

The persistent data holder.

Since:

0.2.0.0

resetDirty

void resetDirty()

Resets the dirty flag, indicating that the object's state has been synchronized with the database.

markDirty

void markDirty()

Marks the item stack as dirty, indicating changes have been made.

isDirty

boolean isDirty()

Checks whether the object is dirty or has unsaved changes.

Returns:

true if the object is dirty, false otherwise

itemProvider

String itemProvider()

This method returns a String representing the item provider.

Returns:

the item provider as a String

See Also:

• ItemProvider

setItemProvider

AbstractItemStack<T> setItemProvider(String itemProvider)

Sets the item provider to be used for retrieving items.

Parameters:

itemProvider - the string representing the item provider to be set

providerItemID

String providerItemID()

Retrieves the provider item ID associated with the current object.

Returns:

The provider item ID of the object.

setProviderItemID

AbstractItemStack<T> setProviderItemID(String providerItemID)

Sets the provider's item ID for the current item.

Parameters:

providerItemID - the unique ID assigned by the provider for the item

provider

ItemProvider<T> provider()

This method is used to return an ItemProvider object.

Returns:

ItemProvider object representing the item provider.

toJSON

org.json.simple.JSONObject toJSON()

Converts the object to a JSONObject representation.

Returns:

A JSONObject representing the object data.

Since:

0.2.0.0

attributeModifiers

default Optional<AttributeModifiersComponent<AbstractItemStack<T>,T>> attributeModifiers()

Retrieves the AttributeModifiersComponent of the item stack if present.

Returns:

an Optional containing the AttributeModifiersComponent if it exists

Since:

0.2.0.0

See Also:

• AttributeModifiersComponent

attributeModifiers

AbstractItemStack<T> attributeModifiers(List<AttributeModifier> modifiers,
 boolean showInTooltip)

Updates the attribute modifiers of the item stack.

Parameters:

modifiers - a list of attribute modifiers

showInTooltip - whether to display the modifiers in the tooltip

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• AttributeModifiersComponent

bannerPatterns

default Optional<BannerPatternsComponent<AbstractItemStack<T>,T>> bannerPatterns()

Retrieves the BannerPatternsComponent of the item stack if present.

Returns:

an Optional containing the BannerPatternsComponent if it exists

Since:

0.2.0.0

See Also:

• BannerPatternsComponent

bannerPatterns

AbstractItemStack<T> bannerPatterns(List<PatternData> patterns)

Updates the banner patterns of the item stack.

Parameters:

patterns - a list of pattern data

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• BannerPatternsComponent

baseColor

default Optional<BaseColorComponent<AbstractItemStack<T>,T>> baseColor()

Retrieves the BaseColorComponent of the item stack if present.

Returns:

an Optional containing the BaseColorComponent if it exists

Since:

0.2.0.0

See Also:

• BaseColorComponent

baseColor

AbstractItemStack<T> baseColor(String color)

Updates the base color of the item stack.

Parameters:

color - the new base color

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• BaseColorComponent

blocksAttacks

default Optional<BlocksAttacksComponent<AbstractItemStack<T>,T>> blocksAttacks()

Retrieves the BlocksAttacksComponent associated with this method.

Returns:

an Optional containing the BlocksAttacksComponent if found, otherwise an empty Optional

Since:

0.2.0.0

See Also:

• BlocksAttacksComponent

blocksAttacks

AbstractItemStack<T> blocksAttacks(ItemDamage damage)

Blocks attacks with the specified damage type using this item.

Parameters:

damage - the type of damage to block attacks from

Returns:

an AbstractItemStack object representing the item after blocking attacks

Since:

0.2.0.0

See Also:

• BlocksAttacksComponent

breakSound

default Optional<BreakSoundComponent<AbstractItemStack<T>,T>> breakSound()

Retrieves the break sound component associated with the object.

Returns:

an Optional containing the BreakSoundComponent if it exists, else an empty Optional

Since:

0.2.0.0

See Also:

• BreakSoundComponent

breakSound

AbstractItemStack<T> breakSound(String sound)

Set the break sound for this item stack.

Parameters:

sound - the sound to be played when the item is broken

Returns:

the updated item stack object

Since:

0.2.0.0

See Also:

• BreakSoundComponent

bucketEntityData

default Optional<BucketEntityDataComponent<AbstractItemStack<T>,T>> bucketEntityData()

Retrieves the BucketEntityDataComponent of the item stack if present.

Returns:

an Optional containing the BucketEntityDataComponent if it exists

Since:

0.2.0.0

See Also:

• BucketEntityDataComponent

bucketEntityData

AbstractItemStack<T> bucketEntityData(boolean noAI,
 boolean silent,
 boolean noGravity,
 boolean glowing,
 boolean invulnerable,
 float health,
 int age,
 int variant,
 long huntingCooldown,
 int bucketVariantTag,
 String type)

Updates the bucket entity data of the item stack.

Parameters:

noAI - whether the entity has AI disabled

silent - whether the entity is silent

noGravity - whether the entity is affected by gravity

glowing - whether the entity is glowing

invulnerable - whether the entity is invulnerable

health - the health of the entity

age - the age of the entity

variant - the variant of the entity

huntingCooldown - the hunting cooldown of the entity

bucketVariantTag - the variant tag of the bucket

type - the type of the entity

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• BucketEntityDataComponent

bundle

default Optional<BundleComponent<AbstractItemStack<T>,T>> bundle()

Retrieves the bundle component from the components map.

Returns:

An Optional containing the BundleComponent of AbstractItemStack with type T, or an empty Optional if the bundle component does not exist in the components map.

Since:

0.2.0.0

See Also:

• BundleComponent

bundle

AbstractItemStack<T> bundle(Map<Integer,AbstractItemStack<T>> items)

Bundles a collection of AbstractItemStack instances into a single collection.

Parameters:

items - A Map containing integer keys and AbstractItemStack values to be bundled.

Returns:

An AbstractItemStack instance that represents the bundled items.

Since:

0.2.0.0

See Also:

• BundleComponent

canBreak

default Optional<CanBreakComponent<AbstractItemStack<T>,T>> canBreak()

Retrieves the CanBreakComponent of the item stack if present.

Returns:

an Optional containing the CanBreakComponent if it exists

Since:

0.2.0.0

See Also:

• CanBreakComponent

canBreak

AbstractItemStack<T> canBreak(List<BlockPredicate> predicates)

Updates the blocks that the item stack can break.

Parameters:

predicates - a list of block predicates

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• CanBreakComponent

canPlaceOn

default Optional<CanPlaceOnComponent<AbstractItemStack<T>,T>> canPlaceOn()

Retrieves the CanPlaceOnComponent of the item stack if present.

Returns:

an Optional containing the CanPlaceOnComponent if it exists

Since:

0.2.0.0

See Also:

• CanPlaceOnComponent

canPlaceOn

AbstractItemStack<T> canPlaceOn(List<BlockPredicate> predicates)

Updates the blocks that the item stack can be placed on.

Parameters:

predicates - a list of block predicates

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• CanPlaceOnComponent

consumable

default Optional<ConsumableComponent<AbstractItemStack<T>,T>> consumable()

Retrieves the ConsumableComponent of the item stack if present.

Returns:

an Optional containing the ConsumableComponent if it exists

Since:

0.2.0.0

See Also:

• ConsumableComponent

consumable

AbstractItemStack<T> consumable(float consumeSeconds,
 String animation,
 String sound,
 boolean hasConsumeParticles,
 List<ComponentEffect> effects)

Updates the consumable properties of the item stack.

Parameters:

consumeSeconds - the time it takes to consume the item

animation - the animation to display when consuming

sound - the sound to play when consuming

hasConsumeParticles - whether to show consume particles

effects - a list of effects applied on consumption

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• ConsumableComponent

container

default Optional<ContainerComponent<AbstractItemStack<T>,T>> container()

Returns an Optional containing the ContainerComponent with type parameters AbstractItemStack and T stored in this container.

Returns:

an Optional object containing the ContainerComponent with type parameters AbstractItemStack and T, or an empty Optional if the component is not found

Since:

0.2.0.0

See Also:

• ContainerComponent

container

AbstractItemStack<T> container(Map<Integer,AbstractItemStack<T>> items)

Constructs a container with the given map of items.

Parameters:

items - a map of items where the key is the position of the item in the container and the value is the item

Returns:

an AbstractItemStack container with the specified items

Since:

0.2.0.0

See Also:

• ContainerComponent

customName

default Optional<CustomNameComponent<AbstractItemStack<T>,T>> customName()

Retrieves the CustomNameComponent of the item stack if present.

Returns:

an Optional containing the CustomNameComponent if it exists

Since:

0.2.0.0

See Also:

• CustomNameComponent

customName

AbstractItemStack<T> customName(net.kyori.adventure.text.Component customName)

Updates the custom name of the item stack.

Parameters:

customName - the custom name to set

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• CustomNameComponent

damage

default Optional<DamageComponent<AbstractItemStack<T>,T>> damage()

Retrieves the DamageComponent of the item stack if present.

Returns:

an Optional containing the DamageComponent if it exists

Since:

0.2.0.0

See Also:

• DamageComponent

damage

AbstractItemStack<T> damage(int damage)

Updates the damage of the item stack.

Parameters:

damage - the damage value to set

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• DamageComponent

damageResistant

default Optional<DamageResistantComponent<AbstractItemStack<T>,T>> damageResistant()

Retrieves the DamageResistantComponent of the item stack if present.

Returns:

an Optional containing the DamageResistantComponent if it exists

Since:

0.2.0.0

See Also:

• DamageResistantComponent

damageResistant

AbstractItemStack<T> damageResistant(List<String> types)

Updates the damage-resistant types of the item stack.

Parameters:

types - a list of damage-resistant types

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• DamageResistantComponent

deathProtection

default Optional<DeathProtectionComponent<AbstractItemStack<T>,T>> deathProtection()

Retrieves the DeathProtectionComponent of the item stack if present.

Returns:

an Optional containing the DeathProtectionComponent if it exists

Since:

0.2.0.0

See Also:

• DeathProtectionComponent

deathProtection

AbstractItemStack<T> deathProtection(List<ComponentEffect> deathEffects)

Updates the death protection effects of the item stack.

Parameters:

deathEffects - a list of death protection effects

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• DeathProtectionComponent

dyedColor

default Optional<DyedColorComponent<AbstractItemStack<T>,T>> dyedColor()

Retrieves the DyedColorComponent of the item stack if present.

Returns:

an Optional containing the DyedColorComponent if it exists

Since:

0.2.0.0

See Also:

• DyedColorComponent

dyedColor

AbstractItemStack<T> dyedColor(int rgb)

Updates the dyed color of the item stack.

Parameters:

rgb - the RGB color value to set

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• DyedColorComponent

enchantable

default Optional<EnchantableComponent<AbstractItemStack<T>,T>> enchantable()

Retrieves the EnchantableComponent of the item stack if present.

Returns:

an Optional containing the EnchantableComponent if it exists

Since:

0.2.0.0

See Also:

• EnchantableComponent

enchantable

AbstractItemStack<T> enchantable(int value)

Updates the enchantability of the item stack.

Parameters:

value - the enchantability value to set

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• EnchantableComponent

enchantmentGlintOverride

default Optional<EnchantmentGlintOverrideComponent<AbstractItemStack<T>,T>> enchantmentGlintOverride()

Retrieves the EnchantmentGlintOverrideComponent of the item stack if present.

Returns:

an Optional containing the EnchantmentGlintOverrideComponent if it exists

Since:

0.2.0.0

See Also:

• EnchantmentGlintOverrideComponent

enchantmentGlintOverride

AbstractItemStack<T> enchantmentGlintOverride(boolean glintOverride)

Updates the enchantment glint override of the item stack.

Parameters:

glintOverride - whether the enchantment glint should be overridden

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• EnchantmentGlintOverrideComponent

enchantments

default Optional<EnchantmentsComponent<AbstractItemStack<T>,T>> enchantments()

Retrieves the EnchantmentsComponent of the item stack if present.

Returns:

an Optional containing the EnchantmentsComponent if it exists

Since:

0.2.0.0

See Also:

• EnchantmentsComponent

enchantments

AbstractItemStack<T> enchantments(Map<String,Integer> levels)

Updates the enchantments of the item stack.

Parameters:

levels - a map of enchantments and their levels

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• EnchantmentsComponent

entityVariant

default Optional<EntityVariantComponent<AbstractItemStack<T>,T>> entityVariant()

Retrieves the Entity Variant Component for the current stack.

Returns:

An optional containing the Entity Variant Component if present in the components map, otherwise empty.

Since:

0.2.0.0

See Also:

• EntityVariantComponent

entityVariant

AbstractItemStack<T> entityVariant(String entity,
 String variant)

Generates an AbstractItemStack based on the given entity and variant.

Parameters:

entity - the entity name to create the stack for

variant - the variant of the entity

Returns:

an AbstractItemStack representing the entity with the specified variant

Since:

0.2.0.0

See Also:

• EntityVariantComponent

equip

default Optional<EquipComponent<AbstractItemStack<T>,T>> equip()

Retrieves the EquipComponent of the item stack if present.

Returns:

an Optional containing the EquipComponent if it exists

Since:

0.2.0.0

See Also:

• EquipComponent

equip

AbstractItemStack<T> equip(String cameraKey,
 String equipSound,
 String modelKey,
 EquipSlot slot,
 boolean damageOnHurt,
 boolean dispensable,
 boolean swappable,
 boolean equipOnInteract,
 List<String> entities)

Equips an item with specified parameters.

Parameters:

cameraKey - the key identifying the camera

equipSound - the key identifying the equip sound

modelKey - the key identifying the model

slot - the slot in which the item should be equipped

damageOnHurt - flag indicating if damage should be taken on hurt

dispensable - flag indicating if the item is dispensable

swappable - flag indicating if the item is swappable

equipOnInteract - flag indicating if the item should be equipped on interact

entities - a list of entities to be equipped

Returns:

an AbstractItemStack object representing the equipped item

Since:

0.2.0.0

See Also:

• EquipComponent

fireworkExplosion

default Optional<FireworkExplosionComponent<AbstractItemStack<T>,T>> fireworkExplosion()

Retrieves the FireworkExplosionComponent of the item stack if present.

Returns:

an Optional containing the FireworkExplosionComponent if it exists

Since:

0.2.0.0

See Also:

• FireworkExplosionComponent

fireworkExplosion

AbstractItemStack<T> fireworkExplosion(ExplosionData explosion)

Updates the firework explosion properties of the item stack.

Parameters:

explosion - the explosion data to set

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• FireworkExplosionComponent

fireworks

default Optional<FireworksComponent<AbstractItemStack<T>,T>> fireworks()

Retrieves the FireworksComponent of the item stack if present.

Returns:

an Optional containing the FireworksComponent if it exists

Since:

0.2.0.0

See Also:

• FireworksComponent

fireworks

AbstractItemStack<T> fireworks(byte flightDuration,
 List<ExplosionData> explosions)

Updates the fireworks properties of the item stack.

Parameters:

flightDuration - the flight duration of the fireworks

explosions - a list of explosion data

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• FireworksComponent

food

default Optional<FoodComponent<AbstractItemStack<T>,T>> food()

Retrieves the FoodComponent of the item stack if present.

Returns:

an Optional containing the FoodComponent if it exists

Since:

0.2.0.0

See Also:

• FoodComponent

food

AbstractItemStack<T> food(boolean noHunger,
 float saturation,
 int nutrition)

Updates the food properties of the item stack.

Parameters:

noHunger - whether the item causes no hunger

saturation - the saturation value

nutrition - the nutrition value

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• FoodComponent

glider

default Optional<GliderComponent<AbstractItemStack<T>,T>> glider()

Retrieves the GliderComponent of the item stack if present.

Returns:

an Optional containing the GliderComponent if it exists

Since:

0.2.0.0

See Also:

• GliderComponent

gliderTag

AbstractItemStack<T> gliderTag()

Updates the item stack to enable glider functionality.

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• GliderComponent

hideAdditionalTooltip

default Optional<HideAdditionalTooltipComponent<AbstractItemStack<T>,T>> hideAdditionalTooltip()

Retrieves the HideAdditionalTooltipComponent of the item stack if present.

Returns:

an Optional containing the HideAdditionalTooltipComponent if it exists

Since:

0.2.0.0

See Also:

• HideAdditionalTooltipComponent

hideAdditionalTooltipTag

AbstractItemStack<T> hideAdditionalTooltipTag()

Updates the item stack to hide additional tooltip.

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• HideAdditionalTooltipComponent

hideTooltip

default Optional<HideTooltipComponent<AbstractItemStack<T>,T>> hideTooltip()

Retrieves the HideTooltipComponent of the item stack if present.

Returns:

an Optional containing the HideTooltipComponent if it exists

Since:

0.2.0.0

See Also:

• HideTooltipComponent

hideTooltipTag

AbstractItemStack<T> hideTooltipTag()

Updates the item stack to hide its tooltip.

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• HideTooltipComponent

instrument

default Optional<InstrumentComponent<AbstractItemStack<T>,T>> instrument()

Retrieves the InstrumentComponent of the item stack if present.

Returns:

an Optional containing the InstrumentComponent if it exists

Since:

0.2.0.0

See Also:

• InstrumentComponent

instrument

AbstractItemStack<T> instrument(String soundEvent,
 int useDuration,
 int range)

Updates the instrument properties of the item stack.

Parameters:

soundEvent - the sound event identifier

useDuration - the duration of the sound in ticks

range - the range of the sound

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• InstrumentComponent

intangibleProjectile

default Optional<IntangibleProjectileComponent<AbstractItemStack<T>,T>> intangibleProjectile()

Retrieves the IntangibleProjectileComponent of the item stack if present.

Returns:

an Optional containing the IntangibleProjectileComponent if it exists

Since:

0.2.0.0

See Also:

• IntangibleProjectileComponent

intangibleProjectileTag

AbstractItemStack<T> intangibleProjectileTag()

Updates the item stack as an intangible projectile.

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• IntangibleProjectileComponent

itemModel

default Optional<ItemModelComponent<AbstractItemStack<T>,T>> itemModel()

Retrieves the ItemModelComponent of the item stack if present.

Returns:

an Optional containing the ItemModelComponent if it exists

Since:

0.2.0.0

See Also:

• ItemModelComponent

itemModel

AbstractItemStack<T> itemModel(String model)

Updates the model properties of the item stack.

Parameters:

model - the model identifier

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• ItemModelComponent

itemName

default Optional<ItemNameComponent<AbstractItemStack<T>,T>> itemName()

Retrieves the ItemNameComponent of the item stack if present.

Returns:

an Optional containing the ItemNameComponent if it exists

Since:

0.2.0.0

See Also:

• ItemNameComponent

itemName

AbstractItemStack<T> itemName(net.kyori.adventure.text.Component itemName)

Updates the name of the item stack.

Parameters:

itemName - the name of the item

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• ItemNameComponent

jukebox

default Optional<JukeBoxComponent<AbstractItemStack<T>,T>> jukebox()

Retrieves the JukeBoxComponent of the item stack if present.

Returns:

an Optional containing the JukeBoxComponent if it exists

Since:

0.2.0.0

See Also:

• JukeBoxComponent

jukebox

AbstractItemStack<T> jukebox(String song,
 boolean showInTooltip)

Updates the jukebox properties of the item stack.

Parameters:

song - the song identifier

showInTooltip - whether to display the song in the tooltip

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• JukeBoxComponent

lodestoneTracker

default Optional<LodestoneTrackerComponent<AbstractItemStack<T>,T>> lodestoneTracker()

Retrieves the LodestoneTrackerComponent of the item stack if present.

Returns:

an Optional containing the LodestoneTrackerComponent if it exists

Since:

0.2.0.0

See Also:

• LodestoneTrackerComponent

lodestoneTracker

AbstractItemStack<T> lodestoneTracker(String target,
 int[] pos,
 String dimension,
 boolean tracked)

Updates the lodestone tracker properties of the item stack.

Parameters:

target - the target identifier

pos - the position array

dimension - the dimension identifier

tracked - whether the lodestone is tracked

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• LodestoneTrackerComponent

lore

default Optional<LoreComponent<AbstractItemStack<T>,T>> lore()

Retrieves the LoreComponent of the item stack if present.

Returns:

an Optional containing the LoreComponent if it exists

Since:

0.2.0.0

See Also:

• LoreComponent

lore

AbstractItemStack<T> lore(List<net.kyori.adventure.text.Component> lore)

Updates the lore of the item stack.

Parameters:

lore - a list of lore strings

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• LoreComponent

mapColor

default Optional<MapColorComponent<AbstractItemStack<T>,T>> mapColor()

Retrieves the MapColorComponent of the item stack if present.

Returns:

an Optional containing the MapColorComponent if it exists

Since:

0.2.0.0

See Also:

• MapColorComponent

mapColor

AbstractItemStack<T> mapColor(int mapColor)

Updates the map color of the item stack.

Parameters:

mapColor - the map color value

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• MapColorComponent

mapId

default Optional<MapIDComponent<AbstractItemStack<T>,T>> mapId()

Retrieves the MapIDComponent of the item stack if present.

Returns:

an Optional containing the MapIDComponent if it exists

Since:

0.2.0.0

See Also:

• MapIDComponent

mapId

AbstractItemStack<T> mapId(int mapId)

Updates the map ID of the item stack.

Parameters:

mapId - the map ID value

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• MapIDComponent

maxDamage

default Optional<MaxDamageComponent<AbstractItemStack<T>,T>> maxDamage()

Retrieves the MaxDamageComponent of the item stack if present.

Returns:

an Optional containing the MaxDamageComponent if it exists

Since:

0.2.0.0

See Also:

• MaxDamageComponent

maxDamage

AbstractItemStack<T> maxDamage(int maxDamage)

Updates the maximum damage of the item stack.

Parameters:

maxDamage - the maximum damage value

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• MaxDamageComponent

maxStackSize

default Optional<MaxStackSizeComponent<AbstractItemStack<T>,T>> maxStackSize()

Retrieves the MaxStackSizeComponent of the item stack if present.

Returns:

an Optional containing the MaxStackSizeComponent if it exists

Since:

0.2.0.0

See Also:

• MaxStackSizeComponent

maxStackSize

AbstractItemStack<T> maxStackSize(int maxStackSize)

Updates the maximum stack size of the item stack.

Parameters:

maxStackSize - the maximum stack size value

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• MaxStackSizeComponent

modelData

default Optional<ModelDataComponent<AbstractItemStack<T>,T>> modelData()

Retrieves the ModelDataComponent of the item stack if present.

Returns:

an Optional containing the ModelDataComponent if it exists

Since:

0.2.0.0

See Also:

• ModelDataComponent

modelData

AbstractItemStack<T> modelData(List<String> colours,
 List<Float> floats,
 List<Boolean> flags,
 List<String> strings)

Updates the model data of the item stack.

Parameters:

colours - a list of color strings

floats - a list of float values

flags - a list of boolean flags

strings - a list of string identifiers

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• ModelDataComponent

modelDataOld

default Optional<ModelDataOldComponent<AbstractItemStack<T>,T>> modelDataOld()

Deprecated.

Since MC 1.21.3 Use ItemModelComponent and ModelDataComponent.

Retrieves the ModelDataOldComponent of the item stack if present.

Returns:

an Optional containing the ModelDataOldComponent if it exists

Since:

0.2.0.0

See Also:

• ModelDataComponent

modelDataOld

AbstractItemStack<T> modelDataOld(int customModelData)

Deprecated.

Since MC 1.21.3 Use ItemModelComponent and ModelDataComponent.

Retrieves the model data for a custom item stack.

Parameters:

customModelData - the custom model data to retrieve

Returns:

an AbstractItemStack with the specified custom model data

Since:

0.2.0.0

See Also:

• ModelDataOldComponent

noteBlockSound

default Optional<NoteBlockSoundComponent<AbstractItemStack<T>,T>> noteBlockSound()

Retrieves the NoteBlockSoundComponent of the item stack if present.

Returns:

an Optional containing the NoteBlockSoundComponent if it exists

Since:

0.2.0.0

See Also:

• NoteBlockSoundComponent

noteBlockSound

AbstractItemStack<T> noteBlockSound(String soundId)

Updates the note block sound of the item stack.

Parameters:

soundId - the identifier of the sound

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• NoteBlockSoundComponent

ominousBottleAmplifier

default Optional<OminousBottleAmplifierComponent<AbstractItemStack<T>,T>> ominousBottleAmplifier()

Retrieves the OminousBottleAmplifierComponent of the item stack if present.

Returns:

an Optional containing the OminousBottleAmplifierComponent if it exists

Since:

0.2.0.0

See Also:

• OminousBottleAmplifierComponent

ominousBottleAmplifier

AbstractItemStack<T> ominousBottleAmplifier(int amplifier)

Updates the ominous bottle amplifier of the item stack.

Parameters:

amplifier - the amplifier value

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• OminousBottleAmplifierComponent

potDecorations

default Optional<PotDecorationsComponent<AbstractItemStack<T>,T>> potDecorations()

Retrieves the PotDecorationsComponent of the item stack if present.

Returns:

an Optional containing the PotDecorationsComponent if it exists

Since:

0.2.0.0

See Also:

• PotDecorationsComponent

potDecorations

AbstractItemStack<T> potDecorations(List<String> decorations)

Updates the pot decorations of the item stack.

Parameters:

decorations - a list of decorations

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• PotDecorationsComponent

potionContents

default Optional<PotionContentsComponent<AbstractItemStack<T>,T>> potionContents()

Retrieves the PotionContentsComponent of the item stack if present.

Returns:

an Optional containing the PotionContentsComponent if it exists

Since:

0.2.0.0

See Also:

• PotionContentsComponent

potionContents

AbstractItemStack<T> potionContents(String potionId,
 int customColor,
 String customName,
 List<EffectInstance> effects)

Updates the potion contents of the item stack.

Parameters:

potionId - the ID of the potion

customColor - the custom color of the potion

customName - the custom name of the potion

effects - a list of effect instances

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• PotionContentsComponent

potionDuration

default Optional<PotionDurationScaleComponent<AbstractItemStack<T>,T>> potionDuration()

Retrieves the potion duration scale component from the item's components. Since MC Snapshot 25w02a.

Returns:

an Optional containing the PotionDurationScaleComponent if present, otherwise an empty Optional

Since:

0.2.0.0

See Also:

• PotionDurationScaleComponent

potionDuration

AbstractItemStack<T> potionDuration(float potionDuration)

Sets the duration of a potion effect for the item stack. Since MC Snapshot 25w02a.

Parameters:

potionDuration - the duration of the potion effect in seconds

Returns:

the modified AbstractItemStack object with the updated potion duration

Since:

0.2.0.0

See Also:

• PotionDurationScaleComponent

profile

default Optional<ProfileComponent<AbstractItemStack<T>,T>> profile()

Retrieves the profile component from the components map if it exists.

Returns:

An Optional containing the profile component if found, or an empty Optional otherwise.

Since:

0.2.0.0

See Also:

• ProfileComponent

profile

default AbstractItemStack<T> profile(String name,
 UUID uuid)

Create a Profile based on the provided name and UUID.

Parameters:

name - The name for the profile.

uuid - The UUID for the profile.

Returns:

A new AbstractItemStack based on the created SkullProfile with the given name and UUID.

Since:

0.2.0.0

See Also:

• ProfileComponent

profile

default AbstractItemStack<T> profile(String name,
 UUID uuid,
 String texture)

Profiles the item stack with the given name, UUID, and texture.

Parameters:

name - The name of the profile.

uuid - The UUID of the profile.

texture - The texture of the profile.

Returns:

The AbstractItemStack with the specified profile.

Since:

0.2.0.0

See Also:

• ProfileComponent

profile

AbstractItemStack<T> profile(SkullProfile profile)

Profiles the given SkullProfile to the AbstractItemStack object.

Parameters:

profile - the SkullProfile to be assigned

Returns:

an AbstractItemStack object with the provided profile

providesPattern

default Optional<ProvidesBannerPatternsComponent<AbstractItemStack<T>,T>> providesPattern()

Retrieves the component that provides banner patterns.

Returns:

an Optional containing the ProvidesBannerPatternsComponent for the specified item stack type T, or an empty Optional if the component is not present

Since:

0.2.0.0

See Also:

• ProvidesBannerPatternsComponent

providesPattern

AbstractItemStack<T> providesPattern(String patternTag)

Retrieve an AbstractItemStack object that provides a specific pattern identified by the patternTag.

Parameters:

patternTag - The unique identifier of the pattern to be provided.

Returns:

An AbstractItemStack object that provides the specified pattern.

Since:

0.2.0.0

See Also:

• ProvidesBannerPatternsComponent

providesTrim

default Optional<ProvidesTrimMaterialComponent<AbstractItemStack<T>,T>> providesTrim()

Retrieves the component responsible for providing trim materials.

Returns:

An Optional containing the ProvidesTrimMaterialComponent for trim, or an empty Optional if not found.

Since:

0.2.0.0

See Also:

• ProvidesTrimMaterialComponent

providesTrim

AbstractItemStack<T> providesTrim(String material)

Applies the specified trim material

Parameters:

material - the trim material

Returns:

an AbstractItemStack object representing the trimmed material

Since:

0.2.0.0

See Also:

• ProvidesTrimMaterialComponent

rarity

default Optional<RarityComponent<AbstractItemStack<T>,T>> rarity()

Retrieves the RarityComponent of the item stack if present.

Returns:

an Optional containing the RarityComponent if it exists

Since:

0.2.0.0

See Also:

• RarityComponent

rarity

AbstractItemStack<T> rarity(String rarity)

Updates the rarity of the item stack.

Parameters:

rarity - the rarity value

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• RarityComponent

recipes

default Optional<RecipesComponent<AbstractItemStack<T>,T>> recipes()

Retrieves the RecipesComponent of the item stack if present.

Returns:

an Optional containing the RecipesComponent if it exists

Since:

0.2.0.0

See Also:

• RecipesComponent

recipes

AbstractItemStack<T> recipes(List<String> recipes)

Updates the recipes of the item stack.

Parameters:

recipes - a list of recipe identifiers

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• RecipesComponent

repairable

default Optional<RepairableComponent<AbstractItemStack<T>,T>> repairable()

Retrieves the RepairableComponent of the item stack if present.

Returns:

an Optional containing the RepairableComponent if it exists

Since:

0.2.0.0

See Also:

• RepairableComponent

repairable

AbstractItemStack<T> repairable(List<String> repairItems)

Updates the repairable items of the item stack.

Parameters:

repairItems - a list of repair item identifiers

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• RepairableComponent

repairCost

default Optional<RepairCostComponent<AbstractItemStack<T>,T>> repairCost()

Retrieves the RepairCostComponent of the item stack if present.

Returns:

an Optional containing the RepairCostComponent if it exists

Since:

0.2.0.0

See Also:

• RepairCostComponent

repairCost

AbstractItemStack<T> repairCost(int repairCost)

Updates the repair cost of the item stack.

Parameters:

repairCost - the repair cost value

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• RepairCostComponent

storedEnchantments

default Optional<StoredEnchantmentsComponent<AbstractItemStack<T>,T>> storedEnchantments()

Retrieves the StoredEnchantmentsComponent of the item stack if present.

Returns:

an Optional containing the StoredEnchantmentsComponent if it exists

Since:

0.2.0.0

See Also:

• StoredEnchantmentsComponent

storedEnchantments

AbstractItemStack<T> storedEnchantments(Map<String,Integer> enchantments)

Updates the stored enchantments of the item stack.

Parameters:

enchantments - a map of enchantment names to their levels

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• StoredEnchantmentsComponent

suspiciousStewEffects

default Optional<SuspiciousStewEffectsComponent<AbstractItemStack<T>,T>> suspiciousStewEffects()

Retrieves the SuspiciousStewEffectsComponent of the item stack if present.

Returns:

an Optional containing the SuspiciousStewEffectsComponent if it exists

Since:

0.2.0.0

See Also:

• SuspiciousStewEffectsComponent

suspiciousStewEffects

AbstractItemStack<T> suspiciousStewEffects(List<EffectInstance> effects)

Applies the given effects to the suspicious stew item.

Parameters:

effects - a list of EffectInstance objects representing the effects to be applied to the suspicious stew

Returns:

an AbstractItemStack representing the suspicious stew with the applied effects

Since:

0.2.0.0

See Also:

• SuspiciousStewEffectsComponent

suspiciousStewEffects

AbstractItemStack<T> suspiciousStewEffects(EffectInstance... effects)

Applies the given effects to a suspicious stew item.

Parameters:

effects - an array of EffectInstance objects representing the effects to apply to the suspicious stew

Returns:

an AbstractItemStack representing the suspicious stew item with the applied effects

Since:

0.2.0.0

See Also:

• SuspiciousStewEffectsComponent

tool

default Optional<ToolComponent<AbstractItemStack<T>,T>> tool()

Retrieves the ToolComponent of the item stack if present.

Returns:

an Optional containing the ToolComponent if it exists

Since:

0.2.0.0

See Also:

• ToolComponent

tool

AbstractItemStack<T> tool(float defaultSpeed,
 int blockDamage,
 boolean canDestroyBlocksCreative,
 List<ToolRule> rules)

Constructs a new tool item with the specified characteristics.

Parameters:

defaultSpeed - the default speed of the tool

blockDamage - the damage inflicted by the tool to blocks

canDestroyBlocksCreative - if the tool can destroy blocks in creative mode

rules - a list of rules that define the behavior of the tool

Returns:

an AbstractItemStack instance representing the created tool

Since:

0.2.0.0

See Also:

• ToolComponent

tooltipDisplay

default Optional<TooltipDisplayComponent<AbstractItemStack<T>,T>> tooltipDisplay()

Retrieves the tooltip display component associated with the item.

Returns:

An Optional containing the tooltip display component, or empty if none is found.

Since:

0.2.0.0

See Also:

• TooltipDisplayComponent

tooltipDisplay

AbstractItemStack<T> tooltipDisplay(boolean hideTooltip,
 String... hiddenComponents)

Displays tooltip for the item stack with an option to hide certain components.

Parameters:

hideTooltip - Flag to hide the tooltip

hiddenComponents - Array of components to hide in the tooltip

Returns:

An AbstractItemStack object with the tooltip displayed

Since:

0.2.0.0

See Also:

• TooltipDisplayComponent

tooltipStyle

default Optional<TooltipStyleComponent<AbstractItemStack<T>,T>> tooltipStyle()

Retrieves the TooltipStyleComponent of the item stack if present.

Returns:

an Optional containing the TooltipStyleComponent if it exists

Since:

0.2.0.0

See Also:

• TooltipStyleComponent

tooltipStyle

AbstractItemStack<T> tooltipStyle(String style)

Updates the tooltip style of the item stack.

Parameters:

style - the style to apply to the tooltip

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• TooltipStyleComponent

trim

default Optional<TrimComponent<AbstractItemStack<T>,T>> trim()

Retrieves the TrimComponent of the item stack if present.

Returns:

an Optional containing the TrimComponent if it exists

Since:

0.2.0.0

See Also:

• TrimComponent

trim

AbstractItemStack<T> trim(String pattern,
 String material,
 boolean showInTooltip)

Updates the trim properties of the item stack.

Parameters:

pattern - the trim pattern

material - the trim material

showInTooltip - whether to display the trim in the tooltip

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• TrimComponent

unbreakable

default Optional<UnbreakableComponent<AbstractItemStack<T>,T>> unbreakable()

Retrieves the UnbreakableComponent of the item stack if present.

Returns:

an Optional containing the UnbreakableComponent if it exists

Since:

0.2.0.0

See Also:

• UnbreakableComponent

unbreakable

AbstractItemStack<T> unbreakable(boolean showInTooltip)

Updates the unbreakable property of the item stack.

Parameters:

showInTooltip - whether to display the unbreakable property in the tooltip

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• UnbreakableComponent

useCooldown

default Optional<UseCooldownComponent<AbstractItemStack<T>,T>> useCooldown()

Retrieves the UseCooldownComponent of the item stack if present.

Returns:

an Optional containing the UseCooldownComponent if it exists

Since:

0.2.0.0

See Also:

• UseCooldownComponent

useCooldown

AbstractItemStack<T> useCooldown(String cooldownGroup,
 float seconds)

Updates the use cooldown properties of the item stack.

Parameters:

cooldownGroup - the cooldown group identifier

seconds - the cooldown duration in seconds

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• UseCooldownComponent

weapon

default Optional<WeaponComponent<AbstractItemStack<T>,T>> weapon()

Retrieves the weapon component associated with this item. Since MC Snapshot 25w02a.

Returns:

an Optional containing the weapon component if it exists, otherwise an empty Optional.

Since:

0.2.0.0

See Also:

• WeaponComponent

weapon

AbstractItemStack<T> weapon(int damagePerAttack,
 boolean canDisableBlocking)

Represents a weapon item that can be used for combat. Since MC Snapshot 25w02a.

Parameters:

damagePerAttack - The amount of damage this weapon inflicts per attack

canDisableBlocking - Whether this weapon can disable blocking when used

Since:

0.2.0.0

See Also:

• WeaponComponent

writableBookContent

default Optional<WritableBookContentComponent<AbstractItemStack<T>,T>> writableBookContent()

Retrieves the WritableBookContentComponent of the item stack if present.

Returns:

an Optional containing the WritableBookContentComponent if it exists

Since:

0.2.0.0

See Also:

• WritableBookContentComponent

writableBookContent

AbstractItemStack<T> writableBookContent(List<String> pages)

Updates the writable book content of the item stack.

Parameters:

pages - the pages to include in the writable book

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• WritableBookContentComponent

writtenBookContent

default Optional<WrittenBookContentComponent<AbstractItemStack<T>,T>> writtenBookContent()

Retrieves the WrittenBookContentComponent of the item stack if present.

Returns:

an Optional containing the WrittenBookContentComponent if it exists

Since:

0.2.0.0

See Also:

• WrittenBookContentComponent

writtenBookContent

AbstractItemStack<T> writtenBookContent(String title,
 String author,
 int generation,
 boolean resolved,
 List<String> pages)

Updates the written book content of the item stack.

Parameters:

title - the title of the book

author - the author of the book

generation - the generation of the book

resolved - whether the book is resolved

pages - the pages to include in the book

Returns:

the updated AbstractItemStack instance

Since:

0.2.0.0

See Also:

• WrittenBookContentComponent