Interface BookMeta
- All Superinterfaces:
Book
,Buildable<Book,
,Book.Builder> Cloneable
,ConfigurationSerializable
,net.kyori.examination.Examinable
,ItemMeta
,PersistentDataHolder
,PersistentDataViewHolder
,WritableBookMeta
Material.WRITTEN_BOOK
that can have a title, an author,
and pages.
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 WritableBookMeta
.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
static enum
Represents the generation (or level of copying) of a written bookstatic class
Nested classes/interfaces inherited from interface net.kyori.adventure.inventory.Book
Book.Builder
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Deprecated.void
Adds new pages to the end of the book.author()
Gets the author of the book.Sets the author of the book.clone()
Gets the author of the book.Gets the generation of the book.getPage
(int page) Deprecated.usepage(int)
getPages()
Deprecated.useBook.pages()
getTitle()
Gets the title of the book.boolean
Checks for the existence of an author in the book.boolean
Checks for the existence of generation level in the book.boolean
hasTitle()
Checks for the existence of a title in the book.page
(int page) Gets the specified page in the book.void
Sets the specified page in the book.void
Sets the author of the book.void
setGeneration
(@Nullable BookMeta.Generation generation) Sets the generation of the book.void
Deprecated.void
Deprecated.void
Deprecated.useBook.pages(List)
boolean
Sets the title of the book.spigot()
title()
Gets the title of the book.Sets the title of the book.Create a new builder initialized with the attributes of this book.Methods inherited from interface org.bukkit.configuration.serialization.ConfigurationSerializable
serialize
Methods inherited from interface net.kyori.examination.Examinable
examinableName, examinableProperties, examine
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
Methods inherited from interface org.bukkit.inventory.meta.WritableBookMeta
getPageCount, hasPages
-
Method Details
-
hasTitle
boolean hasTitle()Checks for the existence of a title in the book.- Returns:
- true if the book has a title
-
getTitle
Gets the title of the book.Plugins should check that hasTitle() returns true before calling this method.
- Returns:
- the title of the book
-
setTitle
Sets the title of the book.Limited to 32 characters. Removes title when given null.
- Parameters:
title
- the title to set- Returns:
- true if the title was successfully set
-
hasAuthor
boolean hasAuthor()Checks for the existence of an author in the book.- Returns:
- true if the book has an author
-
getAuthor
Gets the author of the book.Plugins should check that hasAuthor() returns true before calling this method.
- Returns:
- the author of the book
-
setAuthor
Sets the author of the book. Removes author when given null.- Parameters:
author
- the author to set
-
hasGeneration
boolean hasGeneration()Checks for the existence of generation level in the book.- Returns:
- true if the book has a generation level
-
getGeneration
Gets the generation of the book.Plugins should check that hasGeneration() returns true before calling this method.
- Returns:
- the generation of the book
-
setGeneration
Sets the generation of the book. Removes generation when given null.- Parameters:
generation
- the generation to set
-
clone
- Specified by:
clone
in interfaceItemMeta
- Specified by:
clone
in interfaceWritableBookMeta
-
getPage
Deprecated.usepage(int)
Description copied from interface:WritableBookMeta
Gets the specified page in the book. The given page must exist.Pages are 1-indexed.
- Specified by:
getPage
in interfaceWritableBookMeta
- Parameters:
page
- the page number to get, in range [1, getPageCount()]- Returns:
- the page from the book
-
setPage
Deprecated.Description copied from interface:WritableBookMeta
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.
- Specified by:
setPage
in interfaceWritableBookMeta
- Parameters:
page
- the page number to set, in range [1, getPageCount()]data
- the data to set for that page
-
getPages
Deprecated.useBook.pages()
Description copied from interface:WritableBookMeta
Gets all the pages in the book.- Specified by:
getPages
in interfaceWritableBookMeta
- Returns:
- list of all the pages in the book
-
setPages
Deprecated.useBook.pages(List)
Description copied from interface:WritableBookMeta
Clears the existing book pages, and sets the book to use the provided pages. Maximum 100 pages with 1024 characters per page.- Specified by:
setPages
in interfaceWritableBookMeta
- Parameters:
pages
- A list of pages to set the book to use
-
setPages
Deprecated.Description copied from interface:WritableBookMeta
Clears the existing book pages, and sets the book to use the provided pages. Maximum 100 pages with 1024 characters per page.- Specified by:
setPages
in interfaceWritableBookMeta
- Parameters:
pages
- A list of strings, each being a page
-
addPage
Deprecated.Description copied from interface:WritableBookMeta
Adds new pages to the end of the book. Up to a maximum of 100 pages with 1024 characters per page.- Specified by:
addPage
in interfaceWritableBookMeta
- Parameters:
pages
- A list of strings, each being a page
-
title
Gets the title of the book.Plugins should check that hasTitle() returns true before calling this method.
-
title
@Contract(value="_ -> this", pure=false) @NotNull @NotNull BookMeta title(@Nullable Component title) Sets the title of the book.Limited to 32 characters. Removes title when given null.
-
author
Gets the author of the book.Plugins should check that hasAuthor() returns true before calling this method.
-
author
@Contract(value="_ -> this", pure=false) @NotNull @NotNull BookMeta author(@Nullable Component author) Sets the author of the book. Removes author when given null. -
page
Gets the specified page in the book. The page must exist.Pages are 1-indexed.
- Parameters:
page
- the page number to get, in range [1, getPageCount()]- Returns:
- the page from the book
-
page
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
-
addPages
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
-
toBuilder
Description copied from interface:net.kyori.adventure.inventory.Book
Create a new builder initialized with the attributes of this book. -
spigot
-
addPages(net.kyori.adventure.text.Component...)