eu.wauz.wauzcore.system.util

Class Components

java.lang.Object

eu.wauz.wauzcore.system.util.Components

public class Components
extends java.lang.Object

Util class for interacting with adventure components.

Author:

Wauzmons

Constructor Summary

Constructors

Constructor and Description
Components()

Method Summary

Modifier and Type	Method and Description
static void	actionBar(org.bukkit.entity.Player player, java.lang.String actionBar) Sets the action bar of the given player.
static void	broadcast(net.kyori.adventure.text.Component component) Sends a component to everyone.
static void	broadcast(java.lang.String message) Sends a message to everyone.
static net.kyori.adventure.text.TextComponent	commandComponent(java.lang.String message, java.lang.String command) Creates a command component from the given values.
static java.lang.String	displayName(org.bukkit.inventory.meta.ItemMeta itemMeta) Gets the display name of the given item meta.
static void	displayName(org.bukkit.inventory.meta.ItemMeta itemMeta, java.lang.String displayName) Sets the display name of the given item meta.
private static java.lang.String	fromComponent(net.kyori.adventure.text.Component component) Converts the given component to text.
static net.kyori.adventure.text.TextComponent	hyperlinkComponent(java.lang.String message, java.lang.String url) Creates a hyperlink component from the given values.
static org.bukkit.inventory.Inventory	inventory(WauzInventory inventory, java.lang.String title, int slots) Creates a custom inventory instance.
static net.kyori.adventure.text.TextComponent	itemComponent(java.lang.String message, org.bukkit.inventory.ItemStack itemStack) Creates an item component from the given values.
static void	kick(org.bukkit.entity.Player player, java.lang.String message) Kicks a player and shows them the given message.
static java.lang.String	line(org.bukkit.block.Sign sign, int index) Gets the line of the given sign.
static void	line(org.bukkit.block.Sign sign, int index, java.lang.String line) Sets the line of the given sign.
static java.util.List<java.lang.String>	lines(org.bukkit.event.block.SignChangeEvent event) Gets the lines of the given sign event.
static void	lines(org.bukkit.event.block.SignChangeEvent event, java.util.List<java.lang.String> lines) Sets the lines of the given sign event.
static java.util.List<java.lang.String>	lore(org.bukkit.inventory.meta.ItemMeta itemMeta) Gets the lore of the given item meta.
static void	lore(org.bukkit.inventory.meta.ItemMeta itemMeta, java.util.List<java.lang.String> loreLines) Sets the lore of the given item meta.
static java.lang.String	message(io.papermc.paper.event.player.AsyncChatEvent event) Gets the message of the given chat event.
static void	motd(org.bukkit.event.server.ServerListPingEvent event, java.lang.String motd) Sets the modt of the given ping event.
static org.bukkit.scoreboard.Objective	objective(org.bukkit.scoreboard.Scoreboard scoreboard, java.lang.String name, java.lang.String criteria, java.lang.String displayName) Registers a new objective on the given scoreboard.
static void	playerListHeaderAndFooter(org.bukkit.entity.Player player, java.lang.String header, java.lang.String footer) Sets the player list header and footer for the given player.
static void	teamPrefixAndColor(org.bukkit.scoreboard.Team team, java.lang.String prefix, org.bukkit.ChatColor color) Sets the team prefix and color for the given team.
static java.lang.String	title(org.bukkit.inventory.InventoryView inventory) Gets the title of the given inventory.
private static net.kyori.adventure.text.TextComponent	toComponent(java.lang.String text) Converts the given text to a component.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Components

public Components()

Method Detail

title

public static java.lang.String title(org.bukkit.inventory.InventoryView inventory)

Gets the title of the given inventory.

Parameters:

inventory - The inventory to get the title from.

Returns:

The title.

inventory

public static org.bukkit.inventory.Inventory inventory(WauzInventory inventory,
                                                       java.lang.String title,
                                                       int slots)

Creates a custom inventory instance.

Parameters:

inventory - The inventory to instantiate.

title - The title of the inventory instance.

slots - The slots of the inventory instance.

Returns:

The created inventory.

kick

public static void kick(org.bukkit.entity.Player player,
                        java.lang.String message)

Kicks a player and shows them the given message.

Parameters:

player - The player to kick.

message - The message to show to the player.

actionBar

public static void actionBar(org.bukkit.entity.Player player,
                             java.lang.String actionBar)

Sets the action bar of the given player.

Parameters:

player - The player to set the action bar for.

actionBar - The action bar to set.

playerListHeaderAndFooter

public static void playerListHeaderAndFooter(org.bukkit.entity.Player player,
                                             java.lang.String header,
                                             java.lang.String footer)

Sets the player list header and footer for the given player.

Parameters:

player - The player to set the player list header and footer for.

header - The header to set.

footer - The footer to set.

teamPrefixAndColor

public static void teamPrefixAndColor(org.bukkit.scoreboard.Team team,
                                      java.lang.String prefix,
                                      org.bukkit.ChatColor color)

Sets the team prefix and color for the given team.

Parameters:

team - The team to set the team prefix and color for.

prefix - The prefix to set.

color - The color to set.

objective

public static org.bukkit.scoreboard.Objective objective(org.bukkit.scoreboard.Scoreboard scoreboard,
                                                        java.lang.String name,
                                                        java.lang.String criteria,
                                                        java.lang.String displayName)

Registers a new objective on the given scoreboard.

Parameters:

scoreboard - The scoreboard to register the objective on.

name - The name of the objective.

criteria - The criteria of the objective.

displayName - The display name of the objective.

Returns:

The created objective.

displayName

public static java.lang.String displayName(org.bukkit.inventory.meta.ItemMeta itemMeta)

Gets the display name of the given item meta.

Parameters:

itemMeta - The item meta to get the display name from.

Returns:

The display name.

displayName

public static void displayName(org.bukkit.inventory.meta.ItemMeta itemMeta,
                               java.lang.String displayName)

Sets the display name of the given item meta.

Parameters:

itemMeta - The item meta to set the display name for.

displayName - The display name to set.

lore

public static java.util.List<java.lang.String> lore(org.bukkit.inventory.meta.ItemMeta itemMeta)

Gets the lore of the given item meta.

Parameters:

itemMeta - The item meta to get the lore from.

Returns:

The lore.

lore

public static void lore(org.bukkit.inventory.meta.ItemMeta itemMeta,
                        java.util.List<java.lang.String> loreLines)

Sets the lore of the given item meta.

Parameters:

itemMeta - The item meta to set the lore for.

loreLines - The lore to set.

line

public static java.lang.String line(org.bukkit.block.Sign sign,
                                    int index)

Gets the line of the given sign.

Parameters:

sign - The sign to get the line from.

index - The index of the line.

Returns:

The line.

line

public static void line(org.bukkit.block.Sign sign,
                        int index,
                        java.lang.String line)

Sets the line of the given sign.

Parameters:

sign - The sign to set the line for.

index - The index of the line.

line - The line to set.

lines

public static java.util.List<java.lang.String> lines(org.bukkit.event.block.SignChangeEvent event)

Gets the lines of the given sign event.

Parameters:

event - The sign event to get the lines from.

Returns:

The lines.

lines

public static void lines(org.bukkit.event.block.SignChangeEvent event,
                         java.util.List<java.lang.String> lines)

Sets the lines of the given sign event.

Parameters:

event - The sign event to set the lines for.

lines - The lines to set.

motd

public static void motd(org.bukkit.event.server.ServerListPingEvent event,
                        java.lang.String motd)

Sets the modt of the given ping event.

Parameters:

event - The ping event to set the motd for.

motd - The motd to set.

message

public static java.lang.String message(io.papermc.paper.event.player.AsyncChatEvent event)

Gets the message of the given chat event.

Parameters:

event - The chat event to get the message from.

Returns:

The message.

itemComponent

public static net.kyori.adventure.text.TextComponent itemComponent(java.lang.String message,
                                                                   org.bukkit.inventory.ItemStack itemStack)

Creates an item component from the given values.

Parameters:

message - The message that should be shown.

itemStack - The item stack that should be shown.

Returns:

The created component.

commandComponent

public static net.kyori.adventure.text.TextComponent commandComponent(java.lang.String message,
                                                                      java.lang.String command)

Creates a command component from the given values.

Parameters:

message - The message that should be shown.

command - The command that should be executed on click.

Returns:

The created component.

hyperlinkComponent

public static net.kyori.adventure.text.TextComponent hyperlinkComponent(java.lang.String message,
                                                                        java.lang.String url)

Creates a hyperlink component from the given values.

Parameters:

message - The message that should be shown.

url - The url that should be opened on click.

Returns:

The created component.

broadcast

public static void broadcast(java.lang.String message)

Sends a message to everyone.

Parameters:

message - The message to send.

broadcast

public static void broadcast(net.kyori.adventure.text.Component component)

Sends a component to everyone.

Parameters:

component - The component to send.

toComponent

private static net.kyori.adventure.text.TextComponent toComponent(java.lang.String text)

Converts the given text to a component.

Parameters:

text - The text to convert.

Returns:

The created component.

fromComponent

private static java.lang.String fromComponent(net.kyori.adventure.text.Component component)

Converts the given component to text.

Parameters:

component - The component to convert.

Returns:

The created text.