new module pandalib-paper-players

pandalib-paper-players/src/main/java/fr/pandacub/lib/paper/players/PaperOffPlayer.java

@@ -0,0 +1,90 @@
+package fr.pandacub.lib.paper.players;
+
+import org.bukkit.Bukkit;
+import org.bukkit.OfflinePlayer;
+import org.bukkit.entity.Player;
+import org.bukkit.scoreboard.Team;
+
+import fr.pandacube.lib.players.standalone.StandaloneOffPlayer;
+
+public interface PaperOffPlayer extends StandaloneOffPlayer {
+
+    /*
+     * General data and state
+     */
+
+    @Override
+    default boolean isOnline() {
+        return (getBukkitPlayer() != null);
+    }
+
+
+
+
+    /*
+     * Related class instances
+     */
+
+    @Override
+    PaperOnlinePlayer getOnlineInstance();
+
+    /**
+     * @return l'instance Bukkit du joueur en ligne, ou null si il n'est pas en
+     *         ligne
+     */
+    default Player getBukkitPlayer() {
+        return Bukkit.getPlayer(getUniqueId());
+    }
+
+    /**
+     * Get the Bukkit’s {@link OfflinePlayer} instance for this player.
+     * May represent a player that never joined the server before.
+     * @return an instance of {@link OfflinePlayer} for this player.
+     */
+    default OfflinePlayer getBukkitOfflinePlayer() {
+        return Bukkit.getOfflinePlayer(getUniqueId());
+    }
+
+
+
+
+
+    /*
+     * Display name
+     */
+    /**
+     * Get the display name of the user, in legacy format.
+     * @return the display name of the player.
+     *
+     * @implNote This default implementation gets the display name from bukkit (if the player is online).
+     * If its different to the player name, it returns it. Otherwise, it tries to generate the team displayname with {@link #getTeamDisplayName()}.
+     * If the player is not in a team, then the player name is used.
+     */
+    @Override
+    default String getDisplayName() {
+        String name = getName();
+        Player p = getBukkitPlayer();
+        String bukkitDispName = p != null ? p.getDisplayName() : name;
+        if (!name.equals(bukkitDispName))
+            return bukkitDispName;
+        String teamDispName = getTeamDisplayName();
+        return teamDispName == null ? name : teamDispName;
+    }
+
+    /**
+     * Computes and returns the the name of the player with the prefix, suffix and color of the team the player is in.
+     * @return The legacy formated player display name, if he is in a {@link Team}, or null otherwise.
+     */
+    default String getTeamDisplayName() {
+        String name = getName();
+        Team team = Bukkit.getScoreboardManager().getMainScoreboard().getEntryTeam(name);
+        if (team == null)
+            return null;
+        String teamPrefix = team.getPrefix();
+        String teamSuffix = team.getSuffix();
+        String teamColor = team.getColor().toString();
+
+        return teamPrefix + teamColor + name + teamSuffix;
+    }
+
+}

pandalib-paper-players/src/main/java/fr/pandacub/lib/paper/players/PaperOnlinePlayer.java

@@ -0,0 +1,228 @@
+package fr.pandacub.lib.paper.players;
+
+import java.util.Locale;
+import java.util.UUID;
+
+import com.destroystokyo.paper.ClientOption;
+import com.destroystokyo.paper.ClientOption.ChatVisibility;
+import com.destroystokyo.paper.SkinParts;
+import net.kyori.adventure.audience.MessageType;
+import net.kyori.adventure.identity.Identified;
+import net.kyori.adventure.identity.Identity;
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.ComponentLike;
+import net.kyori.adventure.title.Title;
+import net.kyori.adventure.title.Title.Times;
+import net.kyori.adventure.util.Ticks;
+import org.bukkit.Location;
+import org.bukkit.OfflinePlayer;
+import org.bukkit.Sound;
+import org.bukkit.entity.LivingEntity;
+import org.bukkit.entity.Player;
+import org.bukkit.inventory.MainHand;
+
+import fr.pandacube.lib.players.standalone.StandaloneOnlinePlayer;
+
+public interface PaperOnlinePlayer extends PaperOffPlayer, StandaloneOnlinePlayer {
+
+    /*
+     * General data and state
+     */
+
+    @Override
+    default String getName() {
+        return getBukkitPlayer().getName();
+    }
+
+    @Override
+    default String getWorldName() {
+        return getBukkitPlayer().getWorld().getName();
+    }
+
+
+
+
+    /*
+     * Related class instances
+     */
+
+    /**
+     * @return l'instance Bukkit du joueur en ligne, ou null si il n'est pas en
+     *         ligne
+     */
+    Player getBukkitPlayer();
+
+    @Override
+    default OfflinePlayer getBukkitOfflinePlayer() {
+        return getBukkitPlayer();
+    }
+
+
+
+
+
+    /*
+     * Sending packet and stuff to player
+     */
+
+    @Override
+    default void sendMessage(Component message) {
+        getBukkitPlayer().sendMessage(message);
+    }
+
+    @Override
+    default void sendMessage(ComponentLike message, UUID sender) {
+        getBukkitPlayer().sendMessage(sender == null ? Identity.nil() : Identity.identity(sender), message, MessageType.CHAT);
+    }
+
+    @Override
+    default void sendMessage(Component message, Identified sender) {
+        getBukkitPlayer().sendMessage(sender == null ? Identity.nil() : sender.identity(), message, MessageType.CHAT);
+    }
+
+    @Override
+    default void sendTitle(Component title, Component subtitle, int fadeIn, int stay, int fadeOut) {
+        getBukkitPlayer().showTitle(Title.title(title, subtitle, Times.times(Ticks.duration(fadeIn), Ticks.duration(stay), Ticks.duration(fadeOut))));
+    }
+
+    default void playSound(Sound sound, float volume, float pitch) {
+        playSound(sound, getBukkitPlayer().getLocation(), volume, pitch);
+    }
+
+    default void playSound(Sound sound, Location location, float volume, float pitch) {
+        getBukkitPlayer().playSound(location, sound, volume, pitch);
+    }
+
+
+
+
+
+    /*
+     * Client options
+     */
+
+    @Override
+    PaperClientOptions getClientOptions();
+
+    public abstract class PaperClientOptions implements StandaloneOnlinePlayer.ClientOptions {
+
+        private final PaperOnlinePlayer op;
+
+        public PaperClientOptions(PaperOnlinePlayer op) {
+            this.op = op;
+        }
+
+        @Override
+        public boolean hasChatColorEnabled() {
+            return op.getBukkitPlayer().getClientOption(ClientOption.CHAT_COLORS_ENABLED);
+        }
+
+        public ChatVisibility getChatVisibility() {
+            return op.getBukkitPlayer().getClientOption(ClientOption.CHAT_VISIBILITY);
+        }
+
+        @Override
+        public boolean isChatFullyVisible() {
+            ChatVisibility v = getChatVisibility();
+            return v == ChatVisibility.FULL || v == ChatVisibility.UNKNOWN;
+        }
+
+        @Override
+        public boolean isChatOnlyDisplayingSystemMessages() {
+            return getChatVisibility() == ChatVisibility.SYSTEM;
+        }
+
+        @Override
+        public boolean isChatHidden() {
+            return getChatVisibility() == ChatVisibility.HIDDEN;
+        }
+
+        @Override
+        public Locale getLocale() {
+            return op.getBukkitPlayer().locale();
+        }
+
+        @Override
+        public int getViewDistance() {
+            return op.getBukkitPlayer().getClientViewDistance();
+        }
+
+        public MainHand getMainHand() {
+            return op.getBukkitPlayer().getMainHand();
+        }
+
+        @Override
+        public boolean isLeftHanded() {
+            return getMainHand() == MainHand.LEFT;
+        }
+
+        @Override
+        public boolean isRightHanded() {
+            return getMainHand() == MainHand.RIGHT;
+        }
+
+        @Override
+        public abstract boolean isTextFilteringEnabled(); // needs reflection
+
+        @Override
+        public boolean allowsServerListing() {
+            return op.getBukkitPlayer().isAllowingServerListings();
+        }
+
+        public SkinParts getSkinParts() {
+            return op.getBukkitPlayer().getClientOption(ClientOption.SKIN_PARTS);
+        }
+
+        @Override
+        public boolean hasSkinCapeEnabled() {
+            return getSkinParts().hasCapeEnabled();
+        }
+
+        @Override
+        public boolean hasSkinJacketEnabled() {
+            return getSkinParts().hasJacketEnabled();
+        }
+
+        @Override
+        public boolean hasSkinLeftSleeveEnabled() {
+            return getSkinParts().hasLeftSleeveEnabled();
+        }
+
+        @Override
+        public boolean hasSkinRightSleeveEnabled() {
+            return getSkinParts().hasRightSleeveEnabled();
+        }
+
+        @Override
+        public boolean hasSkinLeftPantsEnabled() {
+            return getSkinParts().hasLeftPantsEnabled();
+        }
+
+        @Override
+        public boolean hasSkinRightPantsEnabled() {
+            return getSkinParts().hasRightPantsEnabled();
+        }
+
+        @Override
+        public boolean hasSkinHatsEnabled() {
+            return getSkinParts().hasHatsEnabled();
+        }
+    }
+
+
+
+
+    /*
+     * Custom damage
+     */
+
+    default void damage(double amount) {
+        getBukkitPlayer().damage(amount); // uses DamageSource.GENERIC
+    }
+
+    default void damage(double amount, LivingEntity source) {
+        getBukkitPlayer().damage(amount, source); // uses appropriate DamageSource according to provided player or entity
+    }
+
+
+}