UpdateDisplayName

插件

· 作者 jandie1505

将玩家显示名称和标签页名称更新为指定格式。 支持 MiniMessage、Luckperms、Vault、PlaceholderAPI。 提供开发者 API。

0 本站下载 0 关注 更新于 3 个月前

最新 1.1-RELEASE · 26.2 · Paper

一键开服(送7天)

UpdateDisplayNames

概述

UpdateDisplayNames 是一个 Paper 插件,可自动将玩家的显示名称和标签页名称更新为指定格式。

功能

  • 支持 LuckPerms、Vault 和 PlaceholderAPI
  • 占位符中同时支持 MiniMessage 和传统颜色代码
  • 提供 API,允许从显示名称更新中排除特定玩家

安装方法

要安装此插件,请从发布页面下载对应 Minecraft 版本的插件文件,并将其放入你的 plugins 目录中。

命令

命令 描述 权限
/updatedisplayname reload 重载配置。 updatedisplayname.command
/updatedisplayname update-players 更新所有玩家的名称。 updatedisplayname.command
/updatedisplayname update-sorting 更新标签页排序。 updatedisplayname.command
/updatedisplayname enabled [true|false] 启用/禁用插件功能。 updatedisplayname.command
/updatedisplayname playerlist 显示排除列表。 updatedisplayname.command

配置

配置文件

若要更改前缀或其他值,可以在 plugins/UpdateDisplayName/config.yml 中进行修改:

# 更新显示名称配置文件

# ----- 常规部分 -----

# 名称更新的间隔时间(秒)(默认值:60)。
# 设置为 < 0 以禁用自动更新。
# 禁用后,玩家仅在加入时更新名称。
update_interval: 30

# ----- 显示名称部分 -----

displayname:
  # 启用更新显示名称。
  # 玩家的显示名称会在除标签页之外的所有地方显示。
  enable: true
  # 在此处设置显示名称格式。
  # 该字段的格式说明见“名称格式配置”。
  format: '<luckperms:prefix><player><luckperms:suffix>'
  
# ----- 标签页部分 -----

tablist:
  name:
    # 启用更新标签页名称。
    # 标签页名称是在标签页中显示的名称。
    # 它与在其他所有地方显示的玩家的显示名称不同。
    enable: true
    # 在此处设置标签页名称格式。
    # 该字段的格式说明见“名称格式配置”。
    format: '<luckperms:prefix><player><luckperms:suffix>'
  sort:
    # 启用使用标签页排序权限的标签页排序功能。
    enable: true
    # 最高的标签页排序等级。
    # 高于此等级的等级将被忽略。
    max_level: 9

由于配置文件在首次启动时自动生成,配置值的顺序可能略有不同(但值本身是一样的)。

自动生成的配置文件(即安装插件后看到的配置文件)中的字符串没有引号。建议对较长的字符串值(如 displayname.format 和 tablist.name.format)使用引号("" 或 '')。

警告: 如果你已经有来自版本 1.0 的配置文件,则需要更新你的配置。 tablist 部分已更改,插件会对未设置的配置选项使用默认值。

名称格式配置

本节解释如何配置 format 选项。

请注意,此格式不支持传统颜色代码。你必须使用 MiniMessage。别担心,这很简单:

  • &0 = <black>,&1 = <dark_blue>,&2 = <dark_green>,等等...
  • &l = <bold>,&m = <strikethrough>,&n = <underline>,&r = <reset>,等等...

更多信息:MiniMessage 文档
占位符同时支持 MiniMessage 和传统颜色代码。

可用的占位符:

  • LuckPerms: <luckperms:prefix> <luckperms:suffix> <luckperms:group>
  • Vault: <vault:prefix> <vault:suffix> <vault:group>
  • PlaceholderAPI: <papi:PLACEHOLDER>

使用 API

导入

使用 Gradle:

repositories {
    maven("https://maven.chaossquad.net/releases")
}

dependencies {
    compileOnly("net.jandie1505:UpdateDisplayName:1.0-RELEASE")
}

使用 Maven:

<repository>
  <id>ChaosSquad-Repository-releases</id>
  <name>ChaosSquad Repository</name>
  <url>https://maven.chaossquad.net/releases</url>
</repository>
<dependency>
  <groupId>net.jandie1505</groupId>
  <artifactId>UpdateDisplayName</artifactId>
  <version>1.0-RELEASE</version>
  <scope>provided</scope>
</dependency>

用法

public class ApiExampleClass {

    /**
     * 通用功能。
     */
    public void ApiExample() {
        UDNApi api = UpdateDisplayName.getApi();

        Player player = Bukkit.getPlayer("playername");

        boolean updatesEnabled = api.isUpdatesEnabled(); // 获取插件功能状态
        api.setUpdatesEnabled(false); // 禁用插件功能

        api.updatePlayers(); // 更新所有玩家的显示名称
        api.updatePlayer(player); // 更新指定玩家的显示名称

        Set<UUID> excludedPlayers = api.getExcludedPlayers(); // 获取被排除的玩家
        boolean excluded = api.isPlayerExcluded(player); // 检查玩家是否被排除

        DataStorage config = api.getPluginConfig(); // 获取插件配置

```java
// 获取配置值
        boolean enableDisplaynameUpdate = config.optBoolean(UpdateDisplayname.CONFIG_ENABLE_DISPLAYNAME, false);
        String displayNameFormat = config.optString(UpdateDisplayName.CONFIG_FORMAT_DISPLAYNAME, null);
        boolean enableTablistName = config.optString(UpdateDisplayName.CONFIG_ENABLE_TABLIST_NAME, false);
        String tablistFormat = config.optString(UpdateDisplayName.CONFIG_TABLIST_FORMAT, null);
        int updateInterval = config.optInt(UpdateDisplayName.CONFIG_UPDATE_INTERVAL, 60);

        // 设置配置值
        config.set(UpdateDisplayName.CONFIG_ENABLE_DISPLAYNAME, true);
        config.set(UpdateDisplayName.CONFIG_FORMAT_DISPLAYNAME, "<luckperms:prefix><player><luckperms:suffix>");
        config.set(UpdateDisplayName.CONFIG_ENABLE_TABLIST_NAME, true);
        config.set(UpdateDisplayName.CONFIG_TABLIST_FORMAT, "<luckperms:prefix><player><luckperms:suffix>");
        config.set(UpdateDisplayName.CONFIG_UPDATE_INTERVAL, 60);
    }

    /**
     * 更新显示名称事件。
     */
    @EventHandler
    public void onDisplayNameUpdated(DisplayNameUpdatedEvent event) {

        if (event.getPlayer().getName().equals("forbiddenName")) {
            event.setCancelled(true);
            return;
        }

        if (event.getUpdatedDisplayName() == null) {
            Bukkit.broadcast(Component.text("玩家 " + event.getPlayer().getName() + " 的显示名称已重置"));
            return;
        }

        Bukkit.broadcast(Component.empty()
            .append(Component.text("玩家 " + event.getPlayer().getName() + " 的更新后显示名称:"))
            .append(event.getUpdatedDisplayName())
        );

    }

    /**
     * 更新标签页列表名称事件。
     */
    @EventHandler
    public void onDisplayNameUpdated(TablistNameUpdatedEvent event) {

        if (event.getPlayer().getName().equals("PleaseDontGiveMeATablistName")) {
            event.setCancelled(true);
            return;
        }

        if (event.getUpdatedTablistName() == null) {
            Bukkit.broadcast(Component.text("玩家 " + event.getPlayer().getName() + " 的标签页列表名称已重置"));
            return;
        }

        Bukkit.broadcast(Component.empty()
            .append(Component.text("玩家 " + event.getPlayer().getName() + " 的更新后标签页列表名称:"))
            .append(event.getUpdatedTablistName())
        );

    }
}

JavaDocs

点击 此处 访问 JavaDocs。

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源