Package io.papermc.paper.datacomponent.item

Interface WrittenBookContent

@NullMarked
@Experimental
@NonExtendable
public interface WrittenBookContent

Holds the contents and metadata of a Written Book.

See Also:

• DataComponentTypes.WRITTEN_BOOK_CONTENT

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	WrittenBookContent.Builder	Builder for WrittenBookContent.

Method Summary

Modifier and Type	Method	Description
String	author()	Player name of the author of this book.
@org.checkerframework.common.value.qual.IntRange(from=0L, to=3L) int	generation()	The number of times this book has been copied (0 = original).
@Unmodifiable List<Filtered<Component>>	pages()	Gets the pages of this book.
boolean	resolved()	If the chat components in this book have already been resolved (entity selectors, scores substituted).
Filtered<String>	title()	Title of this book.
static WrittenBookContent.Builder	writtenBookContent(Filtered<String> title, String author)
static WrittenBookContent.Builder	writtenBookContent(String title, String author)

Method Details

writtenBookContent

@Contract(value="_, _ -> new",
          pure=true)
static WrittenBookContent.Builder writtenBookContent(String title,
 String author)

writtenBookContent

@Contract(value="_, _ -> new",
          pure=true)
static WrittenBookContent.Builder writtenBookContent(Filtered<String> title,
 String author)

title

@Contract(pure=true)
Filtered<String> title()

Title of this book.

Returns:

title

author

@Contract(pure=true)
String author()

Player name of the author of this book.

Returns:

author

generation

@Contract(pure=true)
@org.checkerframework.common.value.qual.IntRange(from=0L, to=3L) int generation()

The number of times this book has been copied (0 = original).

Returns:

generation

pages

@Contract(pure=true)
@Unmodifiable List<Filtered<Component>> pages()

Gets the pages of this book.

Returns:

pages

resolved

@Contract(pure=true)
boolean resolved()

If the chat components in this book have already been resolved (entity selectors, scores substituted). If false, will be resolved when opened by a player.

Returns:

resolved