ExportForYourProject/Flow

2022-01-02 (日) 13:49:07 (932d)


埋め込み用出力

  • ファイル > 埋め込み用出力... メニューを実行すると、ゲーム等に組み込んで使用するため必要情報のみで構成された pxls ファイルを出力できます。
  • pxls は再度 PixelLiner で読み込むこともできますが、情報量が減っています。

Unity で pxls バイナリファイルを扱う


ver 0.7 ( 22/01/02 Updated )


  1. PixelLiner で 埋め込み用出力... ダイアログ内の「Unity 用出力」にチェックを入れ、 **.pxls.bytes (** は任意のファイル名) ファイルを出力します。
    • Unity でバイナリファイルを読み込むためには .bytes 拡張子を付与する必要があります。
  2. ここからは Unity での作業です。アセットフォルダ内に出力した **.pxls.bytes ファイルと、PixelLinerForUnity パッケージから読み込んだ PixelLiner ライブラリが、 Project タブ上に存在することを確認して下さい。
    http://pixelliner.sakura.ne.jp/img/190621_224021.png
  3. シングルトンな GameObject ( Camera などでも良いです ) に Pxls Loader コンポーネントをアタッチし、2. で用意した pxls ファイルと、それに対応するタイトルを Targets 配列に記述します。
    http://pixelliner.sakura.ne.jp/img/unity00.gif
    • Pixels Per Unit - 1ユニットに対するピクセル数を設定します。 Targets で指定した全ての pxls ファイルに適用されます。
    • Auto Flip X - true に設定すると、PixelLiner 上で「左方向の絵を描いたが、右方向は用意していない」時に、右方向を表示する場合に自動的に左右反転して表示します。 false に設定すると左向きの絵をそのまま表示します。
    • pxls ファイル毎に Pixels Per Unit の数値等を個別に変えたい場合は、 Pxls Loader コンポーネントを持つ GameObject を複数個用意して下さい。
    • title はプロジェクト内で他の pxls ファイルとの重複がないように設定して下さい。
    • PxlsLoader ではキャラクターファイルを非同期に読み込み/作成しますので、ロード待ちを行う場合は PixelLiner.PxlsLoader.isLoadCompletedAll() を使ってロードの完了を確認して下さい。
  4. 絵を表示したい GameObject に Pxl Chara Animator コンポーネントをアタッチし、 3. で設定した title と、初期ポーズ名を指定します。
    自動で MeshRenderer クラスがアタッチされるので、 Material に PixelLiner/PxlsMaterialNormal を設定します。
    http://pixelliner.sakura.ne.jp/img/unity01.gif
    • Allow Pose Jump - 「ジャンプ先ポーズ(jump to)」の指定がある場合に、アニメーションが終了したら自動的に別のポーズにジャンプします。
    • 加算合成などブレンドモードの変更などを実装したい場合は、適宜 shader を取り替えた別の Material を用意して下さい。
  5. スクリプト内で適宜 PixelLiner.PxlCharaAnimator コンポーネントにアクセスし、ポーズや向きの調節を行って下さい。

PNGファイルを外部に出力 ( 本体 Air版 ver 0.97.0 以降 )

  • デフォルトでは pxl ファイルと同様、pxlsファイルのバイナリデータにはPNGファイルが埋め込まれます。しかしこれを Resources/ 下に配置するのがメモリ的にNGな場合、PNGファイルを単体で出力した上で、Unity側のインスペクタから画像を指定して読み込むこともできます。
    1. PixelLiner で 埋め込み用出力... ダイアログ内の「PNGをファイル外に配置」をチェックしてpxlsを出力します。 「Character_Name.pxls.bytes.texture_0.png」などのPNGがpxlsと同じディレクトリに出力されます。
      http://pixelliner.sakura.ne.jp/img/200216_174055.png
    2. 必要なら Unity アセットを PixelLinerForUnity ver 0.6 にアップデートします。
    3. Unity の Pxls Loader アタッチメントのインスペクタを開き、 Targets 配列内の External Png 配列に、出力された PNG の枚数分だけリンクします。
      • PixelLiner ver 0.97.0 現在、PNGファイルはパーツを出力した場合は2枚、そうでなければ1枚のみ出力されます。
  • なお、PixelLiner ver 0.97.0 現在、PNGファイルを外部に出力したpxlsファイルを再度PixelLinerで開くことはできません。

サンプルプロジェクト(Unity)


ver 0.7 ( 22/01/02 Updated )


リリースノート

220102 ver0.7

  • 一部環境でpxlsファイルを読み込めない問題を修正。またメモリリークの問題を修正。

PixelLiner.PxlCharaAnimator Class

Public method

void setChara(string chara_title)使用する pxls ファイルの切り替えを行います。
void setPose(string pose_title, int restart_anim = -1)現在の pxls ファイル内の特定のポーズを再生します。
└ restart_anim1 = 常にアニメの再生位置を初期化(最初から再生します)
0 = アニメの再生位置を初期化しません
-1 = アニメに変更がある場合のみ初期化します
void setAim(int aim, int restart_anim = -1)現在のポーズ内で特定の方向シークエンスに切り替えます。
└ aimPxlCharaAnimator.AIM_L
PxlCharaAnimator.AIM_R
PxlCharaAnimator.AIM_T
PxlCharaAnimator.AIM_B
  などで指定します。
└ restart_anim1 = 常にアニメの再生位置を初期化(最初から再生します)
0 = アニメの再生位置を初期化しません
-1 = アニメに変更がある場合のみ初期化します
void animReset(int set_frame = 0)現在の方向シークエンスの特定のフレームからアニメーションを開始します。
bool updateAnimator (float time_scale = 1)アニメーションを time_scale フレーム分進行します。
auto_update_animation == true のとき、この関数は Update() 内で呼ばれるので、自前で速度を調整したいなどの事情がないなら手動で呼ぶ必要はありません。
ポーズや方向シークエンスを変更した直後であったり、フレームの変更があれば true を返します。
bool isChanged()最後に実行された updateAnimator() の返り値が true であれば true を返します。
int getCurrentFrame()現在の方向シークエンスのフレーム番号(0始まり)
int getLoopBackFrame()現在の方向シークエンスがループした時に戻ってくるフレーム番号。
int countTotalFrame()現在の方向シークエンスに何枚のフレームが含まれるか。
bool isAnimEnd()1度でもアニメーションがループしていたら true を返します。setPose や setAim など、方向シークエンスを変更すると false に戻ります。

Public Properties

bool multiply_global_timescaleupdateAnimator() の time_scale 値に自動で Time.timeScale を乗算します。
bool allow_pose_jumpAllow Pose Jump 参照。
bool auto_update_animation毎 Update() 内で updateAnimator(1) を実行します。

PixelLiner.PxlsLoader Class

Public static method

bool isLoadCompletedAll ()全ての pxls ファイルの読み込みが完了している場合 true を返します。

PixelLiner Library for Unity のライセンス / License of this library

Copyright (c) 2018 Cloba.U
Released under the MIT license
https://opensource.org/licenses/mit-license.php