마인크래프트 플러그인 만들기 3. 명령어 만들기

🥳이번 시간에는 플레이어의 좌표를 보여주는 명령어를 만들어보아요!

⌛시작하기 전에...

최대한 자바 초급자도 플러그인을 만들 수 있도록 작성하고 있습니다.
어려울 수 있는 내용은 더보기 안에 적어두었으니 참고해주세요!

 

⌨️명령어 만들기

---

1. 폴더와 파일 생성하기

이전까지의 폴더 구조는 아래와 같았다.

이전 폴더 구조

여기에 폴더 📁commands 와, 클래스 📄PosCommand를 만들어준다.

새로운 폴더 구조

그럼 다음과 같은 클래스가 생성될 것이다.

package com.tistory.localhost.tutorialplugin.commands;

public class PosCommand {
}

2. 기본 틀 작성하기

여기서 우리는 CommandExecuter를 상속 받아야 한다.
CommandExecuter를 implements 형태로 상속 받기 때문에 CommandExecuter 인스턴스에 정의된 onCommand 메서드를 필수로 구현 해줘야 한다.

명령어를 추가하기 위한 기본적인 코드는 다음과 같다.

package com.tistory.localhost.tutorialplugin.commands;

import org.bukkit.command.Command;
import org.bukkit.command.CommandExecutor;
import org.bukkit.command.CommandSender;

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

onCommand의 매개변수의 기능은 다음과 같다.

매개변수	기능
CommandSender sender	명령어를 실행한 사람
Command command	실행된 명령어
String label	사용된 명령의 별칭 (별칭으로 실행했는지 확인할 수 있다.)
String[] args	전달된 명령어 인자

3. 기능 작성하기

우리가 만들것은 플레이어의 좌표를 보여주는 명령어이다.

구현해야 할 사항은 다음과 같다.

 

1. 콘솔에서 명령어를 사용할 수 없게 한다. (콘솔은 좌표가 없으니까...)
2. 플레이어의 좌표를 구한다.
3. 구한 좌표를 플레이어에게 보내준다.

1. 콘솔에서 실행했을 때 처리하기

if(!(sender instanceof Player)){ // 명령어를 사용한 사람이 플레이어가 아니라면
    sender.sendMessage("이 명령어는 콘솔에서 실행할 수 없습니다!"); // 라고 보내기
    return true; // 종료
}

false를 return하면 plugin.yml에 등록된 명령어의 사용법을 반환한다.
따라서 일반적으로는 true를 return 해줘야한다.

2. 플레이어 좌표 구하기

Player p = (Player) sender;
Location location = p.getLocation();
int x = location.getBlockX();
int y = location.getBlockY();
int z = location.getBlockZ();

3. 플레이어에게 좌표를 메세지로 보내기

String msg = String.format("[ 좌표 ] x : %d y : %d z : %d", x, y, z);
p.sendMessage(msg);

🪄전체 코드

package com.tistory.localhost.tutorialplugin.commands;

import org.bukkit.Location;
import org.bukkit.command.Command;
import org.bukkit.command.CommandExecutor;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;

public class PosCommand implements CommandExecutor {
    @Override
    public boolean onCommand(CommandSender sender, Command command, String label, String[] args) {
        if (!(sender instanceof Player)) {
            sender.sendMessage("이 명령어는 콘솔에서 실행할 수 없습니다!");
            return true;
        }
        Player p = (Player) sender;
        Location location = p.getLocation();
        int x = location.getBlockX();
        int y = location.getBlockY();
        int z = location.getBlockZ();
        String msg = String.format("[ 좌표 ] x : %d y : %d z : %d", x, y, z);
        p.sendMessage(msg);
        return true;
    }
}

➕명령어 등록하기

---

1. plugin.yml에 등록하기

plugin.yml 파일은 아래와 같은 경로에 있다.

plugin.yml 경로 스크린샷

해당 파일에 다음과 같은 코드를 추가해준다.

commands:
  pos:
    usage: /<command>
    description: 플레이어의 좌표를 보여줍니다.
    aliases:
      - 좌표

키	값
pos	명령어의 이름
usage	명령어 사용법. <command>는 명령어 이름으로 대체된다. 따라서, 여기에서는 /pos가 된다.
description	명령어 설명
aliases	명령어 별칭 ("/좌표" 라고 실행해도 똑같이 실행된다.)

🪄전체 코드

name: Tutorialplugin
version: '${version}'
main: com.tistory.localhost.tutorialplugin.Tutorialplugin
api-version: 1.19
description: this is a tutorial plugin
commands:
  pos:
    usage: /<command>
    description: 플레이어의 좌표를 보여줍니다.
    aliases:
      - 좌표

2. onEnable()에 등록하기

1편에서 배운 onEnable()에 다음과 같은 코드를 추가해준다.

getCommand("pos").setExecutor(new PosCommand());

"pos"는 명령어 이름이고, PosCommand()는 해당 명령어를 구현해놓은 클래스다.

🪄전체 코드

package com.tistory.localhost.tutorialplugin;

import com.tistory.localhost.tutorialplugin.commands.PosCommand;
import org.bukkit.plugin.java.JavaPlugin;

public final class Tutorialplugin extends JavaPlugin {

    @Override
    public void onEnable() {
        // Plugin startup logic
        getLogger().info("플러그인 로딩됨.");
        getCommand("pos").setExecutor(new PosCommand());

    }

    @Override
    public void onDisable() {
        // Plugin shutdown logic
        getLogger().info("플러그인 종료됨.");
    }
}