A B C G I M N O P R S T U V W X

A

action() - Method in interface xyz.upperlevel.spigot.book.BookUtil.ClickAction

Get the Chat-Component action

action() - Method in interface xyz.upperlevel.spigot.book.BookUtil.HoverAction

Get the Chat-Component action

add(String) - Method in class xyz.upperlevel.spigot.book.BookUtil.PageBuilder

Adds a simple black-colored text to the page

add(BaseComponent) - Method in class xyz.upperlevel.spigot.book.BookUtil.PageBuilder

Adds a component to the page

add(BaseComponent...) - Method in class xyz.upperlevel.spigot.book.BookUtil.PageBuilder

Adds one or more components to the page

add(Collection<BaseComponent>) - Method in class xyz.upperlevel.spigot.book.BookUtil.PageBuilder

Adds one or more components to the page

author(String) - Method in class xyz.upperlevel.spigot.book.BookUtil.BookBuilder

Sets the author of the book

B

BookBuilder(ItemStack) - Constructor for class xyz.upperlevel.spigot.book.BookUtil.BookBuilder

Creates a new instance of the BookBuilder from an ItemStack representing the book item

BookHelper - Interface in xyz.upperlevel.spigot.book.internals

BookUtil - Class in xyz.upperlevel.spigot.book

BookUtil() - Constructor for class xyz.upperlevel.spigot.book.BookUtil

BookUtil.BookBuilder - Class in xyz.upperlevel.spigot.book

Helps the user to create a book

BookUtil.ClickAction - Interface in xyz.upperlevel.spigot.book

A class representing the actions a client can do when a component is clicked

BookUtil.ClickAction.SimpleClickAction - Class in xyz.upperlevel.spigot.book

BookUtil.HoverAction - Interface in xyz.upperlevel.spigot.book

A class representing the actions a client can do when a component is hovered

BookUtil.HoverAction.SimpleHoverAction - Class in xyz.upperlevel.spigot.book

BookUtil.PageBuilder - Class in xyz.upperlevel.spigot.book

Helps the user creating a book's page

BookUtil.TextBuilder - Class in xyz.upperlevel.spigot.book

A more user-friendly version of the Chat Component API designed mainly for book-based operations NOTE: some (of the more useless) features don't work in some MC versions for client-based errors

build() - Method in class xyz.upperlevel.spigot.book.BookUtil.BookBuilder

Creates the book

build() - Method in class xyz.upperlevel.spigot.book.BookUtil.PageBuilder

Builds the page

build() - Method in class xyz.upperlevel.spigot.book.BookUtil.TextBuilder

Creates the component representing the built text

C

changePage(int) - Static method in interface xyz.upperlevel.spigot.book.BookUtil.ClickAction

Creates a change_page action: when the player clicks the book page will be set at the value passed as argument

color(ChatColor) - Method in class xyz.upperlevel.spigot.book.BookUtil.TextBuilder

Sets the color of the text, or takes the previous color (if null is passed)

CustomBookOpenEvent - Class in xyz.upperlevel.spigot.book

The event called when a book is opened trough this Util

CustomBookOpenEvent(Player, ItemStack, boolean) - Constructor for class xyz.upperlevel.spigot.book.CustomBookOpenEvent

G

generation(BookMeta.Generation) - Method in class xyz.upperlevel.spigot.book.BookUtil.BookBuilder

Sets the generation of the book.

getCraftClass(String) - Static method in class xyz.upperlevel.spigot.book.internals.NmsUtil

getHandlerList() - Static method in class xyz.upperlevel.spigot.book.CustomBookOpenEvent

getHandlers() - Method in class xyz.upperlevel.spigot.book.CustomBookOpenEvent

getNmsClass(String, boolean) - Static method in class xyz.upperlevel.spigot.book.internals.NmsUtil

Use NmsUtil.getNmsClass(String, String, boolean) to make sure of compatibility with mc 1.17+.

getNmsClass(String, String, boolean) - Static method in class xyz.upperlevel.spigot.book.internals.NmsUtil

I

isSupported() - Static method in class xyz.upperlevel.spigot.book.internals.SpigotBookHelper

itemToComponents(ItemStack) - Method in interface xyz.upperlevel.spigot.book.internals.BookHelper

Translates an ItemStack to his Chat-Component equivalent

itemToJson(ItemStack) - Method in interface xyz.upperlevel.spigot.book.internals.BookHelper

Translates an ItemStack to his json equivalent

itemToJson(ItemStack) - Static method in class xyz.upperlevel.spigot.book.internals.NmsUtil

M

major - Static variable in class xyz.upperlevel.spigot.book.internals.NmsUtil

minor - Static variable in class xyz.upperlevel.spigot.book.internals.NmsUtil

N

newLine() - Method in class xyz.upperlevel.spigot.book.BookUtil.PageBuilder

Adds a newline to the page (equivalent of adding \n to the previous component)

NmsBookHelper - Class in xyz.upperlevel.spigot.book.internals

The NMS helper for all the Book-API Note: we added SpigotBookHelper and it should be more compatible, This WILL NOT WORK after 1.17.x due to spigot dropping NMS methods names remaps.

NmsBookHelper() - Constructor for class xyz.upperlevel.spigot.book.internals.NmsBookHelper

nmsCopy(ItemStack) - Static method in class xyz.upperlevel.spigot.book.internals.NmsUtil

Creates a NMS copy of the parameter

NmsUtil - Class in xyz.upperlevel.spigot.book.internals

Tiny NMS utility, it should be loaded only if the NMS helper is used or if the developer uses ItemStack hovering (since it requires saving the NMS NBT as a JSON, and that is currently impossible)

O

of(String) - Static method in class xyz.upperlevel.spigot.book.BookUtil.PageBuilder

Creates a new PageBuilder instance wih the parameter as the initial text

of(BaseComponent) - Static method in class xyz.upperlevel.spigot.book.BookUtil.PageBuilder

Creates a new PageBuilder instance wih the parameter as the initial component

of(BaseComponent...) - Static method in class xyz.upperlevel.spigot.book.BookUtil.PageBuilder

Creates a new PageBuilder instance wih the parameter as the initial components

of(String) - Static method in class xyz.upperlevel.spigot.book.BookUtil.TextBuilder

Creates a new TextBuilder with the parameter as his initial text

openBook(Player, ItemStack) - Method in interface xyz.upperlevel.spigot.book.internals.BookHelper

Opens the book to a player (the player needs to have the book in one of his hands)

openBook(Player, ItemStack) - Method in class xyz.upperlevel.spigot.book.internals.NmsBookHelper

openBook(Player, ItemStack) - Method in class xyz.upperlevel.spigot.book.internals.SpigotBookHelper

openPlayer(Player, ItemStack) - Static method in class xyz.upperlevel.spigot.book.BookUtil

Opens a book GUI to the player

openUrl(String) - Static method in interface xyz.upperlevel.spigot.book.BookUtil.ClickAction

Creates a open_utl action: when the player clicks the url passed as argument will open in the browser

P

PageBuilder() - Constructor for class xyz.upperlevel.spigot.book.BookUtil.PageBuilder

pages(BaseComponent[]...) - Method in class xyz.upperlevel.spigot.book.BookUtil.BookBuilder

Sets the pages of the book

pages(List<BaseComponent[]>) - Method in class xyz.upperlevel.spigot.book.BookUtil.BookBuilder

Sets the pages of the book

pagesRaw(String...) - Method in class xyz.upperlevel.spigot.book.BookUtil.BookBuilder

Sets the pages of the book without worrying about json or interactivity

pagesRaw(List<String>) - Method in class xyz.upperlevel.spigot.book.BookUtil.BookBuilder

Sets the pages of the book without worrying about json or interactivity

R

runCommand(String) - Static method in interface xyz.upperlevel.spigot.book.BookUtil.ClickAction

Creates a command action: when the player clicks, the command passed as parameter gets executed with the clicker as sender

S

setPages(BookMeta, BaseComponent[][]) - Method in interface xyz.upperlevel.spigot.book.internals.BookHelper

Sets the pages of the book to the components json equivalent

setPages(BookMeta, BaseComponent[][]) - Method in class xyz.upperlevel.spigot.book.internals.NmsBookHelper

setPages(BookMeta, BaseComponent[][]) - Method in class xyz.upperlevel.spigot.book.internals.SpigotBookHelper

showAchievement(String) - Static method in interface xyz.upperlevel.spigot.book.BookUtil.HoverAction

Creates a show_achievement action: when the component is hovered the achievement information will be displayed

showEntity(BaseComponent...) - Static method in interface xyz.upperlevel.spigot.book.BookUtil.HoverAction

Creates a show_entity action: when the component is hovered some entity information will be displayed

showEntity(UUID, String, String) - Static method in interface xyz.upperlevel.spigot.book.BookUtil.HoverAction

Creates a show_entity action: when the component is hovered some entity information will be displayed

showEntity(Entity) - Static method in interface xyz.upperlevel.spigot.book.BookUtil.HoverAction

Creates a show_entity action: when the component is hovered some entity information will be displayed

showItem(BaseComponent...) - Static method in interface xyz.upperlevel.spigot.book.BookUtil.HoverAction

Creates a show_item action: when the component is hovered some item information will be displayed

showItem(ItemStack) - Static method in interface xyz.upperlevel.spigot.book.BookUtil.HoverAction

Creates a show_item action: when the component is hovered some item information will be displayed

showStatistic(String) - Static method in interface xyz.upperlevel.spigot.book.BookUtil.HoverAction

Creates a show_achievement action: when the component is hovered the statistic information will be displayed

showText(BaseComponent...) - Static method in interface xyz.upperlevel.spigot.book.BookUtil.HoverAction

Creates a show_text action: when the component is hovered the text used as parameter will be displayed

showText(String) - Static method in interface xyz.upperlevel.spigot.book.BookUtil.HoverAction

Creates a show_text action: when the component is hovered the text used as parameter will be displayed

SimpleClickAction() - Constructor for class xyz.upperlevel.spigot.book.BookUtil.ClickAction.SimpleClickAction

SimpleHoverAction(HoverEvent.Action, BaseComponent...) - Constructor for class xyz.upperlevel.spigot.book.BookUtil.HoverAction.SimpleHoverAction

SpigotBookHelper - Class in xyz.upperlevel.spigot.book.internals

New "helper", uses newer spigot APIs.

SpigotBookHelper() - Constructor for class xyz.upperlevel.spigot.book.internals.SpigotBookHelper

style(ChatColor...) - Method in class xyz.upperlevel.spigot.book.BookUtil.TextBuilder

Sets the style of the text

suggestCommand(String) - Static method in interface xyz.upperlevel.spigot.book.BookUtil.ClickAction

Deprecated.

suggest_command does not work in books, this was marked as "Working As Intended" by mojang: See MC-70317

T

TextBuilder() - Constructor for class xyz.upperlevel.spigot.book.BookUtil.TextBuilder

title(String) - Method in class xyz.upperlevel.spigot.book.BookUtil.BookBuilder

Sets the title of the book.

toNms(Player) - Static method in class xyz.upperlevel.spigot.book.internals.NmsUtil

Gets the EntityPlayer handled by the argument

U

UnsupportedVersionException - Exception in xyz.upperlevel.spigot.book

An error thrown when this NMS-helper class doesn't support the running MC version

UnsupportedVersionException(Exception) - Constructor for exception xyz.upperlevel.spigot.book.UnsupportedVersionException

V

value() - Method in interface xyz.upperlevel.spigot.book.BookUtil.ClickAction

The value paired to the action

value() - Method in interface xyz.upperlevel.spigot.book.BookUtil.HoverAction

The value paired to the action

version - Static variable in class xyz.upperlevel.spigot.book.internals.NmsUtil

W

writtenBook() - Static method in class xyz.upperlevel.spigot.book.BookUtil

Creates a BookBuilder instance with a written book as the Itemstack's type

X

xyz.upperlevel.spigot.book - package xyz.upperlevel.spigot.book

xyz.upperlevel.spigot.book.internals - package xyz.upperlevel.spigot.book.internals

A B C G I M N O P R S T U V W X