ティラノスクリプト:プラグインを作ってみよう

最新版のティラノビルダーで外部プラグイン機能が実装されるようです。

外部リンク:TYRANOS「ティラノビルダーV182のアップデート予告」

プラグインの開発については外部にも開放されるとのことですので、アップデートの前にプラグインの作りかたについて書いておこうと思います。



1.プラグインのファイル構造


例として、うちで配布しているテーマ一括変換プラグインのフォルダを開いてみます。


テーマプラグインの構造


プラグインによってファイルの種類は変わってきますので、ここでは「プラグインの作成に最低必要なのは init.ks ファイル」ということだけ覚えておけば大丈夫です。



2.プラグインの仕様を考える


何をするプラグインをつくるか考えます。

  • 数値に3ケタ区切りでカンマをつけるプラグイン
  • emb、ptext で使えるようにしたい
  • 名前は addcomma プラグインにしよう

( ゚д゚) < はい、決まり決まり!作るよ!

最初から難しいものを作ろうとしなくていいです。大事なのは完成させることです。



3.プラグインの中身をつくる


はじめに、数値に3ケタ区切りでカンマをつける関数を作ります。
スクリプトの解説は今回のネタとは関係ないので端折ります。


/* 3ケタ区切りでカンマ付与 */
addComma = function(num){
 if(!num || typeof num !== 'number'){
  alert('引数numには《数値》を指定してください');
  return num;
 }
 return num.toLocaleString();
}

これを addcomma.js という名前の JavaScript ファイルで保存します。



4.init.ksファイルをつくる


init.ks はプラグインを読み込んだ際、最初に呼び出されるファイルです。
プラグインを使用するために必要なファイルをココで読み込ませています。
今回は3で作った addcomma.js を読み込ませたいので、次の1行を記述します。

[ loadjs storage="plugin/addcomma/addcomma.js" ]

今回はこのファイルだけですが、読み込むファイルは複数あっても構いません。
すべてのファイルを読み込ませたら最後に [ return ] をつけるのを忘れないようにしましょう。これがないと init.ks から戻れなくなりシナリオの進行が止まってしまいます。



補足・相対パスのこと


プラグインを作成するときに引っかかりやすいのが、使用する画像やファイルの相対パスの指定です。ここを間違えるとシナリオ進行が停止するエラーが発生します。

通常は index.html があるディレクトリを基点として下へ掘り下げていくのですが、今回の記事で取り上げている [ loadjs ] タグは、読む込むファイルを others 以下に配置する仕様になっているため、そのひとつ下の階層である plugin フォルダから指定しています。



5.init.ks と必要なファイルをひとつのフォルダにまとめる


3と4で作成したファイルをひとつのフォルダに詰め込みます。
新規フォルダを作成し「addcomma」と名前をつけ、その中に init.ks と addcomma.js ファイルを入れます。これでプラグインは完成です。



6.正常に動作するかチェックする


テスト用のプロジェクトファイルを作ってプラグインを読み込ませます。
シナリオファイルにスクリプトを書き、きちんと動くかどうかを確認します。

とくに忘れやすいのがセーブデータを読み込んだときの動作です。
内容によっては make.ks で再構築が必要なこともあるので注意しましょう。



7.完成


( ゚д゚)< 配布するときはドキュメントを書こうね

  • 何をするためのプラグインか
  • プラグインの使いかた
  • 動作を確認したティラノスクリプトのバージョン
  • 自分の連絡先
  • 更新履歴

このくらいあれば大丈夫だと思います。



ざっくりまとめ


  • プラグインには init.ks が絶対に必要
  • init.ks はプラグインを読み込む際、最初に呼び出される
  • プラグインに必要なファイルや画像は init.ks 内で呼び出す
  • すべてのファイルを読み込んだら [ return ] で戻る

では、今回はこれにてー

関連記事

Comments 0

There are no comments yet.

Leave a reply