86 lines
3.0 KiB
Java
86 lines
3.0 KiB
Java
package me.totalfreedom.utils;
|
|
|
|
import me.totalfreedom.base.CommonsBase;
|
|
import net.kyori.adventure.chat.ChatType;
|
|
import net.kyori.adventure.text.Component;
|
|
import net.kyori.adventure.text.format.NamedTextColor;
|
|
import org.bukkit.command.ConsoleCommandSender;
|
|
import org.bukkit.entity.Player;
|
|
import org.bukkit.plugin.java.JavaPlugin;
|
|
|
|
/**
|
|
* This class contains different methods to provide {@link ChatType.Bound} instances for sending messages to players
|
|
* in game.
|
|
* This is now a requirement for all message requests to players due to the new chat signature system.
|
|
* <br>
|
|
* Even though Scissors has this feature disabled, upstream (Paper) and Kyori Adventure
|
|
* have made the appropriate API changes to accomodate chat signatures.
|
|
* <br>
|
|
* As a result, we need to conform to those specifications even if we do not use this feature.
|
|
*/
|
|
public final class KyoriConstants
|
|
{
|
|
private static final ChatType type = ChatType.CHAT;
|
|
|
|
/**
|
|
* A singleton {@link ChatType.Bound} for the Patchwork plugin.
|
|
*/
|
|
public static final ChatType.Bound PATCHWORK = fromPlugin(CommonsBase.class);
|
|
|
|
private KyoriConstants()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Represents a Chat Bound for a plugin.
|
|
* <br>
|
|
* This is a convenience method so you are not required to dependency inject
|
|
* your plugin instance any time that you need a Bound.
|
|
*
|
|
* @param pluginClass The plugin class to get the plugin instance from.
|
|
* @return A ChatType.Bound instance for the plugin.
|
|
* @see #fromPlugin(JavaPlugin)
|
|
*/
|
|
public static ChatType.Bound fromPlugin(final Class<? extends JavaPlugin> pluginClass)
|
|
{
|
|
final JavaPlugin plugin = JavaPlugin.getPlugin(pluginClass);
|
|
return fromPlugin(plugin);
|
|
}
|
|
|
|
public static ChatType.Bound fromPlugin(final JavaPlugin plugin)
|
|
{
|
|
final String name = plugin.getName();
|
|
final Component component = Component.text(name, NamedTextColor.GOLD);
|
|
return type.bind(component);
|
|
}
|
|
|
|
/**
|
|
* Represents a Chat Bound for a player.
|
|
* Chat bounds are required for sending messages to players.
|
|
* <br>
|
|
* The chat bound is a representation of a validated chat signature,
|
|
* which is tied directly to the user's account name. In our case, this is the player's name.
|
|
*
|
|
* @param player The player to get the bound for.
|
|
* @return A ChatType.Bound instance for the player.
|
|
*/
|
|
public static ChatType.Bound fromPlayer(final Player player)
|
|
{
|
|
return type.bind(player.name());
|
|
}
|
|
|
|
/**
|
|
* Represents a Chat Bound for the console.
|
|
* <br>
|
|
* The chat bound is a representation of a validated chat signature,
|
|
* which is tied directly to the user's account name. In our case, this is the player's name.
|
|
*
|
|
* @param sender The console to get the bound for.
|
|
* @return A ChatType.Bound instance for the console.
|
|
*/
|
|
public static ChatType.Bound fromConsole(final ConsoleCommandSender sender)
|
|
{
|
|
return type.bind(sender.name());
|
|
}
|
|
}
|