資料集プラグインについて
コードはUTF8で記述してください。
また、プラグインの仕様は、追加・変更される可能性があります。
プラグインの概要
プラグインの概要を説明します。
プラグインは、スクリプトプラグインを想定しています。スクリプトプラグインは本ソフト上で管理され、本ソフトのUI上でパラメータ指定ができます。(オートタイルプラグイン、独自アクションコマンドプラグイン、独自リンク条件プラグインなど)
スクリプトの対応言語はJavaScriptとします。スクリプトプラグインをCoffeeScriptで記述することもできます。CoffeeScriptは自動的にJavaScriptにコンバートされて使用されます。
スクリプトプラグインは本ソフトのツール「プラグイン」で追加することができます。追加されたプラグインはプロジェクトフォルダ内のpluginsフォルダに保存されます。JavaScriptファイルの拡張子はjs、CoffeeScriptの拡張子は.coffeeとします。CoffeeScriptはプラグインの読込や更新の時に自動的にJavaScriptに変換され、拡張子がjsのファイルとしてpluginsフォルダに保存されます。
スクリプトプラグインの多言語対応のため、本ソフトのロケールがsetLocale()関数で指定されます。スクリプトプラグインの内部処理で戻り値の言語を切り替えることにより、多言語対応が可能になります。ja_JPのように地域識別文字列が付いていますが、地域が不要であれば先頭の2文字を切り出して利用してください。
スクリプトプラグインはスクリプトファイルロード時にJavaScriptオブジェクト(スクリプトプラグインオブジェクト)を返す必要があります。ロードに失敗(JavaScriptの解析に失敗)した場合や、getInfoで情報を取得できない場合は、破棄されます。グローバル領域を汚さないようにしてください。スクリプトプラグインオブジェクトはAgtk.pluginsに格納されます。(スクリプトプラグインオブジェクトはAgtk.plugins[<プラグインID>]でアクセスできます)
現時点でスクリプトプラグインオブジェクトは次の関数を提供する必要があります。
getInfo | 関数 |
---|---|
initialize | 関数 |
finalize | 関数 |
call | 関数 |
setLocale | 関数 |
update | 関数(※省略可能) |
スクリプトプラグインではcocos2d-xのJSB APIを呼び出すことができます。
http://www.cocos2d-x.org/docs/api-ref/js/v3x/
詳細な仕様について
プラグインの詳細な仕様については、以下のpdfをご確認ください。