差分

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

--- vci:script:reference:effekseer [2021/03/30 17:22]
t-daihisa
+++ vci:script:reference:effekseer [2023/06/01 11:12]
pastatto リファレンスページの注意書き追加
@@ ライン 1: / ライン 1: @@
-====== Effekseer (エフェクト) ======
+~~NOTOC~~
-\\
+====== ExportEffekseer (エフェクト) ======
+<WRAP center round important 80%>
+このページは過去の情報となります。\\
+新しいスクリプトリファレンスは**[[https://developer.virtualcast.jp/vci-docs/api/|こちら]]**になります。
+</WRAP>
 VCIでエフェクトを再生するのに使用します。\\
-コンポーネントの使用方法は [[vci:component:sdk:effekseer| Effekseer (VCI対応)]] を確認してください。\\
+コンポーネントの使用方法は [[vci:component:sdk:effekseer| Effekseer (VCI対応)]] を確認してください。
-----
+^ ExportAssets ^^^
+^ 名前 ^ 説明 ^ バージョン ^
+| [[ vci/script/reference/effekseer#基本的な使用方法|GetEffekseerEmitter]] | VCI内のObjectのエフェクトを取得 | |
+^ ExportEffekseer ^^^
+^ 名前 ^ 説明 ^ バージョン ^
+| [[ vci/script/reference/effekseer#EffectName]] | エフェクト名を取得 | |
+| [[ vci/script/reference/effekseer#Play]] | ループ再生 | |
+| [[ vci/script/reference/effekseer#PlayOneShot]] | １回だけ再生 | |
+| [[ vci/script/reference/effekseer#Stop]] | 即座に停止 | |
+| [[ vci/script/reference/effekseer#StopImmediate(非推奨)]] | 即座に停止(非推奨)| |
+| [[ vci/script/reference/effekseer#StopRoot]] | 徐々に停止 | |
+| [[ vci/script/reference/effekseer#SetAllColor]] | エフェクトの色を変更 | |
+| [[ vci/script/reference/effekseer#SetTargetLocation]] | エフェクトの向かう位置を指定 | |
+| [[ vci/script/reference/effekseer#SetPause]] | 一時停止 | |
+| [[ vci/script/reference/effekseer#SetShow]] | エフェクトの表示・非表示を設定 | |
+| [[ vci/script/reference/effekseer#SetSpeed]] | エフェクトのスピードを変更 | |
+| [[ vci/script/reference/effekseer#SetLoop]] | エフェクトのループを設定 | |
-===== メソッド一覧 =====
+''_ALL_'' を含む関数は、他のクライアントでも実行され同期します。\\
+全てのクライアントで同じ結果になってほしい場合は ''_ALL_'' を含む関数を使用してください。\\
-**メソッド一覧は[EmbeddedScriptWorkspace]フォルダ内の[types.lua]を開くと最新のメソッド一覧を確認できます。**
+<code>
+Play
-^ メソッド名 ^ 説明 ^
+_ALL_Play
-| [[ vci/script/reference/effekseer#EffectName | EffectName]] | Stringでエフェクト名を取得します。 |
+</code>
-| [[ vci/script/reference/effekseer#Play() | Play()]] | 停止するまでエフェクトがループ再生します。 |
-| [[ vci/script/reference/effekseer#PlayOneShot() | PlayOneShot()]] | エフェクトが１回だけ再生されます。 |
-| [[ vci/script/reference/effekseer#Stop() | Stop()]] | エフェクトを停止します。ゆっくりと消失します。 |
-| [[ vci/script/reference/effekseer#StopImmediate() | StopImmediate()]] | エフェクトを停止します。\\ 実行したタイミングで即座にエフェクトが消失します。 |
-| [[ vci/script/reference/effekseer#StopRoot() | StopRoot()]] |  |
-| [[ vci/script/reference/effekseer#SetAllColor() | SetAllColor(color: Color)]] | エフェクトの色を変更します。 |
-| [[ vci/script/reference/effekseer#SetTargetLocation() | SetTargetLocation(targetLocation: Vector3)]] | エフェクトの向かう位置を指定します。 |
-| [[ vci/script/reference/effekseer#SetPause() | SetPause (paused: bool)]] | 実行したタイミングでエフェクトの再生を一時停止します。 |
-| [[ vci/script/reference/effekseer#SetShow() | SetShow (shown: bool)]] | エフェクトの表示・非表示を切り替えます。 |
-| [[ vci/script/reference/effekseer#SetSpeed () | SetSpeed (speed: number)]] | エフェクトのスピードを変更します。\\ 通常の速度を１の基準速度として扱い、基準速度の倍速で変化します。 |
-| [[ vci/script/reference/effekseer#SetLoop () | SetLoop (isLoop: bool)]] | trueであればエフェクトの再生がループします。\\ デフォルトはEffekseer Emitterで設定した値です。 |
-''_ALL_'' を含むメソッドは、他のクライアントでも実行され同期します。\\
-全てのクライアントで同じ結果になってほしい場合は ''_ALL_'' を含むメソッドを使用してください。\\
-^ メソッド名 ^ 説明 ^
-| _ALL_Play () | 停止するまでエフェクトがループ再生します。 |
-| _ALL_PlayOneShot () | エフェクトが１回だけ再生されます。 |
-| _ALL_Stop () | エフェクトを停止します。ゆっくりと消失します。 |
-| _ALL_StopImmediate () | エフェクトを停止します。\\ 実行したタイミングで即座にエフェクトが消失します。 |
-| _ALL_StopRoot () |  |
-| _ALL_SetAllColor (color: Color) | エフェクトの色を変更します。 |
-| _ALL_SetTargetLocation (targetLocation: Vector3) | エフェクトの向かう位置を指定します。 |
-| _ALL_SetPause (paused: bool) | 実行したタイミングでエフェクトの再生を一時停止します。 |
-| _ALL_SetShow (shown: bool) | エフェクトの表示・非表示を切り替えます。 |
-| _ALL_SetSpeed (speed: number) | エフェクトのスピードを変更します。\\ 通常の速度を１の基準速度として扱い、基準速度の倍速で変化します。 |
-| _ALL_SetLoop (isLoop: bool) | trueであればエフェクトの再生がループします。\\ デフォルトはEffekseer Emitterで設定した値です。 |
-----
 ===== 基本的な使用方法 =====
@@ ライン 69: / ライン 63: @@
 (SubItemをUseした時に１回だけエフェクトが再生されます)
 </code>
-----
 ===== EffectName =====
+**EffectName string**
-**戻り値：string**
+EffekseerEmitterのEffectAssetに割り当てられているエフェクトのファイル名を取得します。
-  * EffekseerEmitterのEffectAssetに割り当てられているエフェクトのファイル名を取得します。
 <file lua main.lua>
@@ ライン 95: / ライン 86: @@
 </code>
-----
+===== Play =====
+**Play fun()**\\
-===== Play() =====
+**_ALL_Play fun()**
-**引数：なし**
   * Effectの再生を開始します。
@@ ライン 128: / ライン 117: @@
 </code>
-----
+===== PlayOneShot =====
+**PlayOneShot fun()**\\
-===== PlayOneShot() =====
+**_ALL_PlayOneShot fun()**
-**引数：なし**
   * Loop設定になってるエフェクトの場合でも、エフェクトを１回だけ再生します。
@@ ライン 154: / ライン 141: @@
 </code>
-----
+===== Stop =====
+**Stop fun()**\\
-===== Stop() =====
+**_ALL_Stop fun()**
-**引数：なし**
   * Play()したエフェクトの再生を即座に停止します。
@@ ライン 186: / ライン 171: @@
 </code>
-----
+===== StopImmediate(非推奨) =====
+**StopImmediate fun()**\\
+**_ALL_StopImmediate fun()**
-===== StopImmediate() =====
-**引数：なし**
   * 処理はStop()と同じく即座にエフェクトが停止されますが、Effekseerの公式では非推奨の処理になります。
-----
+===== StopRoot =====
+**StopRoot fun()**\\
-===== StopRoot() =====
+**_ALL_StopRoot fun()**
-**引数：なし**
   * Play()したエフェクトの再生を徐々に停止します。処理としてはルートノードだけを停止して、子のノードが徐々に停止していきます。
@@ ライン 225: / ライン 208: @@
 </code>
-----
+===== SetAllColor =====
+**SetAllColor fun(color: Color)**\\
-===== SetAllColor() =====
+**_ALL_SetAllColor fun(color: Color)**
 **第１引数：color (color)**
@@ ライン 276: / ライン 259: @@
 </code>
-----
+===== SetTargetLocation =====
+**SetTargetLocation fun(targetLocation: Vector3)**\\
-===== SetTargetLocation() =====
+**_ALL_SetTargetLocation fun(targetLocation: Vector3)**
 **第１引数：targetLocation (Vector3)**
@@ ライン 292: / ライン 275: @@
 </code>
-----
+===== SetPause =====
+**SetPause fun(paused: boolean)**\\
-===== SetPause() =====
+**_ALL_SetPause fun(paused: boolean)**
 **第１引数：paused (bool)**
@@ ライン 324: / ライン 307: @@
 </code>
-----
+===== SetShow =====
+**SetShow fun(shown: boolean)**\\
-===== SetShow() =====
+**_ALL_SetShow fun(shown: boolean)**
 **第１引数：shown (bool)**
@@ ライン 358: / ライン 341: @@
 </code>
-----
+===== SetSpeed =====
+**SetSpeed fun(speed: number)**\\
-===== SetSpeed () =====
+**_ALL_SetSpeed fun(speed: number)**
 **第１引数：Speed(number)**
@@ ライン 388: / ライン 371: @@
 </code>
-----
-===== SetLoop () =====
+===== SetLoop =====
+**SetLoop fun(isLoop: boolean)**\\
+**_ALL_SetLoop fun(isLoop: boolean)**
 **第１引数：isLoop (bool)**
@@ ライン 421: / ライン 405: @@
 </code>
-----

VirtualCast

ユーザ用ツール

サイト用ツール

差分

ページ用ツール