====== Effekseer (VCI対応) ======
バーチャルキャストではエフェクト制作ツール**[[https://effekseer.github.io/jp/ |Effekseer]]**を採用しています。\\
Effekseerで制作したエフェクトを組み込むことができます。

  * エフェクトの再生には**VCI v0.19**以降が必要です。
  * Effekseerの使い方は[[https://effekseer.github.io/jp/documentation.html| Effekseerドキュメント]]を確認してください。
  * VCIスクリプト：[[https://developer.virtualcast.jp/vci-docs/api/classes/ExportEffekseer/index.html | ExportEffekseer]]
  * VCIサンプル：[[vci/sample/effect]]


==== 対応バージョンについて ====

VCI作成用パッケージのUniVCIのバージョンによってはEffekseer の**対応バージョン**が異なります。\\
対応バージョンではないEffekseerで制作したエフェクトを含むVCIは、バーチャルキャストで読み込むと**正常に表示されない**場合がありますのでご注意ください。

Effekseer の対応バージョンは徐々に上がっていますが、**新機能には対応していない場合**がありますのでご注意ください。\\
例えば、Effekseer v1.5の新機能としてカスタムマテリアルを設定出来ますがこの機能に対応していません。

  * UniVCI最新版に対応するEffekseer のバージョンは**[[https://github.com/virtual-cast/VCI/releases|UniVCI リリースノート]]** をご確認ください。


===== EffekseerからUnityへの取り込み =====


<WRAP group round box 95%>
**1. VCI UnityPackageをダウンロードする**\\
最新の[[https://github.com/virtual-cast/VCI/releases | VCI UnityPackage]]をダウンロードし、プロジェクトにインポートしてください。
</WRAP>


<WRAP group round box 95%>
<WRAP half column>
**2. エフェクトを作成して保存する**\\
[[https://effekseer.github.io/jp/ | Effekseer]]でエフェクトを作成し、プロジェクトファイルを保存して、[標準形式]よりエフェクトファイルを保存してください。
</WRAP>

<WRAP half column>
{{ :vci:sdk:effekseer:forunity1.png?direct |}}
</WRAP>
</WRAP>


<WRAP group round box 95%>
<WRAP half column>
**3. Unityへインポート**\\
エフェクトファイルと、エフェクトに使用したデータをUnityのassetフォルダへドラッグ&ドロップしてください。
</WRAP>

<WRAP half column>
{{ :vci:sdk:effekseer:forunity2.png?direct |}}
</WRAP>
</WRAP>


<WRAP group round box 95%>
<WRAP half column>
**4. 再生されるか確認**\\
エフェクトの情報をInspectorで開き、テクスチャ等がちゃんと割り当てられてるか確認してください。\\ 割り当てられてない場合、手動で割り当ててください。
</WRAP>

<WRAP half column>
{{ :vci:sdk:effekseer:forunity3.png?direct |}}
</WRAP>
</WRAP>


===== オブジェクト構成について =====

{{ :vci:sdk:effekseer:object.png?direct&600 }}

  * エフェクトを付与したいゲームオブジェクトに[Effekseer Emitter]をadd Componentしてください。
  * Effect用オブジェクトの配置場所は、VCIObject以下であればどこに配置しても問題ありません。
  * [VCI SubItem]をadd Componentしなくても[Effekseer Emitter]単体で動作します。

==== コンポーネント ====
<WRAP group>
<WRAP half column>
{{ :vci:sdk:effekseer:emitter.png?direct }}
</WRAP>

<WRAP half column>
=== Effekseer Emitter ===
VCIでエフェクトの再生に使用するコンポーネントです。
^ プロパティー ^ 機能 ^
| Effect Asset | 再生したいエフェクトを\\ 割り当てます。 |
| Play On Start | 有効の場合、VCI出現時に\\ エフェクトを再生します。 |
| Is Looping | 有効の場合、エフェクトが\\ ループ再生されます。  |
</WRAP>
</WRAP>







==== 仕様について ====

  * ディストーション機能はOffになっているため使用できません。
  * Effekseer自体の音声再生機能は使用できません。

==== その他注意点など ====
  * VR用のエフェクト作成時は、特別な理由が無い限りは「深度テスト」をONの状態で作成したほうが良いです。OFFの場合はオブジェクトの前後関係を無視して描画されるため、深度違反となりVR上の見た目が悪くなります。
{{ :vci:sdk:effekseer:zbuffer.jpg?400 }}
  * Effekseer入りのVCIをUnityEditorで取り込む際の注意点
    * １つのeffect内に同じテクスチャ名が存在していた場合、同一フォルダに出力されるため上書きされます、テクスチャ名はなるべく違う名前で設定してください