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.

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.FakeEntity<V,P>, Facet.Message<V,M>, Facet.Position<V,P>, Facet.Sound<V,P>, Facet.Title<V,M,T>, Facet.TitlePacket<V,M,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
@Nullable B	createBook(@NonNull M title, @NonNull M author, @NonNull java.lang.Iterable<M> pages)	Creates a book.
void	openBook(@NonNull V viewer, @NonNull 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(@NonNull M title,
                       @NonNull M author,
                       @NonNull 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

openBook

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

Opens a book.

Parameters:

viewer - a viewer

book - a book