AIMS+BISHAMON 仕様書

2012/05/30現在 v1.70準拠
文責:D.N.A. (D.N.A.Softwares) dna@dna-softwares.com

AIMSでBISHAMONを取り扱う流れ

基本的には文字列アクターのように、アクターの特殊扱いの一つとなります。

BISHAMONエフェクトに限り配置ルールが規定されています。boot.luaが置かれているディレクトリを基準に、

それぞれ配置してください。なお、上記ディレクトリはアプリケーションコンフィグで変更できます。

hBMEfx = loadBMEffect("filename.bmb")でファイルを読み込みます。ファイル名にはディレクトリ名を含めることができません。

エフェクト生成はcreateActorと同じ文法で、

hActor = createActor(hBMEfx,x,y[,angle,speed],layer[,"class"]);

とできます。

アクターですので、Mover操作のほとんどが適用できます。ただし、普通のアクターとは一部動作が違ったり適用できない操作があったりします。

エフェクトの「消去」はvanish関数などで大丈夫ですが、エフェクトを「停止」させる場合はstopBMEffect(hActor)とします。この場合はエフェクトの生成をやめ、残ったパーティクル等が消滅したあと、アクター消滅となります。

hBMEfxの解放は普通の画像同様、deleteGraphic(hBMEfx)でOKです。

注意事項

関数

loadBMEffect

hBMEfx = loadBMEffect("filename.bmb");

入力

filename.bmb        読み込むbmbファイル名(ディレクトリ名を含まないこと)

戻り値

hBMEfx        エフェクトのハンドル

説明

コンバータで変換した後のBISHAMONエフェクトファイルを読み込む。この関数は同時にエフェクトに付随するテクスチャとモデル、および子エフェクトも読み込む。

エフェクトファイルとテクスチャ・モデルはそれぞれ配置が決められており

それぞれ配置すること。

createBMEffectActor

hActor = createBMEffectActor(hBMEfx,x,y[,angle,speed],layer[,"class"]);

入力

hBMEfx        loadBMEffectで得たエフェクトのハンドル

x,y        生成座標X,Y

angle        移動方向の初期値(deg)

speed        移動速度の初期値(pixel/frame)

layer        生成先のレイヤー

class        アクタークラス指定

戻り値

hActor        生成したアクターのハンドル

説明

グラフィックチップのかわりにエフェクトを描画するアクターを生成する。このアクターは配置されたら直ちに指定されたエフェクトを再生・描画しはじめ、再生が終了すると自動的に消滅する。


stopBMEffect

stopBMEffect(hActor);

入力

hActor        createBMEffectActorで生成したアクターのハンドル

戻り値

なし

説明

動作中のエフェクトを止める。アクターはすぐ消滅せず、パーティクルがすべて消えたあとに消滅となる。hActorはcreateBMEffectActorで得たアクターハンドルのみ有効。それ以外のアクターにこの操作を行うとエラーとなる。

deleteBMEffect

deleteBMEffect(hBMEfx);

入力

hBMEfx        loadBMEffectで得たエフェクトのハンドル

戻り値

なし

説明

指定したエフェクトハンドルを解放する。もしエフェクトが存在する状態でこれを実行すると不正処理で落ちるので、必ずclsなりvanishなりでこのエフェクトを呼んでいるアクターをすべて消しておくこと。

アプリケーションコンフィグの設定項目

BMEFX_BINARY_PATH

BMEFX_BINARY_PATH = "path";

説明

バイナリファイルの参照パスを指定。デフォルトでは bmefx/bmsln/ になっている。パス区切り記号は/と\のいずれでもいい(\を使う場合は"\\"とすること)。パス指定の最後は必ず"/"か"\"で終わること。この規定は以下の項目でも同様。

BMEFX_MODEL_PATH

BMEFX_MODEL_PATH = "path";

説明

モデルファイルとそれに付随するテクスチャファイルの参照パスを指定。デフォルトは bmefx/model/。

BMEFX_TEXTURE_PATH

BMEFX_TEXTURE_PATH = "path";

説明

モデルファイルに関係しないテクスチャファイルの参照パスを指定。デフォルトは bmefx/texture/。