Package org.bukkit.inventory.meta
Interface WritableBookMeta
- All Superinterfaces:
Cloneable
,ConfigurationSerializable
,ItemMeta
,PersistentDataHolder
,PersistentDataViewHolder
- All Known Subinterfaces:
BookMeta
Represents a book (
Material.WRITABLE_BOOK
) that can have pages.
For Material.WRITTEN_BOOK
, use BookMeta
.
Before using this type, make sure to check the itemstack's material with
ItemStack.getType()
. instanceof
on
the meta instance is not sufficient due to unusual inheritance
with relation to BookMeta
.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds new pages to the end of the book.clone()
getPage
(int page) Gets the specified page in the book.int
Gets the number of pages in the book.getPages()
Gets all the pages in the book.boolean
hasPages()
Checks for the existence of pages in the book.void
Sets the specified page in the book.void
Clears the existing book pages, and sets the book to use the provided pages.void
Clears the existing book pages, and sets the book to use the provided pages.Methods inherited from interface org.bukkit.configuration.serialization.ConfigurationSerializable
serialize
Methods inherited from interface org.bukkit.inventory.meta.ItemMeta
addAttributeModifier, addEnchant, addItemFlags, displayName, displayName, getAsComponentString, getAsString, getAttributeModifiers, getAttributeModifiers, getAttributeModifiers, getCanDestroy, getCanPlaceOn, getCustomModelData, getCustomTagContainer, getDamageResistant, getDestroyableKeys, getDisplayName, getDisplayNameComponent, getEnchantable, getEnchantLevel, getEnchantmentGlintOverride, getEnchants, getEquippable, getFood, getItemFlags, getItemModel, getItemName, getJukeboxPlayable, getLocalizedName, getLore, getLoreComponents, getMaxStackSize, getPlaceableKeys, getRarity, getTool, getTooltipStyle, getUseCooldown, getUseRemainder, hasAttributeModifiers, hasConflictingEnchant, hasCustomModelData, hasDamageResistant, hasDestroyableKeys, hasDisplayName, hasEnchant, hasEnchantable, hasEnchantmentGlintOverride, hasEnchants, hasEquippable, hasFood, hasItemFlag, hasItemModel, hasItemName, hasJukeboxPlayable, hasLocalizedName, hasLore, hasMaxStackSize, hasPlaceableKeys, hasRarity, hasTool, hasTooltipStyle, hasUseCooldown, hasUseRemainder, isFireResistant, isGlider, isHideTooltip, isUnbreakable, itemName, itemName, lore, lore, removeAttributeModifier, removeAttributeModifier, removeAttributeModifier, removeEnchant, removeEnchantments, removeItemFlags, setAttributeModifiers, setCanDestroy, setCanPlaceOn, setCustomModelData, setDamageResistant, setDestroyableKeys, setDisplayName, setDisplayNameComponent, setEnchantable, setEnchantmentGlintOverride, setEquippable, setFireResistant, setFood, setGlider, setHideTooltip, setItemModel, setItemName, setJukeboxPlayable, setLocalizedName, setLore, setLoreComponents, setMaxStackSize, setPlaceableKeys, setRarity, setTool, setTooltipStyle, setUnbreakable, setUseCooldown, setUseRemainder, setVersion
Methods inherited from interface org.bukkit.persistence.PersistentDataHolder
getPersistentDataContainer
-
Method Details
-
hasPages
boolean hasPages()Checks for the existence of pages in the book.- Returns:
- true if the book has pages
-
getPage
Gets the specified page in the book. The given page must exist.Pages are 1-indexed.
- Parameters:
page
- the page number to get, in range [1, getPageCount()]- Returns:
- the page from the book
-
setPage
Sets the specified page in the book. Pages of the book must be contiguous.The data can be up to 1024 characters in length, additional characters are truncated.
Pages are 1-indexed.
- Parameters:
page
- the page number to set, in range [1, getPageCount()]data
- the data to set for that page
-
getPages
Gets all the pages in the book.- Returns:
- list of all the pages in the book
-
setPages
Clears the existing book pages, and sets the book to use the provided pages. Maximum 100 pages with 1024 characters per page.- Parameters:
pages
- A list of pages to set the book to use
-
setPages
Clears the existing book pages, and sets the book to use the provided pages. Maximum 100 pages with 1024 characters per page.- Parameters:
pages
- A list of strings, each being a page
-
addPage
Adds new pages to the end of the book. Up to a maximum of 100 pages with 1024 characters per page.- Parameters:
pages
- A list of strings, each being a page
-
getPageCount
int getPageCount()Gets the number of pages in the book.- Returns:
- the number of pages in the book
-
clone
-