「スコアボードシステムの使い方」を編集中

= スコアボードシステムの使い方 =

MinecraftのScoreboardシステムを、Bukkit API経由で使用する方法をまとめます。
このチュートリアルは、[https://forums.bukkit.org/threads/tutorial-scoreboards-teams-with-the-bukkit-api.139655/ こちら]の内容を参考に作成しています。

基本的に、Bukkit APIから使用できるScoreboardシステムは、
バニラのサーバーコマンド /scoreboard で実施できることとほとんど同じです。
このチュートリアルを理解するためには、/scoreboard コマンドを試して、
Scoreboardシステムの仕様をよく理解することが一番の近道です。
コマンドの使い方は、[http://ch.nicovideo.jp/minecrafter/blomaga/ar95807 こちら]や[http://www.nicovideo.jp/watch/sm20410540 こちら]を参考にしてみてください。

=スコアボードシステムの基本的な使い方=

まず、ScoreboardManager を取得します。
<source lang = "java">
ScoreboardManager manager = Bukkit.getScoreboardManager();
</source>

次に、Scoreboard を取得します。
<source lang = "java">
Scoreboard board = manager.getMainScoreboard();
</source>

Scoreboard に、新しいチームを登録します。
<source lang = "java">
Team team = board.registerNewTeam("teamname");
</source>

そして、登録されたチームの設定をいろいろ変更します。
<source lang = "java">
// プレイヤーを追加します。
team.addPlayer(player);

// プレイヤーを削除します。
team.removePlayer(player);

// prefixを登録します。これは、TABキーを押したときのプレイヤーリストと、
// 頭の上のプレイヤー名で、該当チームに所属するプレイヤーの名前の"前"に、
// 指定した文字列が付きます。
// 表示欄は狭いため、長い文字列を指定することは避けるべきです。
// なお、ChatColorによる装飾が指定可能です。
// 例）team.setPrefix(ChatColor.RED.toString());
team.setPrefix("prefix");

// prefixを登録します。これは、TABキーを押したときのプレイヤーリストと、
// 頭の上のプレイヤー名で、該当チームに所属するプレイヤーの名前の"後"に、
// 指定した文字列が付きます。
// なお、prefixでChatColorを使用した場合、suffixでRESETを指定することを推奨します。
// 例）team.setPrefix(ChatColor.RESET.toString());
team.setSuffix("suffix");

// チームの表示名を指定します。
team.setDisplayName("display name");

// チームメンバー同士の攻撃ができるかどうかを設定します。
// true で攻撃が有効になり、false で攻撃が無効になります。
team.setAllowFriendlyFire(false)

// 透明化しているチームメンバーを見えるようにするかどうかを設定します。
// true で透明化しているチームメンバーが見えるようになり、
// false で誰からも見えなくなります。
team.setCanSeeFriendlyInvisibles(true);
</source>

"dummy"というCriteriaを設定して、"test"という名前の新しいObjectiveを作成します。
<source lang = "java">
Objective objective = board.registerNewObjective("test", "dummy");
</source>

新しく登録したObjectiveの設定も、いろいろ変更してみましょう。
<source lang = "java">
// Objective の表示名を設定します。
objective.setDisplayName("Display Name");

// Objectiveをどこに表示するかを設定します。
// SIDEBAR、PLAYER_LIST、BELOW_NAME が指定できます。
objective.setDisplaySlot(DisplaySlot.BELOW_NAME);
</source>

特定のプレイヤーに対するObjectiveでの点数を設定します。
<source lang = "java">
Score score = objective.getScore(player);
score.setScore(42);
</source>

ここまでを実装して設定することで、下のスクリーンショットのように表示が確認できていると思います。

[[Image:scoreboard1.png]]

特定のプレイヤーのスコアをリセットするには、次のようにします。
<source lang = "java">
board.resetScores(player);
</source>

=専用のスコアボードシステムの取得と設定=

メインのScoreboardシステムを使用してしまうと、他で設定している得点内容を上書きしてしまったり、
Objectiveの名前が衝突してしまったりしないか、心配があります。

自身のプラグイン専用に、Scoreboardシステムを取得したい場合は、
最初のgetMainScoreboard()をgetNewScoreboard()にしてください。

<source lang = "java">
Scoreboard board = manager.getNewScoreboard();
</source>

専用のScoreboardシステムでは、デフォルトで表示されません。
各プレイヤーの表示を設定するには、setScoreboardを使用してください。

<source lang = "java">
for ( Player online : Bukkit.getOnlinePlayers() ) {
    online.setScoreboard(board);
}
</source>


=サイドバーでのカスタム項目の設定=

サイドバーにObjectiveを設定している場合、ダミーのOfflinePlayerを登録することで、
カスタム項目を表示することが可能です。
カスタム項目のスコアを登録するには、次のようにします。

<source lang = "java">
Score score = objective.getScore(Bukkit.getOfflinePlayer(name));
score.setScore(99);
</source>

カスタム項目のスコアをリセットするには、次のようにします。
<source lang = "java">
board.resetScores(Bukkit.getOfflinePlayer(name));
</source>


例
<source lang = "java">
Score score = objective.getScore(Bukkit.getOfflinePlayer(ChatColor.GREEN + "kills:"));
score.setScore(99);
</source>

[[Image:scoreboard2.png]]



=簡単な実装例=

各プレイヤーの頭の上に、現在の体力を表示します。
なお、Criteria に "health" を指定した場合、各プレイヤーの体力が増減するたびに、自動的に更新されます。
（プラグイン側から更新を実施する必要はありません。）

<source lang = "java">
ScoreboardManager manager = Bukkit.getScoreboardManager();
Scoreboard board = manager.getNewScoreboard();

Objective objective = board.registerNewObjective("showhealth", "health");
objective.setDisplaySlot(DisplaySlot.BELOW_NAME);
objective.setDisplayName("/ 20");

for(Player online : Bukkit.getOnlinePlayers()){
    online.setScoreboard(board);
    online.setHealth(online.getHealth());
}
</source>