Spigotで看板をクリックした時に自分の座標を保存するPluginを作る【CheckPoint編II/Minecraft】

初回の記事からはこちら

Spigotで自動で記入済みの看板を設置するPluginを作る【CheckPoint編I/Minecraft】

というわけでチェックポイント編第三回。今回はアイテムをクリックすると保存したチェックポイントにテレポートする機能を追加していこうと思う。どうぞよしなに。

実際に書いてみる

1.新しいクラス「ClickSpawn」の作成

というわけで早速新しいクラス「ClickSpawn」（名前はなんでもいい）を作成。Listenerを継承しておく。(こいついっつもおんなじこと言ってんな）

public class ClickSpawn implements Listener {
}

2.イベントの設定

今回はアイテムをクリックした時のイベント。と言っても前に使ったPlayerInteractEventを再利用して組んでいく。

public class ClickSpawn implements Listener {
    @EventHandler
    public void SetSpawn(PlayerInteractEvent e){
    }
}

3.必要な変数を取得

今まで通りイベント関数の中に書いていく。プレイヤー型でイベントを起こしたプレイヤーを取得。ワールド型でプレイヤーがいるワールドを取得。アクション型でイベントで発生したアクションを取得する。

Player player = e.getPlayer();
World world = player.getWorld();
Action action = e.getAction();

4.持っているアイテムが～～ならというif文

1個目のif文は（アクションが空気を右クリック||アクションがブロックを右クリック)という構造になっている。||はor、又は、を意味するコードなので空気かブロックを右クリックした場合。つまり右クリックした場合を検知するものとなっている。

2個目のif文はプレイヤーの持っているアイテムを取得してその種類を取得。それがMaterial（素材）クラスのスライムボールであるなら～～する。という文である。SLIME_BALLのところを好きなアイテムに変えれば様々なアイテムをテレポートのトリガーにすることができる。

if (action.equals(Action.RIGHT_CLICK_AIR) ||action.equals(Action.RIGHT_CLICK_BLOCK)) {
            if (player.getItemInHand().getType() == Material.SLIME_BALL) {
            //ここに 5.の中身を書いていく
            }
}

ここでは書いてないが以下のようにすることでアイテム名で識別することもできる。

if(player.getItemInHand().getItemMeta().getDisplayName()equals("アイテム名")){
}

5.チェックポイントデータを呼び出してテレポートする

最初にString型（文字型）を宣言してプレイヤーの名前とワールドの名前を繋げている。(例：you0101 + world = you0101world)。これがチェックポイントデータを呼び出すKeyとなるのでおぼえてない方はSpigotで看板をクリックした時に自分の座標を保存するPluginを作る【CheckPoint編II/Minecraft】を読んで思い出して欲しい。

その後Location型変数であるlocにHashMapを使いさっきのKeyを入れることで保存した値を引き出している。前にmap.put(player+world , loc)で代入したやつだ。get関数で1つ目を入れることで値であるloc（プレイヤーがチェックポイントとして保存した座標）が手に入るわけだ。

if文はif(!(loc == null))としてlocになにか値が入っているならば～～。という文になっている。(loc == null)はlocに値が入っていないことを意味し、!()をつけることでそれ以外という意味にしている。

}else{はさっきif文で限定したそれ以外。つまり値が入っていない場合だ。ここではメッセージを返すようにした。

    String NameWorld = player.getName() + world.getName();
    Location loc = HashMaps.map.get(NameWorld);
    if(!(loc == null)){
        player.teleport(loc);
    }else{
        player.sendMessage(ChatColor.BOLD + "" + ChatColor.BLUE + "チェックポイントが見つかりませんでした");
    }

6.Mainクラスで有効化する

Iでやったのと変わらんのでコードだけ（クラス名は変えること）

public final class CHECKPOINT extends JavaPlugin {

    @Override
    public void onEnable() { //サーバーが起動した時
        // Plugin startup logic
        Server server = this.getServer();
        PluginManager pluginManager = server.getPluginManager();
        pluginManager.registerEvents(new New(), this);
        //Newというクラスを登録する（Newの部分をクラス名に変える）

全文

package com.yoyude.checkpoint;

import org.bukkit.ChatColor;
import org.bukkit.Location;
import org.bukkit.Material;
import org.bukkit.World;

import org.bukkit.entity.Player;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.event.block.Action;
import org.bukkit.event.player.PlayerInteractEvent;

public class ClickSpawn implements Listener {
    @EventHandler
    public void SetSpawn(PlayerInteractEvent e){
        Player player = e.getPlayer();
        World world = player.getWorld();
        Action action = e.getAction();

        if (action.equals(Action.RIGHT_CLICK_AIR) || action.equals(Action.RIGHT_CLICK_BLOCK)) {
            if (player.getItemInHand().getType() == Material.SLIME_BALL) {

                String NameWorld = player.getName() + world.getName();

                Location loc = HashMaps.map.get(NameWorld);
                if(!(loc == null)){
                    player.teleport(loc);
                }else{
                    player.sendMessage(ChatColor.BOLD + "" + ChatColor.BLUE + "チェックポイントが見つかりませんでした");
                }

            }
        }
    }
}

次のパート

これでスライムボールをクリックすれば登録したチェックポイントに飛べるようになった。でもまだ物足りない。何故だろう。そう、ワールドに入った時にスライムボールを入手する手段がないのだ。というわけで次はワールド内に入ったらアイテムを配る機能を追加していこう

前→Spigotで看板をクリックした時に自分の座標を保存するPluginを作る【CheckPoint編II/Minecraft】

次→執筆中

The post Spigotでアイテムをクリックしたら保存した座標にテレポートするPluginを作る【CheckPointIII/Minecraft】 first appeared on よゆうで紅房.

今回はチェックポイント編PartIIということで看板をクリックした際にプレイヤーごとに座標を保存するプラグインを組む。どうぞよしなに。

実際に書いてみる

前提知識はIで説明したので割愛！割愛！

1.新しいクラス「ClickSign」の作成

というわけで早速新しいクラス「ClickSign」（名前はなんでもいい）を作成。Listenerを継承しておく。

public class ClickSign implements Listener {
}

2.イベントの設定

今回呼び出すイベントはプレイヤーが看板を殴ったときのイベントなので「PlayerInteractEvent」を選択。Interactは相互作用とかそんな感じ。Spigotプラグインでは専ら殴った時に使われる。

    @EventHandler
    public void SetSpawn(PlayerInteractEvent e){
    }

3.内容の設定

最初にコードをお出ししていくスタイル。

public void SetSpawn(PlayerInteractEvent e}{
        Player player = e.getPlayer();//プレイヤー名を変数playerに代入
        World world = player.getWorld();//プレイヤーのいるワールドを変数worldに代入
        Action action = e.getAction();//プレイヤーが行った動作を変数actionに代入
        if(e.getClickedBlock().getState() instanceof Sign){

        //クリックしたブロックを取得・状態を取得・それが看板ならば
            Sign signboard = (Sign)e.getClickedBlock().getState();
            //Sign型（看板型）の変数signboardに看板の情報を代入
            //本来は型が違うが(Sign)とつけて看板型に変更している　　　　
            String signString = signboard.getLine(1);
            //看板の２行目を取得（０から数える）
            if(signString.equals(ChatColor.BOLD + "Check Point")){
            //看板の２行目が太字のチェックポイントという文字なら
                if(player.isOnGround()) {//プレイヤーが地に足をつけてるなら
                    Location loc = player.getLocation();//プレイヤーの座標を取得
                    SaveCheckPoint(player,loc,world);//セーブする関数（後述）

                    player.sendMessage(ChatColor.BOLD + "チェックポイントを設定しました!");
                   
                    Sound.ENTITY_PARROT_IMITATE_SLIME,2,2);//音を鳴らす




                }
                else if(!(player.isOnGround())){//プレイヤーが地に足をつけてないなら
                    player.sendMessage("空中ではチェックポイントを設置できません");
                }





            }

        }
    }

}

という感じになる。基本的にやってることは同じだが一つ悩むところがあるだろう。

SaveCheckPoint(player,loc,world);//セーブする関数（後述）

これは別の場所で書いたプログラムを呼び出しているということだ。
会社が外に受注しているようなイメージでOK。player,loc,worldは発注の情報である。

なんでこんなことをしているのかというと説明しやすくするためである。
ちなみに座標の変数であるlocに保存したままにしない理由は今のままだと全プレイヤーが同じlocに座標を登録しているためプレイヤーごとにチェックポイントを分けられないからである。

4.HashMapの設定

先程の関数を説明する前にHashMapというものについて説明しておく。まあこれに関してはググってもらったほうがわかりやすいとは思うが簡単に言えばKeyと値を保存しておくことができる関数だ。

早い話が合言葉。例えば「海」と入力すると「山」みたいなことを保存しておける。
これを今回は「player名」を入力した場合にそれぞれの座標を出力したいわけだ。

というわけで新しいクラス「HashMaps」を作成しコードを次のように書く

public class HashMaps extends JavaPlugin implements Listener {
    public static HashMap<String, Location> map = new HashMap<>();
}

大事なとこだけ言えばこのmapという名前のHashMapは<String型（文字）を入力すると登録したLocation型（座標）を返しますよ>という登録である。それさえ覚えておけばOK。

5.SaveCheckPoint関数の作成

さっき言ってた関数を作っていく。といってもそこまで難しくない。以下で終わりである。

public void SaveCheckPoint(Player player,Location location , World world){
        String NameWorld = player.getName() + world.getName();
        //player名とworld名を取得して合わせている。
        //worldをいくつも使う場合チェックポイントをそれぞれ分けるため
        HashMaps.map.put(NameWorld,location);
        //HashMapsファイルにある.map.にkey(NameWorld)と値(location)を代入している
        //これで今後map.get(NameWorld)と打てばlocationが出力できるようになる。
    }

これをClickSign.javaの@EventHandlerの上にでも書けば良い。ちなみに別クラスに書く場合は関数呼び出しの際に「別のクラス名.関数名（引数）;」と書いて呼び出す必要がある。怠い。

6.クラスを有効化する

Iでやったのと変わらんのでコードだけ（クラス名は変えること）

public final class CHECKPOINT extends JavaPlugin {

    @Override
    public void onEnable() { //サーバーが起動した時
        // Plugin startup logic
        Server server = this.getServer();
        PluginManager pluginManager = server.getPluginManager();
        pluginManager.registerEvents(new New(), this);
        //Newというクラスを登録する（Newの部分をクラス名に変える）

次のパート

とりあえず保存することには成功したので次はチェックポイントにテレポートしていこう。

前→Spigotで自動で記入済みの看板を設置するPluginを作る【CheckPoint編I/Minecraft】

次→Spigotでアイテムをクリックしたら保存した座標にテレポートするPluginを作る【CheckPointIII/Minecraft】

The post Spigotで看板をクリックした時に自分の座標を保存するPluginを作る【CheckPoint編II/Minecraft】 first appeared on よゆうで紅房.

Skriptなら実装できるけどたまにはJAVAでPluginを作ってみたい……。

というわけで作ってみました。チェックポイント編第一弾

「看板を置くプラグイン！！」

より具体的にいうならば看板に「C」と入力した時だけ看板の内容をチェックポイント用に書き換えるプラグインである。

地味だと思った方はよゆうポイントマイナス√3点です。

前提知識

最初に前提として必要とする知識について触れておきます。

環境構築が済んでいる

まずこれ。分かんない人は「Plugin作成　環境構築」とかでググってください。EclipseだとかVScodeだとかIntelliJ IDEAだとかまあいろいろ出てくるはずです。迷ったらIntelliJ IDEAでいいです。俺もそれなので。

JAVAの基礎ができている

ここでいう基礎ってのは構文とかじゃなくてファイルの位置とかです。メインクラスがあって別のクラスを作ってそれを呼び出すとかなんとなく理解してればいいです。理解してなくても動くプラグインが組めてるならそれでいいです。

プラグイン作成の準備ができる

要するにIntelliJ IDEAを起動→MinecraftPluginを作成→Spigot→諸々の情報を記入（名前とversionとか）→メインクラスが出来上がる。これができればOK。こんなもんはググれば出てきます。割愛。

実際に書いてみる

ここまで来たなら後はプラグインを書くだけ。versionは1.12.2で作成。

1.新しくクラスを作る

最初の段階ではこうなっているはず。

左にあるCというマークとTestCPという文字（今回はプラグイン名をTestCPにしたため）が見えるはずだ。そしたらそこを右クリック。新規→新しいクラス→クラス名を入力で新しいクラスが作れる。名前はなんでもOK。拡張子はつけなくても自動でつく。便利。

2.Listner関係のクラスであることを書く

public class New {
}

最初は上のようにだけなるはず。（今回はNewというクラスを作成した。名前は適当）
それをListner…。要はプレイヤーに関するイベントがあったことを書きたいのでそういうクラスだとコンピューターに伝えるためのコード。具体的に書くとこう。

public class New implements Listener {
}

この時Listenerの部分が赤色になったらカーソルを持っていきクラスにインポートというのを押してもらえればOK。最悪

import org.bukkit.event.Listener;

と上に追記すればなんとかなる。やってることも同じ。

ここまで書いたのをまとめると

package com.yoyude.testcp;//パッケージはあなたの設定した名前になる。

import org.bukkit.event.Listener;//要するにListener関連の装備にしましたよってこと。

public class New implements Listener{
    //ここにイベントを書いていく
}

3.イベントを書く

イベントというのは「プレイヤーが参加した時」や「プレイヤーがブロックをクリックした時」など様々なプレイヤー関連の動きがあった時に呼び出されるものである。イベント一覧は「Spigot イベント一覧」でググれば出てくるので割愛。

今回は看板を置いた時に記入済みの看板を設置したいのでイベントは「ブロックを置いた時のイベント」。つまり「BlockPlaceEvent」…と思ったら大間違い。というかできなくもないだろうがその場合装飾で看板を置いてもチェックポイントになる事案が発生するまである。

今回作るプラグインは「C」と入力した場合に書き換えるプラグインなので呼び出すイベントは

@EventHandler
public void PlacePoint(SignChangeEvent e){
}

SignChangeEvent。看板が書き換わった時のイベントとなる。
簡単に説明すると@EventHandlerはここにイベントのプログラムを書きますよということ。PlacePointというのは適当につけた関数名（何でもいい）。後ろが呼び出すイベントでeはそのEventのこと。後述。ともかくこれで看板を書いた時に呼び出すプログラムの土台ができたわけだ。

public class SignPlace implements Listener {
    @EventHandler
    public void PlacePoint(SignChangeEvent e){
    }

4.イベントの中身を書く

今のままだとイベントが呼び出されても特になにもしない。空っぽだ。
というわけでイベントが呼び出された時起こしたい内容を書いていく。実際に出来上がったものがこちらになります（③分クッキング風）

Player player = e.getPlayer();
//Player型の変数player(名前はなんでもいい）にイベントを起こしたプレイヤーを代入している
//event.getPlayer()といった感じ。
player.sendMessage("Cと記入すればチェックポイントが設置できます");
//プレイヤーに使い方を伝えるメッセージを送る。
String signString = e.getLine(0);
//String型（要するに文字型）の変数signStringに看板の0行目（要するに1行目）の文字を代入している。
//「C」とプレイヤーが看板に書けば「C」が代入される。
if(signString.equals("C")) {//もし文字がCならというif文
    player.sendMessage("チェックポイントを設置しました");
    //プレイヤーにメッセージ
    e.setLine(0, ChatColor.AQUA + "★★★★★★★★★★★★★★★★★★★");
    e.setLine(1,ChatColor.BOLD + "Check Point");
    e.setLine(2,ChatColor.BOLD + "Right Click");
    e.setLine(3,ChatColor.AQUA + "★★★★★★★★★★★★★★★★★★★");
    //e.setLineは看板を書き換える構文。それぞれ(何行目,内容)という形になっている。
    //ChatColorは装飾を変更できる。BOLDは太字。AQUA等は色。

こんな感じになる。if文がわからない人はJAVAなりC言語なりを勉強して欲しい。そんなに難しくないので１時間もあれば理解できるはずだ。

これで一応クラスは完成したことになる。全容はこんな感じだ。

package com.yoyude.checkpoint;



import org.bukkit.ChatColor;
import org.bukkit.entity.Player;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.event.block.SignChangeEvent;



public class SignPlace implements Listener {
    @EventHandler
    public void PlacePoint(SignChangeEvent e){
        Player player = e.getPlayer();

        player.sendMessage("Cと記入すればチェックポイントが設置できます");
        String signString = e.getLine(0);
        if(signString.equals("C")) {

            player.sendMessage("チェックポイントを設置しました");
            e.setLine(0, ChatColor.AQUA + "★★★★★★★★★★★★★★★★★★★");
            e.setLine(1,ChatColor.BOLD + "Check Point");
            e.setLine(2,ChatColor.BOLD + "Right Click");
            e.setLine(3,ChatColor.AQUA + "★★★★★★★★★★★★★★★★★★★")
;
        }

    }
}

これで晴れてプラグイン完成。というわけではない。実は最後の仕上げが残っている。

5.メインクラスにイベントを登録する。

このままだとイベントを書いたクラスをメインクラスが読み込んでくれないのだ。というわけで手つかずだったメインクラスに書き込んでいく。完成図はこちら。

public final class CHECKPOINT extends JavaPlugin {

    @Override
    public void onEnable() { //サーバーが起動した時
        // Plugin startup logic
        Server server = this.getServer();
        PluginManager pluginManager = server.getPluginManager();
        pluginManager.registerEvents(new New(), this);
        //Newというクラスを登録する（Newの部分をクラス名に変える）
    }

これでプラグインを入れてサーバーを起動すればOK。
右上に緑の矢印があるはずなのでそれをクリックしてプラグインをjarに変換する。

これにてプラグインは完成！完璧なめでたしめでたしだな

今回のプラグインを動かしてみる

お待ちかねの実装タイム。

次のパート

まだ看板ができただけでクリックしても何も反応しない。
ということで次はチェックポイントを記録する機能を書いていこう！

次 Spigotで看板をクリックした時に自分の座標を保存する【CheckPoint編II/Minecraft】

The post Spigotで自動で記入済みの看板を設置するPluginを作る【CheckPoint編I/Minecraft】 first appeared on よゆうで紅房.