com.cryptomorin.xseries.messages.Titles Maven / Gradle / Ivy
Show all versions of XSeries Show documentation
/*
* The MIT License (MIT)
*
* Copyright (c) 2024 Crypto Morin
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
* PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
* FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package com.cryptomorin.xseries.messages;
import com.cryptomorin.xseries.reflection.XReflection;
import com.cryptomorin.xseries.reflection.minecraft.MinecraftClassHandle;
import com.cryptomorin.xseries.reflection.minecraft.MinecraftPackage;
import org.bukkit.configuration.ConfigurationSection;
import org.bukkit.entity.Player;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.lang.invoke.MethodHandle;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.Objects;
import java.util.function.Function;
import static com.cryptomorin.xseries.reflection.XReflection.ofMinecraft;
import static com.cryptomorin.xseries.reflection.minecraft.MinecraftConnection.sendPacket;
/**
* A reflection API for titles in Minecraft.
* Fully optimized - Supports 1.8.8+ and above.
* Requires ReflectionUtils.
* Messages are not colorized by default.
*
* Titles are text messages that appear in the
* middle of the players screen: https://minecraft.wiki/w/Commands/title
* PacketPlayOutTitle: https://wiki.vg/Protocol#Title
*
* @author Crypto Morin
* @version 3.1.0
* @see XReflection
*/
public final class Titles implements Cloneable {
/**
* EnumTitleAction
* Used for the fade in, stay and fade out feature of titles.
* Others: ACTIONBAR, RESET
*/
private static final Object TITLE, SUBTITLE, TIMES, CLEAR;
private static final MethodHandle PACKET_PLAY_OUT_TITLE;
/**
* ChatComponentText JSON message builder.
*/
private static final MethodHandle CHAT_COMPONENT_TEXT;
private String title, subtitle;
private final int fadeIn, stay, fadeOut;
/**
* From the latest 1.11.2 not checked with supports() to prevent
* errors on outdated 1.11 versions.
*/
private static final boolean SUPPORTS_TITLES;
static {
MethodHandle packetCtor = null;
MethodHandle chatComp = null;
Object times = null;
Object title = null;
Object subtitle = null;
Object clear = null;
boolean SUPPORTS_TITLES1;
try {
Player.class.getDeclaredMethod("sendTitle",
String.class, String.class,
int.class, int.class, int.class);
SUPPORTS_TITLES1 = true;
} catch (NoSuchMethodException e) {
SUPPORTS_TITLES1 = false;
}
SUPPORTS_TITLES = SUPPORTS_TITLES1;
if (!SUPPORTS_TITLES) {
MinecraftClassHandle chatComponentText = ofMinecraft().inPackage(MinecraftPackage.NMS).named("ChatComponentText");
MinecraftClassHandle packet = ofMinecraft().inPackage(MinecraftPackage.NMS).named("PacketPlayOutTitle");
MinecraftClassHandle IChatBaseComponentClass = ofMinecraft().inPackage(MinecraftPackage.NMS).named("IChatBaseComponent");
Class titleTypes = packet.unreflect().getDeclaredClasses()[0];
for (Object type : titleTypes.getEnumConstants()) {
switch (type.toString()) {
case "TIMES":
times = type;
break;
case "TITLE":
title = type;
break;
case "SUBTITLE":
subtitle = type;
break;
case "CLEAR":
clear = type;
}
}
try {
chatComp = chatComponentText.constructor(String.class).reflect();
packetCtor = packet.constructor(titleTypes, IChatBaseComponentClass.unreflect(), int.class, int.class, int.class).reflect();
} catch (ReflectiveOperationException e) {
e.printStackTrace();
}
}
TITLE = title;
SUBTITLE = subtitle;
TIMES = times;
CLEAR = clear;
PACKET_PLAY_OUT_TITLE = packetCtor;
CHAT_COMPONENT_TEXT = chatComp;
}
public Titles(String title, String subtitle, int fadeIn, int stay, int fadeOut) {
this.title = title;
this.subtitle = subtitle;
this.fadeIn = fadeIn;
this.stay = stay;
this.fadeOut = fadeOut;
}
@SuppressWarnings("MethodDoesntCallSuperMethod")
@Override
public Titles clone() {
return new Titles(title, subtitle, fadeIn, stay, fadeOut);
}
public void send(Player player) {
sendTitle(player, fadeIn, stay, fadeOut, title, subtitle);
}
/**
* Sends a title message with title and subtitle to a player.
*
* @param player the player to send the title to.
* @param fadeIn the amount of ticks for title to fade in.
* @param stay the amount of ticks for the title to stay.
* @param fadeOut the amount of ticks for the title to fade out.
* @param title the title message.
* @param subtitle the subtitle message.
* @see #clearTitle(Player)
* @since 1.0.0
*/
public static void sendTitle(@Nonnull Player player,
int fadeIn, int stay, int fadeOut,
@Nullable String title, @Nullable String subtitle) {
Objects.requireNonNull(player, "Cannot send title to null player");
if (title == null && subtitle == null) return;
if (SUPPORTS_TITLES) {
player.sendTitle(title, subtitle, fadeIn, stay, fadeOut);
return;
}
try {
Object timesPacket = PACKET_PLAY_OUT_TITLE.invoke(TIMES, CHAT_COMPONENT_TEXT.invoke(title), fadeIn, stay, fadeOut);
sendPacket(player, timesPacket);
if (title != null) {
Object titlePacket = PACKET_PLAY_OUT_TITLE.invoke(TITLE, CHAT_COMPONENT_TEXT.invoke(title), fadeIn, stay, fadeOut);
sendPacket(player, titlePacket);
}
if (subtitle != null) {
Object subtitlePacket = PACKET_PLAY_OUT_TITLE.invoke(SUBTITLE, CHAT_COMPONENT_TEXT.invoke(subtitle), fadeIn, stay, fadeOut);
sendPacket(player, subtitlePacket);
}
} catch (Throwable throwable) {
throwable.printStackTrace();
}
}
/**
* Sends a title message with title and subtitle with normal
* fade in, stay and fade out time to a player.
*
* @param player the player to send the title to.
* @param title the title message.
* @param subtitle the subtitle message.
* @see #sendTitle(Player, int, int, int, String, String)
* @since 1.0.0
*/
public static void sendTitle(@Nonnull Player player, @Nonnull String title, @Nonnull String subtitle) {
sendTitle(player, 10, 20, 10, title, subtitle);
}
/**
* Parses and sends a title from the config.
*
* @param player the player to send the title to.
* @param config the configuration section to parse the title properties from.
* @since 1.0.0
*/
public static Titles sendTitle(@Nonnull Player player, @Nonnull ConfigurationSection config) {
Titles titles = parseTitle(config, null);
titles.send(player);
return titles;
}
public static Titles parseTitle(@Nonnull ConfigurationSection config) {
return parseTitle(config, null);
}
/**
* Parses a title from config.
* The configuration section must at least
* contain {@code title} or {@code subtitle}
*
*
* Example:
*
* ConfigurationSection titleSection = plugin.getConfig().getConfigurationSection("restart-title");
* Titles.sendTitle(player, titleSection);
*
*
* @param config the configuration section to parse the title properties from.
* @since 3.0.0
*/
public static Titles parseTitle(@Nonnull ConfigurationSection config, @Nullable Function transformers) {
String title = config.getString("title");
String subtitle = config.getString("subtitle");
if (transformers != null) {
title = transformers.apply(title);
subtitle = transformers.apply(subtitle);
}
int fadeIn = config.getInt("fade-in");
int stay = config.getInt("stay");
int fadeOut = config.getInt("fade-out");
if (fadeIn < 1) fadeIn = 10;
if (stay < 1) stay = 20;
if (fadeOut < 1) fadeOut = 10;
return new Titles(title, subtitle, fadeIn, stay, fadeOut);
}
public String getTitle() {
return title;
}
public String getSubtitle() {
return subtitle;
}
public void setTitle(String title) {
this.title = title;
}
public void setSubtitle(String subtitle) {
this.subtitle = subtitle;
}
/**
* Clears the title and subtitle message from the player's screen.
*
* @param player the player to clear the title from.
* @since 1.0.0
*/
public static void clearTitle(@Nonnull Player player) {
Objects.requireNonNull(player, "Cannot clear title from null player");
if (XReflection.supports(11)) {
player.resetTitle();
return;
}
Object clearPacket;
try {
clearPacket = PACKET_PLAY_OUT_TITLE.invoke(CLEAR, null, -1, -1, -1);
} catch (Throwable throwable) {
throwable.printStackTrace();
return;
}
sendPacket(player, clearPacket);
}
/**
* Supports pre-1.13 tab method.
* Changes the tablist header and footer message for a player.
* This is not fully completed as it's not used a lot.
*
* Headers and footers cannot be null because the client will simply
* ignore the packet.
*
* @param header the header of the tablist.
* @param footer the footer of the tablist.
* @param players players to send this change to.
* @since 1.0.0
*/
public static void sendTabList(@Nonnull String header, @Nonnull String footer, Player... players) {
Objects.requireNonNull(players, "Cannot send tab title to null players");
Objects.requireNonNull(header, "Tab title header cannot be null");
Objects.requireNonNull(footer, "Tab title footer cannot be null");
if (XReflection.supports(13)) {
// https://hub.spigotmc.org/stash/projects/SPIGOT/repos/bukkit/browse/src/main/java/org/bukkit/entity/Player.java?until=2975358a021fe25d52a8103f7d7aaeceb3abf245&untilPath=src%2Fmain%2Fjava%2Forg%2Fbukkit%2Fentity%2FPlayer.java
for (Player player : players) player.setPlayerListHeaderFooter(header, footer);
return;
}
try {
Class IChatBaseComponent = XReflection.getNMSClass("network.chat", "IChatBaseComponent");
Class PacketPlayOutPlayerListHeaderFooter = XReflection.getNMSClass("network.protocol.game", "PacketPlayOutPlayerListHeaderFooter");
Method chatComponentBuilderMethod = IChatBaseComponent.getDeclaredClasses()[0].getMethod("a", String.class);
Object tabHeader = chatComponentBuilderMethod.invoke(null, "{\"text\":\"" + header + "\"}");
Object tabFooter = chatComponentBuilderMethod.invoke(null, "{\"text\":\"" + footer + "\"}");
Object packet = PacketPlayOutPlayerListHeaderFooter.getConstructor().newInstance();
Field headerField = PacketPlayOutPlayerListHeaderFooter.getDeclaredField("a"); // Changed to "header" in 1.13
Field footerField = PacketPlayOutPlayerListHeaderFooter.getDeclaredField("b"); // Changed to "footer" in 1.13
headerField.setAccessible(true);
headerField.set(packet, tabHeader);
footerField.setAccessible(true);
footerField.set(packet, tabFooter);
for (Player player : players) sendPacket(player, packet);
} catch (Exception ex) {
throw new RuntimeException(ex);
}
}
}