Spigotで看板のクリックを取得する方法をまとめました。 Spigot1.16.5で動作確認済です。

1. 看板のクリックを取得するには
ZOI 2021/08/01

2. 目次
● 自己紹介
● 実現したいこと
● 処理を実行するのに必要なこと
● プレイヤーのアクションを取得する方法・それぞれの特徴
● 今回の目的を再確認してみる
● 実際に使われている例
● 実装
● 謝辞

3. 自己紹介
ZOI (高一)
Spigot歴: 1年ほど
過去作品
BlockGuard(ワールド保護プラグイン)

4. 実現したいこと
ミニゲームのプラグインを作った時、プレイヤーを参加させるためにコマンドを実行
させる必要があった
コマンドの補完機能はあるが、入力時のミスが起こりやすい
『ミスが発生しない参加処理』を実現したい

5. 処理を実行するのに必要なこと
クリック、移動、コマンド、インベントリ操作など、プレイヤーのアクションをプラグイン
へ伝える必要がある
行動 プラグイン

6. プレイヤーのアクションを取得する方法
● コマンドの実行
● コマンドブロック (+レッドストーン信号)
● 本・チャットの文字のクリック
● アイテムのクリック
● 看板のクリック

7. コマンドを使う方法の特徴
● ワールドに依存しないので、どこでも実行できる
● 引数を使うことで、プログラムにデータを渡せる
● 同じ処理を繰り返すときの簡単さは他の方法に負ける
● 入力ミスが発生しやすい
利用用途
● あまり実行しないような用途
● プラグインに情報を渡す必要がある用途
プラグインの設定の変更など

8. コマンドブロックを使う方法の特徴
● コマンドブロックの機能によってリピート実行やチェーン実行が使える
● レッドストーン回路が使える
● ワールドにブロックを設置する必要があるので手間やスペースがいる
● コマンドを実行したプレイヤーを特定するのが難しい
利用用途
● レッドストーンと組み合わせたい用途
● 実行者をあまり気にしなくて良い用途
ゲーム開始ボタンなど

9. 本やチャットの文字を使う利点
● クリックさせる文字を使って動作を説明できる
● アイテムやチャットログとして携帯できる
● 先にアイテムを渡したりメッセージを送るといった準備が必要
利用用途
● 実行するタイミングが限られている用途
(コマンドと組み合わせて)設定メニューなど

10. アイテムのクリックを利用する利点
● アイテムとして携帯できる
● 動作のイメージに合ったアイテムを使うことで、動作を理解しやすくなる
● アイテムに名前や説明をつけることで、動作を説明できる
● インベントリを圧迫する
利用用途
● 実行するタイミングがある程度限られている用途
● 説明や見た目によって動作のイメージを伝えたい用途
ミニゲームでの特殊アイテムなど

11. 看板を使う利点
● 看板のテキストによって動作をプレイヤーに説明できる
● 看板のテキストを書き換えることもできる
● 見えている文字列が全プレイヤーで同期されている
● 看板を設置する必要があるので手間やスペースがいる
利用用途
● 全員で共通の状態を変更したい用途
● ただ機能が拡張されたボタンとしての用途
ミニゲームでのステージ選択・ゲームへの参加など

12. 今回の目的を再確認してみる
● 持ち運べる必要はあまりない
● クリックしたプレイヤーを正確に取得したい
● 入力ミスを減らしたい
● 「ここを押して参加」のようなメッセージを表示したい
以上の理由から、看板を選んだ

13. 実際に使われている例
実際の利用例
● Hypixel Server ゲームへの参加
テレポーターの移動先を指定
● ChelcyNetwork 容量無限のインベントリ
他の利用方法
● 生活サーバーと資源サーバーの移動
● ミニゲームのステージ選択

14. 実装
1. クリックイベントの取得
2. クリックされたのが看板かどうかの判断
3. 処理の実行

15. 1. クリックイベントの取得 (流れ)
Spigotでは、
● registerEvents()によってイベントリスナーとして登録されている
● org.bukkit.event.Listener を継承している
● イベントハンドラ(@EventHandler)を設定している
● 適切な引数を受け取る
という条件が満たされている関数が存在すれば、イベント発生時に実行される

16. 1. クリックイベントの取得 (実装例)
Listener を継承させたクラスを作り、その中にイベント用の関数を記述
public class EventManager implements Listener {
@EventHandler
public void onClick(PlayerInteractEvent event) {
// この関数が呼び出される
}
}
そのクラスをイベントリスナーに登録する
// Main関数内に記述
@Override
public void onEnable() {
getServer().getPluginManager().registerEvents(new EventManager(), this);
}

17. 2. クリックされたのが看板かどうかの判断 (流れ)
このままでは、クリックイベント全てに対して処理される
求める条件
● ブロックをクリックした
● そのブロックが看板である

18. 2. クリックされたのが看板かどうかの判断 (実装)
ブロックをクリックしていない場合や、看板以外をクリックした場合を除く
// onClick()内に記述
if (!event.hasBlock()) return;
if (!(event.getClickedBlock().getState() instanceof Sign)) return;
Sign signboard = (Sign) event.getClickedBlock().getState();

19. 3. 処理の実行 (流れ)
今、看板の情報とクリックイベントの情報を使うことができるので、
看板の利用目的に応じてコードを記述する

20. 3. 処理の実行 (実装)
今回は、看板の文字列をそのままプレイヤーに返してみる
// onClick()内に記述
Sign signboard = (Sign) event.getClickedBlock().getState();
for (String str : signboard.getLines()) {
event.getPlayer().sendMessage(str);
}

21. 謝辞
使用させていただいたツール
● SlidesCodeHighlighter : https://romannurik.github.io/SlidesCodeHighlighter/
● Font Awesome : https://fontawesome.com/
参考にさせていただいたサイト
● Spigot API : https://hub.spigotmc.org/javadocs/bukkit/
● SpigotのEvent一覧 : https://www.jias.jp/blog/?85