sprite_add()

リソース操作・スプライト

sprite_add †

画像ファイルからスプライトアセットを追加します

構文 †

sprite_add(fname, imgnumb, removeback, smooth, xorig, yorig);

fname

画像ファイル名（文字列）

imgnum

サブイメージの数（単一画像であれば「1」）。GIF画像ではこの引数は使用されず「0」にします

removeback

true or false。背景色（画像左下のピクセル色で透過する）を有効にするかどうか。

smooth

true or false。エッジを滑らかにするかどうか

xorig

スプライトの原点のX座標

yorig

スプライトの原点のY座標

戻り値 †

Real

追加したスプライトのインデックス番号

説明 †

この関数を使用すると、外部リソースとして画像ファイル(PNGのみ)をロードし、アセットに追加することができます。 戻り値のスプライトのインデックス番号は、すべてのsprite_*関数で使用することができます。 HTML5でURL指定で画像を取得する場合には、非同期イベントを生成し取得を行います。

アニメーションスプライトとする画像は、stripフォーマットにする必要があります。 （下記の画像参照）

指定の画像の幅÷サブイメージの数＝ストリップされた画像の幅

という計算式となります。

この画像では、背景色が濃い紫色となっていますが、引数「removeback」をtrueにすることによりこの背景を透過することができます。 これは画像の一番左下の色を透過します。例えば一番左下が緑色であれば、緑色のピクセルが透過されます。

引数「smooth」をtrueにすると、スプライトのエッジを滑らかにすることができます。これは背景が透過されていた場合、 そのエッジに半透明の境界を作成します。

デフォルトでは、すべての新しいスプライトの境界ボックスは、automaticallyになっています。これを変更するには、 関数sprite_collsion_mask()?を使用することで、カスタマイズが可能となります。

注意 †

この関数で動的にロードし不要なスプライトを削除しないと、メモリリークとなり、ゲームのパフォーマンス低下、 ひいてはゲームをクラッシュさせる危険性があります。 そのため、不要なスプライトはsprite_delete()で削除する必要があります。

例 †

spr = sprite_add("player_5.png", 16, true, true, 0, 0);

上記コードは、スプライトを動的にロードし、変数"spr"にそのインデックス番号を格納しています