문서 보기문서 편집수정 내역 마인크래프트/플러그인/개발 (r0 버전으로 되돌리기) [include(틀:상위 문서, top1=마인크래프트/플러그인)] [include(틀:관련 문서, top1=마인크래프트/개발, top2=마인크래프트/모드/개발)] [include(틀:마인크래프트/관련 문서)] [목차] == 개요 == 본 문서는 [[마인크래프트/버킷|마인크래프트 서버]]에 사용되는 [[마인크래프트/플러그인|플러그인]] 개발에 도움을 주고자 생성되었다. 또한, 내용은 영상 촬영일 및 문서 작성일[* 처음 작성하신 분이 튜토리얼을 위해 [[유튜브]] 영상을 촬영하여 업로드하였다.] 기준인 {{{#jdk 1.8.0_91}}}과 {{{craftbukkit-1.9.4}}}를 기반으로, 코드 및 전반 내용은 [[http://wiki.bukkit.org/Main_Page|Bukkit Wiki]]와 [[https://www.spigotmc.org/wiki/spigot/|SpigotMC Wiki]], [[https://hub.spigotmc.org/javadocs/bukkit/|Bukkit API]], [[https://hub.spigotmc.org/javadocs/spigot/|Spigot API]]를 기반으로 작성되었다. 만약 마인크래프트 '''모드''' 개발을 찾아왔다면 [[마인크래프트/모드/개발|모드 개발]] 문서를 참고하라. 모드를 만드는 프로그램은 있지만 플러그인을 만드는 프로그램은 없다. 이 때문에 유저들 중 플러그인 개발을 시도하다 포기하는 경우가 많다.[* 모드 제작 프로그램인 MCreator에 Spigot Generator 유저 플러그인을 설치하면 스피곳용 플러그인 제작이 가능하다. 단, 개발 중인 프로젝트이므로 지원하는 기능이 불완전하다.] == 편집 지침 == 플러그인 코딩에 사용되는 소스 코드는 [[http://colorscripter.com/|Color Scripter]]의 Java 기능을 이용해 작성하시길 바랍니다. 만약 [[나무위키]]에서 [[HTML]] 지원이 종료될 경우, 테이블(표) 기능을 이용해 대체하면 됩니다. == 도입 == === [[마인크래프트/플러그인|플러그인]] 이란? === > 플러그인(Plug-in; PIN)은 호스트 프로그램과 상호작용하는 컴퓨터 소프트웨어이다. 위에서 정의한 내용이 "플러그인"의 원래 정의이며, [[마인크래프트]]에서 정의하는 플러그인은 >서버에 부가 기능을 추가하여 커맨드, 이벤트, 내부 연산 등을 통해 게임 내부에 새로운 요소를 추가하는 것 을 의미한다. 플러그인을 활용한 예로는 게임 화폐 추가, 미니게임 개발, 새로운 커맨드 추가 등이 있다. 게임 클라이언트와 서버에 범용적으로 적용되는 '''[[마인크래프트/모드#Universal|Universal]] 모드'''와는 다르게, 바닐라 서버의 동작을 조작하는 것이 플러그인이다. 즉, 서버 측 모드라고 볼 수 있다. Universal로 분류된 모드와 비교하면, 서버 관리자가 플러그인을 추가해도 접속하는 유저들이 덩달아 같은 플러그인을 설치할 필요가 없는 이점이 있지만, 싱글 플레이나 LAN 서버, [[렐름|Realms]] 서버에서 사용할 수 없다는 단점이 있다. === 기초적인 지식 === * 기본적인 [[마인크래프트]] 지식 * [[Java]][* 물론 [[Java]]에 대해 아무것도 몰라도 만들 수는 있다. 그러나 [[스파게티 코드|결과가 영 좋지 않을 것이다...]]]와 [[객체 지향 프로그래밍]]에 대한 지식 * [[영어]] 독해력 (구글링 할 때 원문 검색을 자주 하게 된다.) * 플러그인 API의 구조 이해 및 활용력 == 준비 == === [[통합 개발 환경|통합 개발 환경(IDE)]] 설치 === 여긴 [[IntelliJ IDEA]]보다는 Eclipse IDE 위주의 설명이 많으니 Eclipse IDE를 설치 바란다. ==== 구버전 [[Eclipse]] (Mars 버전 이전; 미설치형) ==== [youtube(iiSh2fLfECc,width=400,height=300)] 자동 설치기가 있고 구버전을 사용할 이유도 없기 때문에 이 방법은 권장하지 않는다. ==== 신버전 [[Eclipse]] (Mars.1 버전 이후; 설치형) ==== [youtube(POP1xvkXOu0)] 빠르게 이클립스를 설치하는 등의 이유가 있을 때는 최신버전도 미설치형으로 사용 가능하다. ==== 신버전 [[Eclipse]] (Mars.1 버전 이후; 미설치형) ==== 이클립스 Mars 이후에도 미설치형으로 사용하는 것이 가능하다. 1. 우선 이클립스 다운로드 파일이 있는 페이지로 가야한다. [[http://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/oxygen1a|#]] 2. 왼쪽에서 다운 받을 버전을 선택한다. 3. 다운로드 가능한 zip 파일이 뜬다. 필요한 것을 다운로드 하자. (플러그인 개발에는 Java와 Java EE중 하나를 하면 된다.) ==== IntelliJ IDEA ==== Intellij IDEA는 이클립스보다 무겁지만 훨씬 더 많은 편의 기능을 제공한다. [[https://www.jetbrains.com/ko-kr/idea/download/#section=windows|#]]에서 다운로드할 수 있다.[* Ultimate는 유료이므로 Community Edition을 선택하자.] === [[Java]] Development Kit (JDK) 설치 === [youtube(9vIrrZrYpDQ,width=400,height=300)] 마인크래프트 1.16까지의 경우 JDK는 최소 8이여야 한다. 흔히 쓰는 JDK로는 JDK 8, JDK 11과 JDK 16이 있다. '''주의할 점으로, 1.17부터는 JDK 16, 1.18부터는 JDK 17을 사용해야 한다.''' == 첫 프로젝트 만들기 == === Eclipse === ==== 이클립스 실행 ==== [[파일:플러그인 개발 - 이클립스 폴더.png|width=50%]] 위의 사진처럼 {{{eclipse.exe}}}를 더블 클릭하여 실행한다. ==== 작업공간(Workspace) 설정 ==== [[파일:플러그인 개발 - 이클립스 Workspace 설정.png|width=50%]] 후에 생성할 프로젝트의 저장 공간을 설정하면 된다. ==== 프로젝트 만들기 ==== 이 문단에서는 Java EE 개발 환경을 Java SE 개발 환경으로 변경하는 과정을 생략했다. 이는 우측 상단 '''Open Perspective''' 버튼을 눌러 '''Java'''를 선택한 다음 OK를 눌러주면 된다. 이 과정은 '''제일 중요하고 제일 기초적인''' 부분이며, 공통적으로 사용되기 때문에 각 과정에서 생략한다. [[파일:플러그인 개발 - 새 프로젝트 만들기.png|width=50%]] 프로젝트는 '''File - New - Java Project''' 또는 '''[[https://www.google.co.kr/search?q=eclipse+new+project+icon&espv=2&biw=1680&bih=925&tbm=isch&imgil=IkipTGhXnaJ_8M%253A%253BoYxBbpDEvljPfM%253Bhttp%25253A%25252F%25252Ffornwall.net%25252Feclipsecoder%25252F&source=iu&pf=m&fir=IkipTGhXnaJ_8M%253A%252CoYxBbpDEvljPfM%252C_&usg=__dLSSSTEWwODddwP2e23bjm7tF4U%3D&ved=0ahUKEwipkb6fqqXOAhUBzpQKHev3DTsQyjcIOQ&ei=qe6hV-mYFYGc0wTr77fYAw#imgrc=IkipTGhXnaJ_8M%3A|New (추가 아이콘)]] - Java Project'''를 통해 생성할 수 있다. [[파일:플러그인 개발 - 프로젝트 선택.png|width=50%]] 이는 '''Java EE''' 환경에서 일반 프로젝트를 생성했을 때 또는 '''Java SE''' 환경에서 New 아이콘만 클릭했을 때 설정한다. [[파일:플러그인 개발 - 프로젝트 설정.png|width=50%]] Project Name은 '''한글'''로 해도 상관은 없으나, '''패키지명에 프로젝트 명을 포함시킬 생각'''[* 기본적으로 패키지는 '''상위 클래스명.상속 클래스명(기본적으로 com.<제작자명>.프로젝트 명)'''을 사용하는 것이 관례이다.]이라면 띄어쓰기를 하지 않는 것이 좋다. == [[마인크래프트/서버/자바 에디션#s-7.2|Bukkit API]] 외부 라이브러리 다운로드 == 서버를 실행할 때 사용되는 "Craftbukkit-1.8.9-R0.2.jar"와 같은 파일을 '''외부 라이브러리'''라고 한다. 이 파일을 이클립스를 통해 플러그인에 적용시켜야 정상적인 코딩이 가능하고, 서버에 적용시킬 수 있다. 다운로드 방법은 크게 2가지로 나뉜다. 첫번째로, 권장되는 방법은 [[Gradle]]을 사용하여 Paper API를 다운로드하는 것이다. 두번째로는 '''SpigotMC'''의 BuildTools를 이용하여 Spigot과 Craftbukkit을 동시에 다운로드하는 방법[* 이 방법은 Git으로부터 코드를 컴파일하여 내려받는 방법을 사용하기 때문에 다운로드 속도가 느릴 수 있다.]이 있다. 각 방법은 하위 문단에서 자세히 설명한다. === [[Gradle]]을 사용한 Paper API 다운로드 === === SpigotMC의 BuildTools를 이용한 다운로드 === > 본 문서의 내용 일부는 [[https://www.spigotmc.org/wiki/buildtools/|SpigotMC Wiki의 BuildTools 항목]]에서 가져왔음을 알립니다. 과거의 CraftBukkit DMCA Takedown 사건 이후로 CraftBukkit 기반의 프로그램을 직접 배포하는 것은 불법이 되었다. SpigotMC에서는 이를 우회하기 위해 '''BuildTools'''라는 프로그램을 만들었다. BuildTools를 이용해 파일을 다운로드하기 위해 다음의 파일들을 다운로드하자. * '''BuildTools.jar''': SpigotMC에서 제공하는 DMCA 우회 프로그램 [[https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar|BuildTools 다운로드 (자동 다운로드)]] * '''Java Development Kit 17''': Java 코드 컴파일러 및 Jar 생성[* 자바 개발자용 도구; 이하 "jdk"] [[https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html|JDK 17 다운로드]] * '''Git''': Git 및 Linux 환경 에뮬레이션 용도[* 윈도우 환경에만 해당. 리눅스 환경에서는 터미널에서 바로 실행시킬 수 있다.] [[https://git-for-windows.github.io/|Git 다운로드]] 준비물의 준비가 모두 끝났으면 아래와 같은 순서를 통해 진행하자. 1. BuildTools를 다운로드하여 '''폴더 경로에 띄어쓰기나 특수문자가 없는 폴더'''[* 예를 들어 C:\BuildTools 또는 D:\BuildTools 등]에 저장 또는 옮긴다. 1. 해당 폴더로 이동하여 빈 공간에 커서를 옮기고 '''Shift + 우클릭'''을 이용해 팝업 메뉴를 소환합니다. 그리고 '''Git Bash Here'''를 클릭하여 Git Bash를 실행한다. 1. 콘솔에 {{{java -jar BuildTools.jar --rev <원하는 마인크래프트 버전>}}}를 입력하고 '''엔터'''를 누른다.[* {{{-jar}}}에는 하이픈이 1개, {{{--rev}}}에는 하이픈이 2개임에 주의한다. 지원하는 마인크래프트 버전의 목록은 [[https://www.spigotmc.org/wiki/buildtools/#versions|#]]에서 확인할 수 있다. 또한 {{{--rev <버전>}}}을 생략하면 가장 최근에 출시된 '''안정화된 버전'''을 다운로드하는데, 이는 최신 버전과는 다르므로 이에 유의하자.] 1. 컴파일이 완료될 때까지 '''콘솔을 종료하지 말고''' 기다린다. 1. 빌드가 끝나면[* 빌드 종료 시 Build success! 메시지와 함께 BuildTools가 종료된다.] target 폴더에 '''Craftbukkit'''과 '''Spigot'''이 컴파일된 것을 확인할 수 있다. 예시로, {{{java -jar BuildTools.jar --rev 1.12.2}}}를 입력하여 1.12.2 버전의 Craftbukkit과 Spigot을 다운로드할 수 있다. == [[마인크래프트/서버/자바 에디션#s-7.2|Bukkit API]] 외부 라이브러리 적용하기 == 마인크래프트 플러그인은 외부 라이브러리가 없으면 적용되지 않습니다. '''무조건''' 등록해 주셔야 합니다. [[파일:플러그인 개발 - Properties 메뉴.png|width=50%]] [[파일:플러그인 개발 - Properties.png|width=50%]] [[파일:플러그인 개발 - Jar 파일 선택.png|width=50%]] '''프로젝트 우클릭 - Build Path... - Configure Build Path... - Libraries 탭으로 이동 - Add External JARs...'''를 사용하면 빠르게 등록 및 제거하실 수 있습니다. === 패키지와 클래스 생성 === 패키지(Package)의 역할은 클래스(Class)를 단위 또는 그룹별로 모으는 역할과 클래스의 위치를 알려주는 역할을 합니다. [[파일:플러그인 개발 - 패키지 메뉴.png|width=50%]] 패키지는 '''(프로젝트가 선택된 상태에서) File - New - Package''' 방법, '''프로젝트 우클릭 - New - Package''' 방법, [[https://www.google.co.kr/search?q=eclipse+new+package+icon&espv=2&biw=1680&bih=925&source=lnms&tbm=isch&sa=X&ved=0ahUKEwjH59HpraXOAhWKipQKHWHqAUEQ_AUIBigB#imgrc=n4AeS35Yy5g1CM%3A|패키지 추가 아이콘]] 방법의 세 가지 방법을 사용할 수 있습니다. [[파일:플러그인 개발 - 패키지.png|width=50%]] 패키지 이름은 프로젝트와 다르게 '''무조건 영어'''로 입력하여야 합니다. 후에 입력할 {{{plugin.yml}}} 파일에서 메인 클래스를 찾지 못하는 상황이 발생할 수 있습니다. 또한, 프로젝트 이름과 달리 절대 '''띄어쓰기'''를 하면 안 됩니다. 또한 통상적으로 [[Java]] 개발 시 패키지는 다음과 같은 규칙을 이용합니다. > 최상위 클래스명(대부분 com, org, net 등)'''.'''제작자명'''.'''프로젝트 이름 굳이 위의 규칙을 지키지 않아도 프로그래밍 및 컴파일 시에는 문제되지 않습니다. 클래스(Class)는 Java에서 컴파일 후 실행할 명령들이 ~~코드로~~ 담긴 문서라고 생각하시면 됩니다. [[파일:플러그인 개발 - 클래스 메뉴.png|width=50%]] 클래스는 패키지와 비슷하게 '''(프로젝트가 선택된 상태에서) File - New - Class''' 방법, '''프로젝트 우클릭 - New - Class''' 방법, [[https://www.google.co.kr/search?q=eclipse+new+package+icon&espv=2&biw=1680&bih=925&source=lnms&tbm=isch&sa=X&ved=0ahUKEwjH59HpraXOAhWKipQKHWHqAUEQ_AUIBigB#tbm=isch&q=eclipse+new+class+icon&imgrc=g3HNNZnIL-z5YM%3A|클래스 추가 아이콘]] 방법의 세 가지 방법을 사용할 수 있습니다. [[파일:플러그인 개발 - 클래스.png|width=50%]] 클래스 이름을 작성할 때에도 '''무조건 영어'''로 작성하여야 하며, 굳이 대문자를 사용하지 않아도 됩니다. 또한, 메인 클래스의 이름은 '''Main'''이 아닌 '''자신의 플러그인의 이름'''으로 사용해도 됩니다. (예: MyPlugin.java, YourPlugin.java 등) 클래스도 패키지와 마찬가지로 절대 '''띄어쓰기'''를 하면 안 됩니다. === 코드 작성 === [[파일:플러그인 개발 - 메인 클래스 코드 작성.png|width=75%]] {{{#!syntax java package main; import org.bukkit.Bukkit; import org.bukkit.ChatColor; import org.bukkit.plugin.java.JavaPlugin; public class Main extends JavaPlugin{ @Override public void onEnable(){ Bukkit.getConsoleSender().sendMessage(ChatColor.BLUE + "플러그인이 활성화 되었습니다."); } @Override public void onDisable(){ Bukkit.getConsoleSender().sendMessage(ChatColor.RED + "플러그인이 비활성화 되었습니다."); } } }}} [br] [[파일:플러그인 개발 - 파일 추가 메뉴.png|width=50%]] [[파일:플러그인 개발 - plugin.yml 파일.png]] [[파일:플러그인 개발 - plugin.yml 에디터 선택.png]] [[파일:플러그인 개발 - plugin.yml 에디터 선택2.png]] [[파일:플러그인 개발 - plugin.yml 작성.png|width=75%]] ||<-2><bgcolor=#000000><table width=100%> '''{{{#white 코드}}}''' || ||<width=20%><bgcolor=#616161> {{{#white 파일명}}} || plugin.yml || ||<width=20%><bgcolor=#616161> {{{#white 종류}}} || [[YAML]] || ||<-2>{{{#!html <!-- HTML generated using hilite.me --><div style="background: #ffffff; overflow:auto;width:auto;border:solid gray;border-width:.1em .1em .1em .8em;padding:.2em .6em;"><pre style="margin: 0; line-height: 125%">name: FirstMinecraftPlugin version: 1.0 author: Devonnuri description: My First Minecraft Plugin main: main.Main </pre></div> }}}|| ||name||'''플러그인의 이름 (필수, 공백 없이)'''|| ||version||'''플러그인의 버전 (필수)'''|| ||main||'''플러그인의 메인 클래스 (필수)'''|| ||author||플러그인의 저자|| ||description||플러그인의 설명|| [br] == 명령어 입력 받기 == {{{#!syntax java public class 클래스명 implements CommandExecutor { @Override public boolean onCommand(CommandSender sender, Command command, String label, String[] args) { 코드입력 } } }}} JavaPlugin을 상속받은 곳에서 {{{#!syntax java getCommand("명령어이름").setExecutor(클래스); }}} ~~프로젝트에 쓰고있는거 복붙~~ 주의할 점은 반드시 plugin.yml에서 getCommand에 사용할 명령어를 정의해주어야 한다. 정의해주지 않을 시에는 NullPointerException 에러가 발생한다. == 제목 표시하기 == [[파일:플러그인 개발 - Title 테스트.png|width=75%]] 이런 걸 표시해봅시다. {{{#!syntax java public class 클래스명 { public void sendTitle(Player player, String title, int FadeInTime, int ShowTime, int FadeOutTime){ CraftPlayer p = (CraftPlayer)player; PlayerConnection c = p.getHandle().playerConnection; IChatBaseComponent TitleText = ChatSerializer.a(title); Packet<?> Length = new PacketPlayOutTitle(EnumTitleAction.TIMES, TitleText, FadeInTime*20, ShowTime*20, FadeOutTime*20); Packet<?> TitlePacket = new PacketPlayOutTitle(EnumTitleAction.TITLE, TitleText, FadeInTime*20, ShowTime*20, FadeOutTime*20); c.sendPacket(TitlePacket); c.sendPacket(Length); } } }}} {{{#red 주의}}}: 패킷을 사용하면 nms 패키지를 참조하게 되고, 버전이 바뀔 때마다 패킷 구조가 바뀌므로 권장하지 않습니다. 아래는 spigot api에서 제공하는 타이틀 메소드입니다. {{{#!syntax java player.sendTitle ("제목 메시지", "부제목 메시지", 나타나는 시간, 화면에 머무는 시간, 사라지는 시간); /*제목 메시지나 부제목 메시지를 없에려면 null을, 시간을 기본값으로 설정하려면 -1을 대입하면 됩니다. 시간 기본값은 왼쪽부터 10틱, 70틱, 20틱 입니다.*/ }}} == 팁 == * [[https://hub.spigotmc.org/javadocs/bukkit/]]에서 레퍼런스를 보실 수 있습니다. 레퍼런스를 볼 능력이 요구됩니다. * [[Java]]나 [[객체 지향 프로그래밍]]을 잘 모르셔도 간단한 플러그인의 경우 그렇게 문제가 되지는 않습니다. 그러나, 미리 Java의 기본을 익히고 오는 것이 '''매우 강력히 권장됩니다.''' * 이 문서에서 다루는 버킷 외에 Spigot에 대해 관심이 있다면 [[https://hub.spigotmc.org/javadocs/spigot|이 곳]]을 확인하세요. * 이클립스는 단축키가 지원됩니다. 대표적으로 많이 쓰이는 단축키들입니다. ||Ctrl+Shift+F || 자동 정렬 || ||Ctrl+Space || 자동 완성 || ||Ctrl+Shift+O || 자동 import문 추가 || == Bukkit API 레퍼런스 == ## 이 레퍼런스는 코드에 링크되어 있을 수 있으니 anchor로 이어져 있어야 합니다. 이 문단은 버킷의 패키지, 패키지 안에 있는 클래스와 인터페이스, 열거형 등을 통틀어 Bukkit API에 대하여 다룬다. === org.bukkit.plugin.java.JavaPlugin === ##정리 부탁드립니다. '''모든 Bukkit 플러그인은 JavaPlugin을 상속해야 합니다.''' 아래의 메소드는 JavaPlugin에 있는 메소드입니다. (@Override가 있는 경우 오버라이드 가능) ==== 콜백 함수 ==== ===== public void onLoad() ===== ## onLoad 콜백함수 플러그인 로딩시 onEnable보다 먼저 실행된다. {{{#!syntax java @Override public void onLoad() { // 플러그인을 로드 하였을 때(활성화 이전) 발생하는 콜백 함수 // 버킷을 실행하거나 /reload 명령어로 재시작하였을 때 발생합니다. } }}} ===== public void onEnable() ===== ## onEnable 콜백함수 플러그인 활성화시 onLoad 이후에 실행된다. [anchor(onEnable)] {{{#!syntax java @Override public void onEnable() { // 플러그인을 활성화 하였을 때(로드 이후) 발생하는 콜백 함수 // 버킷을 실행하거나 /reload 명령어로 재시작하였을 때 발생합니다. } }}} ===== public void onDisable() ===== ## onDisable 콜백함수 플러그인 비활성화시 실행된다.[* 서버가 강제 종료되는 등의 예외적인 상황의 경우 onDisable이 호출되지 않고 꺼질 수 있다.] [anchor(onDisable)] {{{#!syntax java @Override public void onDisable() { // 플러그인을 비활성화 하였을 때 발생하는 콜백 함수 // 버킷을 종료하거나 /reload 명령어로 재시작하였을 때 발생합니다. } }}} ==== protected File getFile() ==== {{{#!syntax java @Override protected File getFile() { return super.getFile(); } }}} ==== public ChunkGenerator getDefaultWorldGenerator(String worldName, String id) ==== {{{#!syntax java @Override public ChunkGenerator getDefaultWorldGenerator(String worldName, String id) { return super.getDefaultWorldGenerator(worldName, id); } }}} ==== public EbeanServer getDatabase() ==== {{{#!syntax java @Override public EbeanServer getDatabase() { return super.getDatabase(); } }}} ==== public FileConfiguration getConfig() ==== {{{#!syntax java @Override public FileConfiguration getConfig() { return super.getConfig(); } }}} ==== public InputStream getResource(String filename) ==== {{{#!syntax java @Override public InputStream getResource(String filename) { return super.getResource(filename); } }}} ==== protected void installDDL() ==== {{{#!syntax java @Override protected void installDDL() { super.installDDL(); } }}} ==== protected void removeDDL() ==== {{{#!syntax java @Override protected void removeDDL() { super.removeDDL(); } }}} ==== public PluginCommand getCommand(String name) ==== {{{#!syntax java @Override public PluginCommand getCommand(String name) { return super.getCommand(name); } }}} ==== public List<String> onTabComplete(CommandSender sender, Command command, String alias, String[] args) ==== {{{#!syntax java @Override public List<String> onTabComplete(CommandSender sender, Command command, String alias, String[] args) { return super.onTabComplete(sender, command, alias, args); } }}} 주요 사용 예시: {{{#!syntax java @Override public List<String> onTabComplete( CommandSender sender, Command command, String label, String[] args) { if ( args.length == 1) { List<String> list = new ArrayList<>( (int) list의 크기); list.add( string source ); list.add( string source ); list.add( string source ); . . . return list; } else if ( args.length == 2) { 양식은 비슷함 } . . . else if ( args.length == n[ 자신이 원하는 수 ]){ } return null; } }}} ==== public void reloadConfig() ==== {{{#!syntax java @Override public void reloadConfig() { super.reloadConfig(); } }}} ==== public void saveConfig() ==== {{{#!syntax java @Override public void saveConfig() { super.saveConfig(); } }}} ==== public void saveDefaultConfig() ==== {{{#!syntax java @Override public void saveDefaultConfig() { super.saveDefaultConfig(); } }}} ==== public void saveResource(String resourcePath, boolean replace) ==== {{{#!syntax java @Override public void saveResource(String resourcePath, boolean replace) { super.saveResource(resourcePath, replace); } }}} ==== public List<Class<?>> getDatabaseClasses() ==== {{{#!syntax java @Override public List<Class<?>> getDatabaseClasses() { return super.getDatabaseClasses(); } }}} ==== org.bukkit.entity ==== ===== Player 인터페이스 ===== || 분류 || 의미 || || v || void(리턴 안 함)) || || b || boolean(참, 거짓) || || i || int(32비트 정수) || || s || String(문자열) || || d || Double (배정밀도 [[부동소수점]] 실수) || || f || Float (단정밀도 부동소수점 실수) || || <이름> || 클래스|| ||분류 || 메서드 || 기능 || || v || chat(String str) || 채팅 띄우기 || || InetSocketAddress || getAddress() || 접속 주소(IP) 구하기 || || i || getLevel() || 레벨 구하기 || || f || getWalkSpeed() || 걷는속도 구하기 (-1.0 ~ 1.0) || || v || setWalkSpeed(float value) || 걷는속도 설정하기 (-1.0 ~ 1.0) || || v || setDisplayName(String name) || 디스플레이 이름 변경 || || s || getPlayerListName() || 플레이어 목록의 이름 구하기 || || v || setPlayerListName(String name)) || [[마인크래프트/플러그인/개발#s-7.2.1.1.1|링크 참고]] || || v || setLevel(int level) || 경험치 레벨 설정 || || i || getLevel() || 경험치 레벨 얻어오기 || || v || giveExp(int amount) || 경험치를 amount만큼 주기 || || v || giveExpLevels(int amount) || 경험치 레벨을 amount만큼 주기 || || i || getFoodLevel() || 배고픔 수치 구하기 (0~10) || || v || setFoodLevel(int value) || 배고픔 수치를 value로 설정 || || v || kickPlayer(String message) || message를 사유로 퇴장시키기 || || v || hidePlayer(Player player) || player를 보이지 않게 하기 || || v || sendMessage(String message) || 플레이어에게 메시지 보내기 (ChatColor와 혼용 가능) || || PlayerInventory || getInventory() || 플레이어의 인벤토리를 불러옴 ([[마인크래프트/플러그인/개발#s-7.3.1.2|HumanEntity]]에서 상속됨) || ====== setPlayerListName ====== 인지: String name 인게임 플레이어 리스트의 이름을 설정합니다. 16자까지 허용되며, 색깔이 지원됩니다. 일어날 수 있는 예외들: * IllegalArgumentException - 이름이 너무 길거나[* 16글자 정도] 누군가가 이미 쓰고 있는 이름인 경우 (원문) Sets the name that is shown on the in-game player list. The name cannot be longer than 16 characters, but ChatColor is supported. If the value is null, the name will be identical to HumanEntity.getName(). This name is case sensitive and unique, two names with different casing will appear as two different people. If a player joins afterwards with a name that conflicts with a player's custom list name, the joining player's player list name will have a random number appended to it (1-2 characters long in the default implementation). If the joining player's name is 15 or 16 characters long, part of the name will be truncated at the end to allow the addition of the two digits. Parameters: name - new player list name Throws: IllegalArgumentException - if the name is already used by someone else IllegalArgumentException - if the length of the name is too long ===== HumanEntity 인터페이스 ===== || 분류 || 의미 || || v || void(리턴 안 함)) || || b || boolean(참, 거짓) || || i || int(32비트 정수) || || s || String(문자열) || || d || Double (배정밀도 [[부동소수점]] 실수) || || f || Float (단정밀도 부동소수점 실수) || || <이름> || 클래스|| ||분류 || 메서드 || 기능 || || v || closeInventory() || 보관함을 닫는다. || || i || getCooldown(Material material) || 특정한 아이템의 쿨타운을 구한다.(아마도) || || Inventory || getEnderChest() || 엔더 상자를 인벤토리 형태로 가져온다. || || i || getExpToLevel() || 다음 레벨까지 남은 경험치를 가져온다. || || GameMode || getGameMode() || 게임 모드를 가져온다. || || PlayerInventory[* Inventory를 상속받는 인터페이스로 보관함과 더불어 갑옷 슬롯과 방패(왼손)의 내용도 포함한다. ] || getInventory() || 플레이어의 인벤토리를 가져온다. || || ItemStack || getItemOnCursor() || 마우스 커서 아래의 아이템을 구한다. 비어있을 수 있다. || || MainHand || getMainHand() || 주 손(설정에서 변경)을 가져온다. || || s || getName() || 플레이어의 이름을 반환한다. || Player 인터페이스에서도 상속받는 인터페이스로 마인크래프트에서 사람(플레이어)의 메소드를 대량 포함한다. 게임에서 NPC[* 시티즌 등의 사람 추가 플러그인]나 플레이어에 반영되는 내용을 그대로 포함한다. ||항목||내용|| || 선언 || public interface HumanEntity || || 상속 || LivingEntity, AnimalTamer, Permissible, InventoryHolder || === org.bukkit.event === == Craftbukkit 구현부 레퍼런스 == '''{{{#red 주의!}}} Craftbukkit의 구현부는 버전에 따라 언제든지 예고 없이 바뀔 수 있으며, 사용이 권장되지 않습니다. Bukkit API 내부에서 해결할 수 있는 경우 Bukkit API를 사용해야 합니다.'''[* 또한 NMS를 사용하는 가장 큰 이유중 하나인 패킷 조작 역시 상당수 ProtocolLib에서 처리 할 수 있기 때문에 사용이 더더욱 권장되지 않는다.] 플러그인을 개발하다 보면 Bukkit API에서 직접 지원하지 않는 기능이 필요할 때가 있는데, 이 경우 직접 서버의 구현부에 접근해서 데이터를 조작하는 상당히 까다로운 작업이 요구된다. [[파일:버킷_구조도.png]]\ {{{org.craftbukkit}}} 패키지와 {{{net.minecraft.server}}}[* 일반적으로 앞의 글자를 따서 NMS라고 칭한다.] 패키지는 Craftbukkit 기반 서버의 실제 구현 부분이다. NMS는 마인크래프트 자체의 코드로, 난독화되어 있기 때문에 이를 사용하기 위해서는 난독화를 해제할 수 있는 매핑을 사용해야 한다. [[https://nms.screamingsandals.org/|NMS Mapper]]에서 NMS 매핑 표를 확인할 수 있으나, 이도 상당히 번거롭기에 PaperWeight, SpecialSource와 같은 역난독화 프로그램을 사용하는 게 편리하다. 아래의 문단은 모장 매핑 기준으로 서술한다. === net.minecraft.network.protocol.game === 마인크래프트의 패킷 클래스들이 들어있는 패키지이다. [[https://wiki.vg/Protocol|wiki.vg]]에서 패킷의 이름, 하는 역할, 사용법 등을 볼 수 있다. wiki.vg에 나와 있는 패킷과 NMS 패킷 클래스는 일대일 대응되지만 이름이 조금씩 다르므로 주의. ==== Clientbound 패킷 사용법 ==== 클라이언트로 패킷을 보내기 위해선 우선 패킷 객체를 생성해야 한다.[* 패킷마다 생성자가 다르다. 인자로 정보를 넘겨주는 형태의 생성자를 사용할 수도 있고, FriendlyByteBuf를 사용해 직접 정보를 바이트 단위에서 입력할 수도 있다. 특별한 경우가 아니라면 인자로 넘겨주는 형태가 가장 깔끔하다.] {{{#!syntax java Clientbound<패킷이름>Packet packet = new Clientbound<패킷이름>Packet(<...>); }}} 패킷 객체를 생성했다면, 플레이어 객체와 연결 상태를 NMS 형태로 불러오자.[* player는 패킷을 보내고자 하는 플레이어이다.] {{{#!syntax java ServerPlayer nmsPlayer = ((CraftPlayer) player).getHandle(); ServerGamePacketListenerImpl connection = nmsPlayer.connection; }}} 이제 connection을 통해 패킷을 전송하면 된다. {{{#!syntax java connection.send(packet); }}} [각주] [[분류:나무위키 마인크래프트 프로젝트]][[분류:마인크래프트/플러그인]]캡챠되돌리기