命令 - Command

注:从本章开始将会减少图片,将会以代码的形式讲解,实际还是要大家去实践...

学习目标:

如何注册命令(理解)
如何重写JavaPlugin中的onCommand方法来做到命令处理(理解)
如何在一个独立类中作为命令处理类(理解，重点)

如何注册命令

注册命令的方式有几种

利用plugin.yml添加指令
利用PlayerCommandProcessEvent直接处理
利用反射添加指令

这里我只讲解利用 plugin.yml 添加命令,那么我们来看下面的代码

name: Tutorial1
main: cc.zoyn.tutorial1.Tutorial1
version: 1.0
author: Zoyn

这是一段我们在第一个插件当中写的 plugin.yml 那么我们在 author: Zoyn 的下面写上以下内容

commands:
  demo: #指令名
    description: "测试指令" #指令的注解
    usage: /demo #指令的用法 当onCommand()方法返回false时提示这里的内容
    aliases: [d,de] #指令的多种形式 意为可以用 d, de 来触发/demo这个指令
    permission: "demo.use" #指令所需要的权限
    permission-message: "无权使用" #当输入者无上方权限时提示该信息

那么这样我们就注册好了一个指令叫 demo
注意 demo: 之后的内容都是选写

如何重写JavaPlugin中的onCommand方法来做到命令处理(理解)

那么有了上面启发,那么我们就可以开始写对于指令的处理了
首先我们转到主类,重写 JavaPlugin 当中的 onCommand() 方法

package cc.zoyn.tutorial1;

import org.bukkit.command.Command;
import org.bukkit.command.CommandSender;
import org.bukkit.plugin.java.JavaPlugin;

public final class Tutorial1 extends JavaPlugin {

  @Override
  public void onEnable() {
    getLogger().info("onEnable has been invoked!");
  }

  @Override
  public boolean onCommand(CommandSender sender, Command command, String label, String[] args) {
    return false;
  }
}

那么我们来解析一下这个命令里面的参数
划重点
sender -> 命令发送者
command -> 命令的对象
label -> 命令发送者实际输入的指令
args -> 命令后所跟的参数 如/demo a b c 则后面的 a b c 就是args对应过来的 args[0],args[1],args[2]
那么我们要怎么判断好一个指令呢? 我们可以做如下操作

@Override
public boolean onCommand(CommandSender sender, Command command, String label, String[] args) {
  if (command.getName().equalsIgnoreCase("demo")) { // 判断输入的指令是否是 /demo
    if (!(sender instanceof Player)) { // 判断输入者的类型 为了防止出现 控制台或命令方块 输入的情况
      sender.sendMessage("你必须是一名玩家!");
      return true; // 这里返回true只是因为该输入者不是玩家,并不是输入错指令,所以我们直接返回true即可
    }
    // 如果我们已经判断好sender是一名玩家之后,我们就可以将其强转为Player对象,把它作为一个"玩家"来处理
    Player player = (Player) sender;
    player.sendMessage("你成功的执行了指令/demo");
    return true; // 返回true防止返回指令的usage信息
  }
  return false;
}

但是你会发现无法使用

这是什么原因呢？其实是 Bukkit 需要开发者做一个注册的操作, 那么我们在 onEnable() 方法键入以下代码

Bukkit.getPluginCommand("demo").setExecutor(this);

完整代码:

package cc.zoyn.tutorial1;

import org.bukkit.command.Command;
import org.bukkit.command.CommandSender;
import org.bukkit.plugin.java.JavaPlugin;

public final class Tutorial1 extends JavaPlugin {

  @Override
  public void onEnable() {
    getLogger().info("onEnable has been invoked!");
    Bukkit.getPluginCommand("demo").setExecutor(this);
  }

  @Override
  public boolean onCommand(CommandSender sender, Command command, String label, String[] args) {
    if (command.getName().equalsIgnoreCase("demo")) { // 判断输入的指令是否是 /demo
      if (!(sender instanceof Player)) { // 判断输入者的类型 为了防止出现 控制台或命令方块 输入的情况
        sender.sendMessage("你必须是一名玩家!");
        return true; // 这里返回true只是因为该输入者不是玩家,并不是输入错指令,所以我们直接返回true即可
      }
      // 如果我们已经判断好sender是一名玩家之后,我们就可以将其强转为Player对象,把它作为一个"玩家"来处理
      Player player = (Player) sender;
      player.sendMessage("你成功的执行了指令/demo");
      return true; // 返回true防止返回指令的usage信息
    }
    return false;
  }
}

那么我相信通过上方的代码你已经可以领悟对于命令的处理了

如何在一个独立类中作为命令处理类(理解，重点)

现在我们创建一个类叫做 CommandHandler, 并且让它实现 CommandExcutor 接口

public class CommandHandler implements CommandExecutor {

}

之后我们让它实现方法 onCommand

public class CommandHandler implements CommandExecutor {
  @Override
    public boolean onCommand(CommandSender sender, Command cmd, String label, String[] args) {
        return false;
    }
}

那么接下来的我就不用多说了, 还需要提的就是注册命令时你需要改成这样

Bukkit.getPluginCommand("demo").setExecutor(new CommandHandler());

Bukkit插件开发教程 - 命令