xyz.upperlevel.spigot.book

Interface BookUtil.HoverAction

All Known Implementing Classes:

BookUtil.HoverAction.SimpleHoverAction

Enclosing class:

BookUtil

public static interface BookUtil.HoverAction

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BookUtil.HoverAction.SimpleHoverAction

Method Summary

Modifier and Type	Method and Description
net.md_5.bungee.api.chat.HoverEvent.Action	action() Get the Chat-Component action
static BookUtil.HoverAction	showAchievement(org.bukkit.Achievement achievement) Creates a show_achievement action: when the component is hovered the achievement information will be displayed
static BookUtil.HoverAction	showAchievement(String achievementId) Creates a show_achievement action: when the component is hovered the achievement information will be displayed
static BookUtil.HoverAction	showEntity(net.md_5.bungee.api.chat.BaseComponent... entity) Creates a show_entity action: when the component is hovered some entity information will be displayed
static BookUtil.HoverAction	showEntity(org.bukkit.entity.Entity entity) Creates a show_entity action: when the component is hovered some entity information will be displayed
static BookUtil.HoverAction	showEntity(UUID uuid, String type, String name) Creates a show_entity action: when the component is hovered some entity information will be displayed
static BookUtil.HoverAction	showItem(net.md_5.bungee.api.chat.BaseComponent... item) Creates a show_item action: when the component is hovered some item information will be displayed
static BookUtil.HoverAction	showItem(org.bukkit.inventory.ItemStack item) Creates a show_item action: when the component is hovered some item information will be displayed
static BookUtil.HoverAction	showStatistic(String statisticId) Creates a show_achievement action: when the component is hovered the statistic information will be displayed
static BookUtil.HoverAction	showText(net.md_5.bungee.api.chat.BaseComponent... text) Creates a show_text action: when the component is hovered the text used as parameter will be displayed
static BookUtil.HoverAction	showText(String text) Creates a show_text action: when the component is hovered the text used as parameter will be displayed
net.md_5.bungee.api.chat.BaseComponent[]	value() The value paired to the action

Method Detail

action

net.md_5.bungee.api.chat.HoverEvent.Action action()

Get the Chat-Component action

Returns:

the Chat-Component action

value

net.md_5.bungee.api.chat.BaseComponent[] value()

The value paired to the action

Returns:

the value paired tot the action

showText

static BookUtil.HoverAction showText(net.md_5.bungee.api.chat.BaseComponent... text)

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

Parameters:

text - the text to display

Returns:

a new HoverAction instance

showText

static BookUtil.HoverAction showText(String text)

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

Parameters:

text - the text to display

Returns:

a new HoverAction instance

showItem

static BookUtil.HoverAction showItem(net.md_5.bungee.api.chat.BaseComponent... item)

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

Parameters:

item - a component array representing item to display

Returns:

a new HoverAction instance

showItem

static BookUtil.HoverAction showItem(org.bukkit.inventory.ItemStack item)

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

Parameters:

item - the item to display

Returns:

a new HoverAction instance

showEntity

static BookUtil.HoverAction showEntity(net.md_5.bungee.api.chat.BaseComponent... entity)

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

Parameters:

entity - a component array representing the item to display

Returns:

a new HoverAction instance

showEntity

static BookUtil.HoverAction showEntity(UUID uuid,
                                       String type,
                                       String name)

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

Parameters:

uuid - the entity's UniqueId

type - the entity's type

name - the entity's name

Returns:

a new HoverAction instance

showEntity

static BookUtil.HoverAction showEntity(org.bukkit.entity.Entity entity)

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

Parameters:

entity - the item to display

Returns:

a new HoverAction instance

showAchievement

static BookUtil.HoverAction showAchievement(String achievementId)

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

Parameters:

achievementId - the id of the achievement to display

Returns:

a new HoverAction instance

showAchievement

static BookUtil.HoverAction showAchievement(org.bukkit.Achievement achievement)

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

Parameters:

achievement - the achievement to display

Returns:

a new HoverAction instance

showStatistic

static BookUtil.HoverAction showStatistic(String statisticId)

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

Parameters:

statisticId - the id of the statistic to display

Returns:

a new HoverAction instance