提供: Minecraft Modding Wiki
移動先: 案内検索
(Thread Safe API Methods)
(BukkitSchedulerがDepricatedされたことによる注意の追記。)
 
(3人の利用者による、間の20版が非表示)
1行目: 1行目:
== スケジューラの解説 ==
+
== スケジューラのプログラミング ==
この解説では、Bukkitのスケジューラの利用方法を説明しています。
 
  
== 主な注意事項  ==
+
このチュートリアルでは、bukkit によって提供されているスケジューラの使用方法をガイドします。<br>
 +
スケジューラは、指定の時間後に実行される処理を書くことができます。<br>
 +
これはリスナーやイベントへの応答で実行されるコードの記述方法とは異なります。<br>
 +
また、繰り返しや、遅延の有無を設定したりすることもできます。この繰り返し処理は、処理が完了するか、キャンセルされるか、プラグインが無効になるまで実行できます。
  
主な注意事項は次の2点です。
+
スケジューラを利用した実装は、次のような手順を踏んでください。
* 他のスレッドからAPIのメソッドを(一部例外あり)を呼び出さない
+
# まず、スケジューラにより実行される処理内容を、[[#BukkitRunnable|BukkitRunnable]] を継承したクラスの run()メソッドで実装します。
* メインのスレッドをスリープ状態にしてはならない
+
# 次に、前のステップで実装したクラスをインスタンス化し、スケジュールをしたい箇所で、runTaskLaterメソッドやrunTaskTimerメソッドなどを実行するように設定します。
  
== 解説 ==
+
== BukkitRunnable ==
  
スケジューラは次の3種類のタスクをオプションとして提供しています。
+
BukkitRunnableは、 抽象クラスRunnableの実装クラスです。<br>
*遅延タスク(Delayed Task)
+
Runnableに無い便利な機能として、自身の処理を再スケジュールしたり、キャンセルしたりできることです。
*連続タスク(Repeating Task)
 
*戻り値を返すタスク
 
  
これらのタスクは2種類のスレッドとして実行する事ができます。
+
=== 処理の実装例 ===
*メインサーバスレッド
 
*専用スレッド
 
  
=== スレッドの種類  ===
+
スケジューラの処理を定義するには、まず BukkitRunnable を extends しましょう。
  
スケジューラにどのスレッドタイプを利用すれば良いかが、最も重要な問題です。<br>
+
これはスケジュール処理のタスク定義の例です。
間違ったスレッドタイプを利用すると、検出が困難な障害を断続的に発生させる原因となります。<br>
+
<blockquote><source lang="java">
また、そのような障害は試験サーバでは発生せず、頻繁に連続稼動しているサーバでのみ発生する場合がある等、<br>
+
import org.bukkit.Bukkit;
再現性が低い障害となる場合もあるため、原因の特定を更に困難にします。
+
import org.bukkit.scheduler.BukkitRunnable;
  
Minecraftサーバはマルチスレッドであり、<br>
+
public class ExampleTask extends BukkitRunnable {
一つのメインサーバーのスレッドと、他のヘルパースレッドが存在します。
 
  
多くのデータ構造は、サーバのメインスレッドからのみアクセスされます。<br>
+
    @Override
別のスレッドからこれらのデータを変更しようとすると、<br>
+
    public void run() {
2つのスレッドが同時にデータにアクセスする事になるため、<br>
+
        // スケジュールで実行する処理の内容をここに書きます。
データ破損を引き起こす可能性があります。
+
        Bukkit.broadcastMessage("サーバーへようこそ!説明文をちゃんと読んでね!");
 +
    }
 +
}
 +
</source></blockquote>
  
メインスレッドは、サーバーのCPU時間の配分を処理します。<br>
+
=== 実装した処理のスケジューリング ===
このスレッドは、他のタスクへCPU時間を配分するために、秒間20回のスリープを実行します。
 
  
少数のBukkitAPIはスレッドセーフです。<br>
+
タスクを定義した後、プラグインは、タスクをスケジュールする必要があります。<br>
あなたのプラグインが使っているAPIがスレッドセーフなものである事を確認していない限り、<br>
+
BukkitRunnable は、指定の時間になったら、タスクのインスタンスが起動され、メソッドが実行されます。<br>
基本的にBukkitAPIの命令はスレッドセーフではないものとして開発して下さい
+
詳細は、BukkitRunnableのjavadoc を参照してください。<br>
 +
これらのメソッドは共通して、BukkitTaskクラスのオブジェクトを返します。
  
==== 同期タスク ====
+
これは、プレイヤーがログインしたら、20ticks(=1秒)後にタスクを実行するスケジューラを登録する実装例です。
サーバのメインスレッドが実行するタスクです。
+
<blockquote><source lang="java">
 +
import org.bukkit.event.EventHandler;
 +
import org.bukkit.event.Listener;
 +
import org.bukkit.event.player.PlayerJoinEvent;
 +
import org.bukkit.plugin.java.JavaPlugin;
  
:'''重要''': '''このスレッドが停止すると、サーバがフリーズします。'''
+
public class ExamplePlugin extends JavaPlugin implements Listener {
  
<br> メインスレッドは下記の用途に'''使えます'''
+
    @Override
* スケジューラメソッドの呼び出し
+
    public void onEnable() {
** スケジューラの戻り値を取得する際は注意を要します(後方の説明に記載)
+
        getServer().getPluginManager().registerEvents(this, this);
*停止・待機処理を行わないタスク
+
    }
  
<br> メインスレッドは下記の用途に'''使わなくてはいけません'''
+
    @EventHandler
*Bukkit APIのメソッドを呼び出すタスク(スレッドセーフな方法を除く)
+
    public void onJoin(PlayerJoinEvent event) {
 +
        // BukkitRunnableを継承したExampleTaskを生成し、
 +
        // runTaskLater メソッドで20ticks後に実行するように設定します。
 +
        new ExampleTask().runTaskLater(this, 20);
 +
    }
 +
}
 +
</source></blockquote>
  
<br> メインスレッドは下記の用途に'''使ってはいけません'''
+
== 自己キャンセルの実装例 ==
*自スレッドをスリープ状態にするタスク
 
**停止・待機処理を含むスレッド。(例:ネットワーク通信の受信タスク)
 
  
 +
今度は、プレイヤーがログインしたら、10ticks待った後、20ticksごとに5回実行し、その後スケジューラの処理をキャンセルする例を示します。
  
メインスレッド上で同期タスクを実行する事自体は良いのですが、<br>
+
'''ExampleSelfCancelingTask.java'''
待機や停止の時間がほぼゼロであるものに限ります。<br>
 
:'''訳者注''': 1つの処理ステップが長時間を費やす処理は、サーバ自体をその間待機状態に置いてしまうため、メインスレッド上で行うべきではない事を説明しています。
 
  
==== 非同期タスク ====
+
<blockquote><source lang="java">
 +
import org.bukkit.plugin.java.JavaPlugin;
 +
import org.bukkit.scheduler.BukkitRunnable;
  
非同期タスクは、サーバのメインスレッド以外のスレッドによって実行されます。専用のタスクとして実行されるため、同期タスクで説明したような問題を引き起こすことなく、自タスクを停止・スリープ状態にする事ができます。この特性は、同期タスクの真逆に相当します。
+
public class ExampleSelfCancelingTask extends BukkitRunnable {
  
<br> 非同期タスクは下記の用途に'''利用できます'''
+
    private final JavaPlugin plugin;
  
*スケジューラメソッドの呼び出し
+
    private int counter;
*プラグインAPIを利用しないタスク
 
  
<br> 非同期タスクは下記の用途に'''利用しなければなりません'''
+
    public ExampleSelfCancelingTask(JavaPlugin plugin, int counter) {
 +
        this.plugin = plugin;
 +
        if (counter < 1) {
 +
            throw new IllegalArgumentException("counter には1以上を指定してください。");
 +
        } else {
 +
            this.counter = counter;
 +
        }
 +
    }
  
*自スレッドをスリープ状態にするタスク
+
    @Override
**停止・待機処理を含むスレッド。(例:ネットワーク通信の受信タスク)
+
    public void run() {
 +
        // ここに、スケジュールの処理内容を実装します。
 +
        if (counter > 0) {
 +
            plugin.getServer().broadcastMessage("広告が表示されるまで、あと " + counter-- + "秒");
 +
        } else {
 +
            plugin.getServer().broadcastMessage("サーバーへようこそ!説明文をちゃんと読んでね!");
 +
            this.cancel();
 +
        }
 +
    }
 +
}
 +
</source></blockquote>
  
<br> 非同期タスクは下記の用途に'''利用してはいけません'''
 
  
*Bukkit APIのメソッドを呼び出すタスク(スレッドセーフな方法を除いては、下記参照)
+
'''ExamplePlugin.java'''
  
<br>
+
<blockquote><source lang="java">
 +
import org.bukkit.event.EventHandler;
 +
import org.bukkit.event.Listener;
 +
import org.bukkit.event.player.PlayerJoinEvent;
 +
import org.bukkit.plugin.java.JavaPlugin;
  
== タスクの種類 ==
+
public final class ExamplePlugin extends JavaPlugin implements Listener {
タスクには、連続タスク, 遅延タスク, 戻り値を返すタスク, の3種類があります。
 
  
APIのインタフェースの仕様については[[https://github.com/Bukkit/Bukkit/blob/master/src/main/java/org/bukkit/scheduler/BukkitScheduler.java こちら]]を参照して下さい。
+
    @Override
 +
    public void onEnable() {
 +
        getServer().getPluginManager().registerEvents(this, this);
 +
    }
  
=== 遅延タスク ===
+
    @EventHandler
 +
    public void onJoin(PlayerJoinEvent event) {
 +
        // スケジューリングする
 +
        new ExampleSelfCancelingTask(this, 5).runTaskTimer(this, 10, 20);
 +
    }
 +
}
 +
</source></blockquote>
  
一定の遅延を置いてから実行されるタスクです。遅延時間にはゼロを指定可能です。
+
== 無名クラスを使用した実装例 ==
  
==== 具体例 ====
+
毎回BukkitRunnableを継承したクラスを作成していると大変なので、BukkitRunnableを無名クラスとして内部に実装した例も示します。<br>
 +
無名クラスを理解している場合は、こちらを使っても構いません。
  
This submits a task to the main thread to be executed after 3 seconds.
 
 
<blockquote><source lang="java">
 
<blockquote><source lang="java">
myPlugin.getServer().getScheduler().scheduleSyncDelayedTask(myPlugin, new Runnable() {
+
import org.bukkit.event.EventHandler;
 +
import org.bukkit.event.Listener;
 +
import org.bukkit.event.player.PlayerJoinEvent;
 +
import org.bukkit.plugin.java.JavaPlugin;
 +
import org.bukkit.scheduler.BukkitRunnable;
  
  public void run() {
+
public final class ExamplePlugin extends JavaPlugin implements Listener {
      getServer().broadcastMessage("This message is broadcast by the main thread");
+
 
  }
+
    @Override
}, 60L);
+
    public void onEnable() {
 +
        getServer().getPluginManager().registerEvents(this, this);
 +
    }
 +
 
 +
    @EventHandler
 +
    public void onJoin(PlayerJoinEvent event) {
 +
        // 20ticks後に1度だけ実行される処理を、実装しつつ、そのままスケジュールします。
 +
       
 +
        new BukkitRunnable() {
 +
 
 +
            @Override
 +
            public void run() {
 +
                // スケジューラで実行される処理内容を、ここに実装します。
 +
                getServer().broadcastMessage(
 +
                    "サーバーへようこそ!説明文をちゃんと読んでね!");
 +
            }
 +
        }.runTaskLater(this, 20);
 +
        // ↑そのままスケジュールします。
 +
    }
 +
}
 
</source></blockquote>
 
</source></blockquote>
The time delay is 60. This counts in server ticks. There are 20 ticks per second, so the delay is 60/20 = 3.
 
  
This code could be executed by another thread. If the code
+
== BukkitScheduler ==
<blockquote><source lang="java">
 
getServer().broadcastMessage("This message is broadcast by an async thread");
 
</source></blockquote>
 
was executed by another thread, it could cause problems since the broadcastMessage method is being executed by another thread.
 
  
=== 繰り返しタスク ===
+
BukkitSchedulerは、[http://docs.oracle.com/javase/1.5.0/docs/api/index.html?java/lang/Runnable.html Runnable]クラスや[http://docs.oracle.com/javase/1.5.0/docs/api/index.html?java/util/concurrent/Callable.html Callable]クラスの、どちらかまたは両方を実装したクラスを、一定時間後に実行する機能を提供します。<br>
 +
詳細は、[http://jd.bukkit.org/rb/apidocs/index.html?org/bukkit/scheduler/BukkitScheduler.html BukkitSchedulerのjavadoc] を参照してください。<br>
 +
なお、BukkitSchedulerのメソッドで実行できる内容は、BukkitRunnableのメソッドで実行できる内容と全く同じです。
  
繰り返し実行されるタスクです。遅延時間も設定可能です。
+
{{warning}} ただし、BukkitSchedulerでBukkitRunnableを実行することも可能ですが、BukkitRunnableのcancel()メソッドを使ってスケジューラをキャンセルすることができないことに注意してください。<br>
 +
{{warning}} この実装方法は、CraftBukkit 1.7.10-R0.1 で非推奨に設定されました。今後は前述のBukkitRunnableのメソッドを呼び出す方法を使用してください。
  
==== 具体例 ====
+
=== 実装例1 ===
  
This submits a task to an async thread to be executed after 3 seconds with a period of 10 seconds.
+
無名クラスでRunnableを実装し、20ticks後に実行される例を示します。
 
<blockquote><source lang="java">
 
<blockquote><source lang="java">
myPlugin.getServer().getScheduler().scheduleAsyncRepeatingTask(myPlugin, new Runnable() {
+
import org.bukkit.Bukkit;
 +
import org.bukkit.plugin.java.JavaPlugin;
 +
import org.bukkit.scheduler.BukkitScheduler;
  
  public void run() {
+
public final class ExamplePlugin extends JavaPlugin {
      System.out.println("This message is printed by an async thread");
+
    public void onEnable() {
  }
+
        BukkitScheduler scheduler = Bukkit.getServer().getScheduler();
}, 60L, 200L);
+
        scheduler.scheduleSyncDelayedTask(this, new Runnable() {
 +
            @Override
 +
            public void run() {
 +
                // ここに処理を実装する。
 +
            }
 +
        }, 20L);
 +
    }
 +
}
 
</source></blockquote>
 
</source></blockquote>
  
Both times count in server ticks. The initial delay is 60/20 = 3 seconds and the period is 200/20 = 10 seconds.
+
=== 実行例2 ===
  
The above code will print "This message is printed by an async thread" every 10 seconds.
+
無名クラスでRunnableを実装し、20ticksごとにプラグインが終了するまでずっと実行され続ける例を示します。
 
 
=== 戻り値を返すタスク ===
 
 
 
スケジューラから戻り値を返す事ができるタスクです。メインスレッドから実行可能なタスクです。
 
 
 
この仕組みの目的は、他タスクから呼ばれたAPIのメソッドに戻り値を返させる事です。
 
 
 
スケジューラは、戻り値として返されるであろうオブジェクトを取得可能にします。
 
 
 
==== 具体例 ====
 
 
<blockquote><source lang="java">
 
<blockquote><source lang="java">
Future<String> returnFuture = myPlugin.getServer().getScheduler().callSyncMethod(myPlugin, new Callable<String>() {
+
import org.bukkit.Bukkit;
 
+
import org.bukkit.plugin.java.JavaPlugin;
  public String call() {
+
import org.bukkit.scheduler.BukkitScheduler;
      return "This is the string to return";
 
  }
 
  
});
+
public final class ExamplePlugin extends JavaPlugin {
 
+
     public void onEnable() {
try {
+
        BukkitScheduler scheduler = Bukkit.getServer().getScheduler();
     // This will block the current thread
+
        scheduler.scheduleSyncRepeatingTask(this, new Runnable() {
    String returnValue = returnFuture.get();
+
            @Override
    System.out.println(returnValue);
+
            public void run() {
} catch (InterruptedException e) {
+
                // ここに処理を実装する。
    System.out.println("Interrupt triggered which waiting on callable to return");
+
            }
} catch (ExecutionException e) {
+
        }, 0L, 20L);
    System.out.println("Callable task threw an exception");
+
     }
     ee.getCause().printStackTrace();
 
 
}
 
}
 
</source></blockquote>
 
</source></blockquote>
  
This will submit the callable and then use the Future.get() method. This method sleeps the current thread until the Callable has returned a value and gets the result.
+
=== BukkitTask ===
 
 
===== メインスレッドからの利用 =====
 
この方法は'''非推奨'''です。
 
この仕組みは、メインスレッドから利用される事を想定したものではありません。
 
  
<code>''.get()''</code>メソッドを利用している場合、メインスレッドがこのタスクを完了するまでの間、現行スレッド(=メインスレッド)をスリープ状態にします。
+
BukkitTaskクラスのオブジェクトは、Runnableがスケジュールされたときに返されます。<br>
 +
このオブジェクトは、スケジューラにより実行されるスケジュールタスクを表現しています。<br>
 +
詳細は、[http://jd.bukkit.org/rb/apidocs/index.html?org/bukkit/scheduler/BukkitTask.html BukkitTaskのjavadoc] を参照してください。
  
どうしてもメインスレッド上で使用する必要がある場合は、返されるであろうスケジューラの戻り値に対する<code>''.get()''</code>メソッドを呼び出す前に、<code>''.isDone()''</code>メソッドをチェックしなければなりません。さもなくばメインスレッドは、メインスレッド自身がタスクを完了させるまでスリープ状態になります。
+
=== Callable と Future  ===
  
== Thread Safe API Methods  ==
+
Callableクラスは、同期処理を呼び出したときに、[http://docs.oracle.com/javase/1.5.0/docs/api/index.html?java/util/concurrent/Future.html Future]クラスのオブジェクトを返します。<br>
 +
これはJavaで提供されている機能やクラスです。<br>
 +
詳細は、[http://docs.oracle.com/javase/1.5.0/docs/api/index.html?java/util/concurrent/Callable.html Callableのjavadoc] や、[http://docs.oracle.com/javase/1.5.0/docs/api/index.html?java/util/concurrent/Future.html Futureのjavadoc] を参照してください。
  
Bukkit API methods which are thread safe are:
+
== スレッドの安全性のためのヒント ==
  
*All the scheduler methods
+
1. 非同期実行タスクは、BukkitのAPIを直接実行してはいけません。<br>
*[http://jd.bukkit.org/apidocs/org/bukkit/Bukkit.html#getServer() Bukkit.getServer()]
+
2. 非同期タスクのコレクションにアクセスしたり、内容を変更しないでください。通常のコレクションはスレッドセーフではありません。<br>
*[http://jd.bukkit.org/apidocs/org/bukkit/Server.html#getBukkitVersion() Server.getBukkitVersion()]
+
3. 非同期タスクは、同期タスクをスケジュールすることができます。<br>
*[http://jd.bukkit.org/apidocs/org/bukkit/World.html#getUID() World.getUID()]
+
4. 同期タスクは、非同期タスクをスケジュールすることができます。
*[http://jd.bukkit.org/apidocs/org/bukkit/World.html#getMaxHeight() World.getMaxHeight()]
 
*[http://jd.bukkit.org/apidocs/org/bukkit/World.html#getSeed() World.getSeed()]
 
*[http://jd.bukkit.org/apidocs/src-html/org/bukkit/World.html#line.51 World.getBlockTypeIdAt(int x, int y, int z)]
 
*[http://jd.bukkit.org/apidocs/org/bukkit/entity/Entity.html#getEntityId() Entity.getEntityId()]
 
*[http://jd.bukkit.org/apidocs/org/bukkit/entity/Entity.html#getUniqueId() Entity.getUniqueId()]
 
**This list is not complete....
 

2014年8月12日 (火) 23:00時点における最新版

スケジューラのプログラミング[編集]

このチュートリアルでは、bukkit によって提供されているスケジューラの使用方法をガイドします。
スケジューラは、指定の時間後に実行される処理を書くことができます。
これはリスナーやイベントへの応答で実行されるコードの記述方法とは異なります。
また、繰り返しや、遅延の有無を設定したりすることもできます。この繰り返し処理は、処理が完了するか、キャンセルされるか、プラグインが無効になるまで実行できます。

スケジューラを利用した実装は、次のような手順を踏んでください。

  1. まず、スケジューラにより実行される処理内容を、BukkitRunnable を継承したクラスの run()メソッドで実装します。
  2. 次に、前のステップで実装したクラスをインスタンス化し、スケジュールをしたい箇所で、runTaskLaterメソッドやrunTaskTimerメソッドなどを実行するように設定します。

BukkitRunnable[編集]

BukkitRunnableは、 抽象クラスRunnableの実装クラスです。
Runnableに無い便利な機能として、自身の処理を再スケジュールしたり、キャンセルしたりできることです。

処理の実装例[編集]

スケジューラの処理を定義するには、まず BukkitRunnable を extends しましょう。

これはスケジュール処理のタスク定義の例です。

import org.bukkit.Bukkit;
import org.bukkit.scheduler.BukkitRunnable;

public class ExampleTask extends BukkitRunnable {

    @Override
    public void run() {
        // スケジュールで実行する処理の内容をここに書きます。
        Bukkit.broadcastMessage("サーバーへようこそ!説明文をちゃんと読んでね!");
    }
}

実装した処理のスケジューリング[編集]

タスクを定義した後、プラグインは、タスクをスケジュールする必要があります。
BukkitRunnable は、指定の時間になったら、タスクのインスタンスが起動され、メソッドが実行されます。
詳細は、BukkitRunnableのjavadoc を参照してください。
これらのメソッドは共通して、BukkitTaskクラスのオブジェクトを返します。

これは、プレイヤーがログインしたら、20ticks(=1秒)後にタスクを実行するスケジューラを登録する実装例です。

import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.event.player.PlayerJoinEvent;
import org.bukkit.plugin.java.JavaPlugin;

public class ExamplePlugin extends JavaPlugin implements Listener {

    @Override
    public void onEnable() {
        getServer().getPluginManager().registerEvents(this, this);
    }

    @EventHandler
    public void onJoin(PlayerJoinEvent event) {
        // BukkitRunnableを継承したExampleTaskを生成し、
        // runTaskLater メソッドで20ticks後に実行するように設定します。
        new ExampleTask().runTaskLater(this, 20);
    }
}

自己キャンセルの実装例[編集]

今度は、プレイヤーがログインしたら、10ticks待った後、20ticksごとに5回実行し、その後スケジューラの処理をキャンセルする例を示します。

ExampleSelfCancelingTask.java

import org.bukkit.plugin.java.JavaPlugin;
import org.bukkit.scheduler.BukkitRunnable;

public class ExampleSelfCancelingTask extends BukkitRunnable {

    private final JavaPlugin plugin;

    private int counter;

    public ExampleSelfCancelingTask(JavaPlugin plugin, int counter) {
        this.plugin = plugin;
        if (counter < 1) {
            throw new IllegalArgumentException("counter には1以上を指定してください。");
        } else {
            this.counter = counter;
        }
    }

    @Override
    public void run() {
        // ここに、スケジュールの処理内容を実装します。
        if (counter > 0) {
            plugin.getServer().broadcastMessage("広告が表示されるまで、あと " + counter-- + "秒");
        } else {
            plugin.getServer().broadcastMessage("サーバーへようこそ!説明文をちゃんと読んでね!");
            this.cancel();
        }
    }
}


ExamplePlugin.java

import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.event.player.PlayerJoinEvent;
import org.bukkit.plugin.java.JavaPlugin;

public final class ExamplePlugin extends JavaPlugin implements Listener {

    @Override
    public void onEnable() {
        getServer().getPluginManager().registerEvents(this, this);
    }

    @EventHandler
    public void onJoin(PlayerJoinEvent event) {
        // スケジューリングする
        new ExampleSelfCancelingTask(this, 5).runTaskTimer(this, 10, 20);
    }
}

無名クラスを使用した実装例[編集]

毎回BukkitRunnableを継承したクラスを作成していると大変なので、BukkitRunnableを無名クラスとして内部に実装した例も示します。
無名クラスを理解している場合は、こちらを使っても構いません。

import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.event.player.PlayerJoinEvent;
import org.bukkit.plugin.java.JavaPlugin;
import org.bukkit.scheduler.BukkitRunnable;

public final class ExamplePlugin extends JavaPlugin implements Listener {

    @Override
    public void onEnable() {
        getServer().getPluginManager().registerEvents(this, this);
    }

    @EventHandler
    public void onJoin(PlayerJoinEvent event) {
        // 20ticks後に1度だけ実行される処理を、実装しつつ、そのままスケジュールします。
        
        new BukkitRunnable() {

            @Override
            public void run() {
                // スケジューラで実行される処理内容を、ここに実装します。
                getServer().broadcastMessage(
                    "サーバーへようこそ!説明文をちゃんと読んでね!");
            }
        }.runTaskLater(this, 20);
        // ↑そのままスケジュールします。
    }
}

BukkitScheduler[編集]

BukkitSchedulerは、RunnableクラスやCallableクラスの、どちらかまたは両方を実装したクラスを、一定時間後に実行する機能を提供します。
詳細は、BukkitSchedulerのjavadoc を参照してください。
なお、BukkitSchedulerのメソッドで実行できる内容は、BukkitRunnableのメソッドで実行できる内容と全く同じです。

Attention.pngWarning: ただし、BukkitSchedulerでBukkitRunnableを実行することも可能ですが、BukkitRunnableのcancel()メソッドを使ってスケジューラをキャンセルすることができないことに注意してください。
Attention.pngWarning: この実装方法は、CraftBukkit 1.7.10-R0.1 で非推奨に設定されました。今後は前述のBukkitRunnableのメソッドを呼び出す方法を使用してください。

実装例1[編集]

無名クラスでRunnableを実装し、20ticks後に実行される例を示します。

import org.bukkit.Bukkit;
import org.bukkit.plugin.java.JavaPlugin;
import org.bukkit.scheduler.BukkitScheduler;

public final class ExamplePlugin extends JavaPlugin {
    public void onEnable() {
        BukkitScheduler scheduler = Bukkit.getServer().getScheduler();
        scheduler.scheduleSyncDelayedTask(this, new Runnable() {
            @Override
            public void run() {
                // ここに処理を実装する。
            }
        }, 20L);
    }
}

実行例2[編集]

無名クラスでRunnableを実装し、20ticksごとにプラグインが終了するまでずっと実行され続ける例を示します。

import org.bukkit.Bukkit;
import org.bukkit.plugin.java.JavaPlugin;
import org.bukkit.scheduler.BukkitScheduler;

public final class ExamplePlugin extends JavaPlugin {
    public void onEnable() {
        BukkitScheduler scheduler = Bukkit.getServer().getScheduler();
        scheduler.scheduleSyncRepeatingTask(this, new Runnable() {
            @Override
            public void run() {
                // ここに処理を実装する。
            }
        }, 0L, 20L);
    }
}

BukkitTask[編集]

BukkitTaskクラスのオブジェクトは、Runnableがスケジュールされたときに返されます。
このオブジェクトは、スケジューラにより実行されるスケジュールタスクを表現しています。
詳細は、BukkitTaskのjavadoc を参照してください。

Callable と Future[編集]

Callableクラスは、同期処理を呼び出したときに、Futureクラスのオブジェクトを返します。
これはJavaで提供されている機能やクラスです。
詳細は、Callableのjavadoc や、Futureのjavadoc を参照してください。

スレッドの安全性のためのヒント[編集]

1. 非同期実行タスクは、BukkitのAPIを直接実行してはいけません。
2. 非同期タスクのコレクションにアクセスしたり、内容を変更しないでください。通常のコレクションはスレッドセーフではありません。
3. 非同期タスクは、同期タスクをスケジュールすることができます。
4. 同期タスクは、非同期タスクをスケジュールすることができます。