差分

この文書の現在のバージョンと選択したバージョンの差分を表示します。

--- vci:component:sdk:effekseer [2023/05/09 13:33]
pastatto 統合リンク修正
+++ vci:component:sdk:effekseer [2023/10/04 18:02]
pastatto リファレンスページのURL変更、手順など構成の見直し
@@ ライン 1: / ライン 1: @@
 ====== Effekseer (VCI対応) ======
+バーチャルキャストではエフェクト制作ツール**[[https://effekseer.github.io/jp/ |Effekseer]]**を採用しています。\\
+Effekseerで制作したエフェクトを組み込むことができます。
-  * エフェクトの再生には[[https://github.com/virtual-cast/VCI/releases | VCI v0.19]]以降が必要です。
+  * エフェクトの再生には**VCI v0.19**以降が必要です。
-  * エフェクトは[[https://effekseer.github.io/jp/ | Effekseer]]にて作成します。
   * Effekseerの使い方は[[https://effekseer.github.io/jp/documentation.html| Effekseerドキュメント]]を確認してください。
-  * エフェクトのVCIスクリプトは[[vci:script:reference:effekseer | Effekseer (VCIスクリプト)]]を確認してください。
+  * VCIスクリプト：[[https://developer.virtualcast.jp/vci-docs/api/classes/ExportEffekseer/index.html | ExportEffekseer]]
+  * VCIサンプル：[[vci/sample/effect]]
-====== Effekseer v1.5対応状況（VirtualCast v1.9.2d～） ======
+==== 対応バージョンについて ====
+VCI作成用パッケージのUniVCIのバージョンによってはEffekseer の**対応バージョン**が異なります。\\
+対応バージョンではないEffekseerで制作したエフェクトを含むVCIは、バーチャルキャストで読み込むと**正常に表示されない**場合がありますのでご注意ください。
+Effekseer の対応バージョンは徐々に上がっていますが、**新機能には対応していない場合**がありますのでご注意ください。\\
+例えば、Effekseer v1.5の新機能としてカスタムマテリアルを設定出来ますがこの機能に対応していません。
+  * UniVCI最新版に対応するEffekseer のバージョンは**[[https://github.com/virtual-cast/VCI/releases|UniVCI リリースノート]]** をご確認ください。
-  * VirtualCast v1.9.2d と UniVCI v0.26 から、Effekseerのバージョンがv1.5bになります
-  * これによりUniVCI v0.26でEffekseerを含むVCIを作成し、VirtualCast v1.9.2c（安定板）で読み込むと正常に表示されない場合がありますのでご注意ください。
-  * Effekseer v1.5の新機能として、カスタムマテリアルを設定出来ますが UniVCI v0.26 の時点ではこの機能に対応していません。
 ===== EffekseerからUnityへの取り込み =====
-{{:vci:sdk:effekseer:forunity.jpg?direct&600|}}\\
-  - 最新の[[https://github.com/virtual-cast/VCI/releases | VCI UnityPackage]]をダウンロードし、プロジェクトにインポートしてください。
+<WRAP group round box 95%>
-  - [[https://effekseer.github.io/jp/ | Effekseer]]でエフェクトを作成し、プロジェクトファイルを保存して、[標準形式]よりエフェクトファイルを保存してください。
+**1. VCI UnityPackageをダウンロードする**\\
-  - エフェクトファイルと、エフェクトに使用したデータをUnityのassetフォルダへドラッグ&ドロップしてください。
+最新の[[https://github.com/virtual-cast/VCI/releases | VCI UnityPackage]]をダウンロードし、プロジェクトにインポートしてください。
-  - エフェクトの情報をInspectorで開き、テクスチャ等がちゃんと割り当てられてるか確認してください。\\ 割り当てられてない場合、手動で割り当ててください。
+</WRAP>
-===== コンポーネント 画像 =====
-{{:vci:sdk:effekseer:emitter.jpg?direct&600|}}
+<WRAP group round box 95%>
+<WRAP half column>
+**2. エフェクトを作成して保存する**\\
+[[https://effekseer.github.io/jp/ | Effekseer]]でエフェクトを作成し、プロジェクトファイルを保存して、[標準形式]よりエフェクトファイルを保存してください。
+</WRAP>
-===== Effekseer Emitter =====
+<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>
-^ プロパティー ^ 機能 ^
-| Effect Asset | 再生したいエフェクトを割り当てます。 |
-| Play On Start | 有効の場合、VCI出現時にエフェクトを再生します。 |
-| Is Looping | 有効の場合、エフェクトがループ再生されます。  |
 ===== オブジェクト構成について =====
-{{:vci:sdk:effekseer:object.png?direct&600|}}
+{{ :vci:sdk:effekseer:object.png?direct&600 }}
   * エフェクトを付与したいゲームオブジェクトに[Effekseer Emitter]をadd Componentしてください。
@@ ライン 41: / ライン 73: @@
   * [VCI SubItem]をadd Componentしなくても[Effekseer Emitter]単体で動作します。
-===== EffectをVCIスクリプト再生するサンプル =====
+==== コンポーネント ====
+<WRAP group>
+<WRAP half column>
+{{ :vci:sdk:effekseer:emitter.png?direct }}
+</WRAP>
-=== サンプルデータ ===
+<WRAP half column>
-https://virtualcast.jp/products/90272cc2f7da5d797a31dd9bf67e840d73e91282d999144464a9379033bc3b90
+=== Effekseer Emitter ===
+VCIでエフェクトの再生に使用するコンポーネントです。
+^ プロパティー ^ 機能 ^
+| Effect Asset | 再生したいエフェクトを\\ 割り当てます。 |
+| Play On Start | 有効の場合、VCI出現時に\\ エフェクトを再生します。 |
+| Is Looping | 有効の場合、エフェクトが\\ ループ再生されます。  |
+</WRAP>
+</WRAP>
-=== オブジェクトとコンポーネントの構成 ===
-{{:vci:sdk:effekseer:effectsample.png?direct&600|}}
-=== VCIスクリプト ===
-<file lua main.lua>
--- エフェクトはエフェクトをaddComponentしたオブジェクト名を指定して取得します
--- Effect という名前のゲームオブジェクトにアタッチされたエフェクトを変数 eff に格納する
-local eff = vci.assets.GetEffekseerEmitter("Effect")
-local toggle = false
-function onUse(use)
-    --SubItemをUseした時にエフェクトを再生する
-    if use == "SubItem" then
-        --toggleを反転する
-        toggle = not(toggle)
-        if toggle == true then
-            --effに格納したエフェクトを再生する
-            eff._ALL_Play()
-            --再生したエフェクト名を表示する
-            print(eff.EffectName.."のエフェクトを再生しました。")
-        end
-        if toggle == false then
-            --effに格納したエフェクトを停止する
-            eff._ALL_Stop()
-            --停止したエフェクト名を表示する
-            print(eff.EffectName.."のエフェクトを停止しました。")
-        end
-    end
-end
-</file>
-=== 解説 ===
+==== 仕様について ====
-基本的な使い方としては… ''vci.assets.GetEffekseerEmitter("エフェクトをアタッチしたオブジェクト名")'' でエフェクトを変数に格納し、変数からエフェクトを呼び出す形で実行します。\\
-その他のVCIスクリプトにつきましては [[vci:script:reference:effekseer | Effekseer (VCIスクリプト)]] を確認してください。
-===== 仕様について =====
   * ディストーション機能はOffになっているため使用できません。
   * Effekseer自体の音声再生機能は使用できません。
-===== その他注意点など =====
+==== その他注意点など ====
   * VR用のエフェクト作成時は、特別な理由が無い限りは「深度テスト」をONの状態で作成したほうが良いです。OFFの場合はオブジェクトの前後関係を無視して描画されるため、深度違反となりVR上の見た目が悪くなります。
-{{:vci:sdk:effekseer:zbuffer.jpg?400|}}
+{{ :vci:sdk:effekseer:zbuffer.jpg?400 }}
   * Effekseer入りのVCIをUnityEditorで取り込む際の注意点
     * １つのeffect内に同じテクスチャ名が存在していた場合、同一フォルダに出力されるため上書きされます、テクスチャ名はなるべく違う名前で設定してください
-  * UnityEditor上で動作確認する場合の注意点
-    * １つのeffect内で同じアセット参照を２か所以上にセットした状態でUnityEditor上で再生を行うと、UnityEditorがクラッシュする現象が確認されています、お手数ですが１つのeffect内で同じテクスチャ（またはモデル）をセットしたい場合はアセットをコピーしてセットして頂きますようお願いいたします、この件は後日修正致します。
-{{:vci:sdk:effekseer:effekseer_texture.png?300|}}

VirtualCast

ユーザ用ツール

サイト用ツール

差分

ページ用ツール