Package net.kyori.adventure.platform.facet

Interface Facet.Book<V,M,B>

Type Parameters:

V - a viewer type

M - a message type

B - a book type

All Superinterfaces:

Facet<V>, Facet.Message<V,M>

Enclosing interface:

Facet<V>

public static interface Facet.Book<V,M,B>
extends Facet.Message<V,M>

A facet that opens a book.

Since:

4.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface net.kyori.adventure.platform.facet.Facet

Facet.ActionBar<V,M>, Facet.Book<V,M,B>, Facet.BossBar<V>, Facet.BossBarEntity<V,P>, Facet.BossBarPacket<V>, Facet.Chat<V,M>, Facet.ChatPacket<V,M>, Facet.EntitySound<V,M>, Facet.FakeEntity<V,P>, Facet.Message<V,M>, Facet.Pointers<V>, Facet.Position<V,P>, Facet.Sound<V,P>, Facet.TabList<V,M>, Facet.Title<V,M,C,T>, Facet.TitlePacket<V,M,C,T>

Field Summary

Fields inherited from interface net.kyori.adventure.platform.facet.Facet.Message

PROTOCOL_HEX_COLOR, PROTOCOL_JSON

Method Summary

Modifier and Type	Method	Description
B	createBook(@NotNull java.lang.String title, @NotNull java.lang.String author, @NotNull java.lang.Iterable<M> pages)	Creates a book.
void	openBook(V viewer, B book)	Opens a book.

Methods inherited from interface net.kyori.adventure.platform.facet.Facet

isApplicable, isSupported

Methods inherited from interface net.kyori.adventure.platform.facet.Facet.Message

createMessage

Method Detail

createBook

@Nullable
B createBook(@NotNull
             @NotNull java.lang.String title,
             @NotNull
             @NotNull java.lang.String author,
             @NotNull
             @NotNull java.lang.Iterable<M> pages)

Creates a book.

Parameters:

title - a title

author - an author

pages - a collection of pages

Returns:

a book or null

Since:

4.0.0

openBook

void openBook(@NotNull
              V viewer,
              @NotNull
              B book)

Opens a book.

Parameters:

viewer - a viewer

book - a book

Since:

4.0.0