Interface BlockStateMeta

All Superinterfaces:

Cloneable, ConfigurationSerializable, ItemMeta, PersistentDataHolder

public interface BlockStateMeta
extends ItemMeta

Method Summary

Modifier and Type	Method	Description
BlockState	getBlockState()	Returns the currently attached block state for this item or creates a new one if one doesn't exist.
boolean	hasBlockState()	Returns whether the item has a block state currently attached to it.
void	setBlockState(BlockState blockState)	Attaches a copy of the passed block state to the item.

Methods inherited from interface ConfigurationSerializable

serialize

Methods inherited from interface ItemMeta

addAttributeModifier, addEnchant, addItemFlags, clone, getAdditionalTradeCost, getAsComponentString, getAsString, getAttackRange, getAttributeModifiers, getAttributeModifiers, getAttributeModifiers, getBlocksAttacks, getBreakSound, getConsumable, getCustomModelData, getCustomModelDataComponent, getCustomTagContainer, getDamageResistances, getDamageResistant, getDamageType, getDamageTypeKey, getDisplayName, getEnchantable, getEnchantLevel, getEnchantmentGlintOverride, getEnchants, getEquippable, getFood, getItemFlags, getItemModel, getItemName, getJukeboxPlayable, getKineticWeapon, getLocalizedName, getLore, getMaxStackSize, getMinimumAttackCharge, getPiercingWeapon, getRarity, getSwingAnimation, getTool, getTooltipStyle, getUseCooldown, getUseEffects, getUseRemainder, getWeapon, hasAdditionalTradeCost, hasAttackRange, hasAttributeModifiers, hasBlocksAttacks, hasBreakSound, hasConflictingEnchant, hasConsumable, hasCustomModelData, hasCustomModelDataComponent, hasDamageResistant, hasDamageType, hasDisplayName, hasEnchant, hasEnchantable, hasEnchantmentGlintOverride, hasEnchants, hasEquippable, hasFood, hasItemFlag, hasItemModel, hasItemName, hasJukeboxPlayable, hasKineticWeapon, hasLocalizedName, hasLore, hasMaxStackSize, hasMinimumAttackCharge, hasPiercingWeapon, hasRarity, hasSwingAnimation, hasTool, hasTooltipStyle, hasUseCooldown, hasUseEffects, hasUseRemainder, hasWeapon, isFireResistant, isGlider, isHideTooltip, isUnbreakable, removeAttributeModifier, removeAttributeModifier, removeAttributeModifier, removeEnchant, removeEnchantments, removeItemFlags, setAdditionalTradeCost, setAttackRange, setAttributeModifiers, setBlocksAttacks, setBreakSound, setConsumable, setCustomModelData, setCustomModelDataComponent, setDamageResistant, setDamageResistant, setDamageType, setDamageTypeKey, setDisplayName, setEnchantable, setEnchantmentGlintOverride, setEquippable, setFireResistant, setFood, setGlider, setHideTooltip, setItemModel, setItemName, setJukeboxPlayable, setKineticWeapon, setLocalizedName, setLore, setMaxStackSize, setMinimumAttackCharge, setPiercingWeapon, setRarity, setSwingAnimation, setTool, setTooltipStyle, setUnbreakable, setUseCooldown, setUseEffects, setUseRemainder, setVersion, setWeapon

Methods inherited from interface PersistentDataHolder

getPersistentDataContainer

Method Details

hasBlockState

boolean hasBlockState()

Returns whether the item has a block state currently attached to it.

Returns:

whether a block state is already attached

getBlockState

@NotNull
BlockState getBlockState()

Returns the currently attached block state for this item or creates a new one if one doesn't exist. The state is a copy, it must be set back (or to another item) with setBlockState(org.bukkit.block.BlockState)

Returns:

the attached state or a new state

setBlockState

void setBlockState(@NotNull
 BlockState blockState)

Attaches a copy of the passed block state to the item.

Parameters:

blockState - the block state to attach to the block.

Throws:

IllegalArgumentException - if the blockState is null or invalid for this item.