JavaScriptによるプラグインテンプレート

以下に、最小限のプラグインテンプレートを示します。 インターフェイスが認識できればいいので、これ以外にもいくつか書き方はあります。

// ファイル形式はUTF-8で保存すること
// Please file format to UTF-8.
importPackage(com.tojc.minecraft.mod.ChatLoggerPlusPlugin.v1);

var name = "plugin name";
var version = "1.0.0";
var description = "plugin description";
var auther = "your name";

var plugin = new PluginInterface()
{
    onInitialize: function(settings)
    {
        debug.log(name, "onInitialize");
    },

    onChatMessage: function(env, chat)
    {
        debug.log(name, "onChatMessage");
    },

    onFinalize: function()
    {
        debug.log(name, "onFinalize");
    },
};

このテンプレートをダウンロードする場合は、以下のtemplate.jsを右クリックして「名前を付けて保存」で保存してください。

template.js

プラグイン骨格の説明

importPackage定義

importPackage(com.tojc.minecraft.mod.ChatLoggerPlusPlugin.v1);

プラグインインターフェイスを定義しているパッケージ名を指定しています。 これは、このままおまじないとして固定で定義してください。

プラグインの基本情報の定義

var name = "plugin name";
var version = "1.0.0";
var description = "plugin description";
var auther = "your name";

プラグインの名前、バージョン、説明、作者名をここで定義します。 この値は利用者が画面上で確認できるようにするためのものです。

詳細は global も参照ください。

プラグインの本体の定義

var plugin = new PluginInterface(){};

プラグインの処理を定義します。 ここには、 PluginInterface を実装したオブジェクトを渡さなければなりません。

インターフェイスの詳細は、 PluginInterface を参照してください。

インターフェイスを実装してさえいれば、異なる書き方でも構いません。（JavaScriptでは、いくつかの記述方法があります）

ログ出力について

debug.log(name, "ログに出力する内容");

デバッグ用のログ出力メソッドです。グローバルに定義されているため、どこからでも呼び出せます。 プラグイン基本情報のnameと、ログに出力したい文字を渡してください。

また、このメソッドは、com.tojc.minecraft.mod.ChatLoggerPlus.cfgファイルの設定を参照して、実際にログを出力するかを判断します。 プラグインを配布するときもdebug.logを記述したまま配布可能です。

※設定は、outputofdebuglogのOutputLoggingScriptをtrueにすることで、出力できるようになります。

ノート

一般公開前のDevelop版では、ログ出力をprintlnで行っていましたが、別途ログ出力用のdebug.logメソッドを用意しました。 これは、config設定で出力の有無を設定できるようになっているため、利用者が出力の有無を切り替えることができます。 このため、出来るだけdebug.logメソッドを使うようにしてください。