プラグインの使い方

※一部Godot3向けの画像があります。

Effekseerプラグインの導入

こちらから最新のビルド済みプラグインをダウンロードします。

ダウンロードしたzip内のaddonsディレクトリをGodotプロジェクト直下にコピーします。

../_images/Godot_addons.png

プロジェクト設定のプラグインタブからEffekseer for GodotStatusを有効にします。

../_images/Godot_plugins.png

以上でプラグインの導入は完了です。

リソースファイル

Godotのプロジェクトのres://の中にエフェクトファイル(*.efkefc)やテクスチャ、サウンド、マテリアル等を配置します。

../_images/Godot_resources.png

エフェクトのインポート

efkefcファイルはGodotのリソースとしてインポートされます。

../_images/Godot_import_efkefc_success.png

成功すると上図のようにテクスチャ、モデル、マテリアル等のサブリソースがリンクされます。

../_images/Godot_import_efkefc_fail.png

サブリソースがリンク出来ていない場合は、再インポートを試してください。

../_images/Godot_import_efkefc.png

scale設定

読み込んだエフェクトの大きさが小さく、サイズを調整したい時があります。その場合はefkefcファイルを選択し、インポートタブのscale のパラメーターを変更して再インポートボタンを押します。

EffekseerEmitterのScaleを変更することでエフェクトの大きさを変更することもできますが、この方法だとエフェクトの設定によっては拡大されないことがあります。

3Dシーンでの使用方法

3Dシーン中でインポートしたエフェクトを発生させるには、エミッタ(EffekseerEmitter)を使用します。エミッタはエフェクトの発生源で、3Dシーン中に配置して使用します。

まず、ノードツリーにEffekseerEmitterがアタッチされたNodeを追加します。(3DなのでSpatialの下のEffekseerEmitterです)

../_images/Godot_add_node_3d.png

EffekseerEmitterが追加されました。

../_images/Godot_emitter_nodetree.png

次にEffekseerEmitterを選択し、インスペクタのEffectプロパティにインポートしたエフェクトをドラッグ&ドロップして指定します。

../_images/Godot_emitter_scene.png

Autoplayがチェックされているので、シーンを実行するとエフェクトが表示されます。

../_images/Godot_emitter_play.png

エミッタのインスペクタ

../_images/Godot_emitter_inspector.png

項目 説明
Effect エミッタで再生するエフェクトリソースを設定します
Autoplay チェックを入れると、シーン開始時(_ready()のタイミング)に自動的にエフェクトを再生します
Paused 再生中のポーズ状態を設定します
Speed エフェクトの再生速度を設定します
Color エフェクトの色を設定します

2Dシーンでの使用方法

2Dシーン中でインポートしたエフェクトを発生させるには、エミッタ2D(EffekseerEmitter2D)を使用します。エミッタ2Dはエフェクトの発生源で、2Dシーン中に配置して使用します。

まず、ノードツリーにEffekseerEmitter2DがアタッチされたNodeを追加します。(2DなのでNode2Dの下のEffekseerEmitter2Dです)

../_images/Godot_add_node_2d.png

EffekseerEmitter2Dが追加されました。

../_images/Godot_emitter2d_nodetree.png

次にEffekseerEmitter2Dを選択し、インスペクタのEffectプロパティにインポートしたエフェクトをドラッグ&ドロップして指定します。

../_images/Godot_emitter2d_scene.png

2Dシーンは座標基準がピクセルのため、Transform2Dのスケールを指定します。

../_images/Godot_emitter2d_scale.png

Autoplayがチェックされているので、シーンを実行するとエフェクトが表示されます。

../_images/Godot_emitter2d_play1.png

想定していたエフェクトの見た目と違う場合はorientationを調整します。
orientationにはXYZ軸ごとに回転角を指定できます。

../_images/Godot_emitter2d_orientation.png

正しい向きでエフェクトが表示されました。

../_images/Godot_emitter2d_play2.png

エミッタ2Dのインスペクタ

項目 説明
Effect エミッタで再生するエフェクトリソースを設定します
Autoplay チェックを入れると、シーン開始時(_ready()のタイミング)に自動的にエフェクトを再生します
Paused 再生中のポーズ状態を設定します
Speed エフェクトの再生速度を設定します
Color エフェクトの色を設定します
Orientation エフェクトの向きを設定します

プロジェクト設定

Effekseerの全体的な設定はGodotのプロジェクト設定から行うことができます。

../_images/Godot_project_settings.png

項目 説明
Instance Max Count ノードが生成するインスタンスの同時最大数
Square Max Count 描画に使用する四角形の同時最大数
Draw Max Count ドローコールの同時最大数
Sound Script サウンド再生で使われるスクリプト。差し替えが可能

プロジェクト設定

Effekseerの全体的な設定はGodotのプロジェクト設定から行うことができます。

../_images/Godot_project_settings.png

項目 説明
Instance Max Count ノードが生成するインスタンスの同時最大数
Square Max Count 描画に使用する四角形の同時最大数
Draw Max Count ドローコールの同時最大数
Sound Script サウンド再生で使われるスクリプト。差し替えが可能

エフェクトのプレビュー

Godotにインポートしたefkefcファイルを選択すると、インスペクター上でプレビュー再生を行うことができます。

../_images/Godot_effect_previewer.png

また、”Open in Effekseer”を押すとEffekseerでefkefcファイルを開きます。

この機能を使用するには、エディタ設定のEffekseerの所でEffekseerツールのパスを設定する必要があります。

../_images/Godot_effect_previewer_setting1.png

../_images/Godot_effect_previewer_setting2.png