Package org.bukkit.inventory.meta
Interface BlockStateMeta
- All Superinterfaces:
java.lang.Cloneable
,ConfigurationSerializable
,ItemMeta
public interface BlockStateMeta extends ItemMeta
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.bukkit.inventory.meta.ItemMeta
ItemMeta.Spigot
-
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 org.bukkit.configuration.serialization.ConfigurationSerializable
serialize
Methods inherited from interface org.bukkit.inventory.meta.ItemMeta
addEnchant, addItemFlags, clone, getDisplayName, getEnchantLevel, getEnchants, getItemFlags, getLore, hasConflictingEnchant, hasDisplayName, hasEnchant, hasEnchants, hasItemFlag, hasLore, removeEnchant, removeItemFlags, setDisplayName, setLore, spigot
-
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
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) withsetBlockState(org.bukkit.block.BlockState)
- Returns:
- the attached state or a new state
-
setBlockState
Attaches a copy of the passed block state to the item.- Parameters:
blockState
- the block state to attach to the block.- Throws:
java.lang.IllegalArgumentException
- if the blockState is null or invalid for this item.
-