pMessage (统一消息格式API-使插件消息格式一致)-服务器&插件

SodaMC

潮涌核心

反派

pMessage (统一消息格式API-使插件消息格式一致)

pMessage是一个用于在服务器上实现一致消息格式的API，允许服务器所有已安装的插件以相同的格式发送消息给玩家。这使得你的服务器看起来更专业，因为所有插件都具有相同的格式、布局和样式。

功能

pMessage提供了以下功能：

实现插件消息的一致格式
自定义消息格式
自定义错误、成功和信息的颜色
自定义'无权限'和'必须为玩家'的消息

配置

pMessage的配置文件允许您调整插件消息的外观：

- 'success'、'error'和'info'的值可以是任何颜色代码的名称形式。可以在此链接中查看可接受颜色的列表并使用“Technical Name”列下的值。
- 'format' - 这是消息的整体格式。可以是任何格式，但必须包含'%plugin%'和'%message%'（不带引号）。'%plugin%'将被替换为发送消息的插件的名称，'%message%'将被消息本身替换。在'%message%'前应始终加上&r，以避免消息颜色出现错误。
- 'success' - 这是插件定义为成功消息的所有消息的聊天颜色。默认颜色是绿色。
- 'error' - 这是插件定义为错误消息的所有消息的聊天颜色。默认颜色是红色。
- 'info' - 这是插件定义为信息消息的所有消息的聊天颜色。默认颜色是金色。
- 'no-permission' - 当插件想要通知玩家他们没有权限时发送的消息。此值将在上面设置的'format'中使用，替换'%message%'。
- 'no-player' - 当插件想要通知控制台只有玩家可以执行命令时发送的消息。此值将在上面设置的'format'中使用，替换'%message%'。

用法

以下是使用pMessage的示例：

- /pmessage - 这是该插件的主要（也是唯一）命令。
- /pmessage reload - 重新加载配置文件。
- pmessage.reload - 访问/pmessage reload命令的权限。

使用pMessage非常简单：

在IDE中将pMessage添加到项目中，就像添加Spigot/Craftbukkit jar文件一样。
在您的插件的主类中创建Messenger类的实例：

Messenger msg;
public void onEnable(){
  if(getServer().getPluginManager().isPluginEnabled("pMessage"))
    msg = new Messenger(this);
}

当您希望发送消息时，请调用以下任意方法。所有方法的'receiver'参数都可以接受CommandSender，因此您可以传递控制台或玩家。

msg.needPermission(CommandSender receiver);
msg.needPlayer(CommandSender receiver);
msg.error(CommandSender receiver, String message);
msg.success(CommandSender receiver, String message);
msg.info(CommandSender receiver, String message);
msg.msg(CommandSender receiver, String message, ChatColor colour);
msg.ERROR_COLOR;
msg.INFO_COLOR;
msg.SUCCESS_COLOR;