RPGツクールMZ・MV向け天候系エフェクト統合管理プラグイン『TRP_Weather』のマニュアルページです。
https://www.youtube.com/watch?v=ATZQbKm01QY
TRP_WeatherはBoothのセール期間限定で販売してる限定プラグインセットに含まれています。
(※開発中の画面のため、一部動作が異なる場合があります。)
TRP_Weatherについて
- 複数のマップ系エフェクトを「天候」としてまとめるプラグイン
- 簡単なコマンドで「0~10の強さをスムーズに切り替え」られる
天候は入れ子にしたり、複数の天候を同時適用が可能です。設定例🔽
- 天候：始まりの街
- └天候：雨
- └パーティクル再生<要:TRP_Particle(MZ)>：雨
- └パーティクル再生<要:TRP_Particle(MZ)>：水しぶき
- └フィルター制御：全体を鈍色に
- └BGS再生：雨
- └天候：上向きフォグ
こうすることで、
- 街のエフェクトを（複数マップあっても)まとめて調整可能
- 個々のエフェクト設定を簡単に使いまわし可能
といったメリットがあります！
天候エディタ
また、天候エディタ上で各エフェクトを設定することができ、エフェクトごとのコマンドなどを覚える必要がなくなり、シンプル・スピーディーに設定ができるようになります！
特にパーティクルプラグインとの連携は、元のパーティクルデータを変更したりアップデートコマンドを使わずに色味や大きさ・量などを手軽に調整が可能で便利です！
マニュアルリンク
基本の使い方①<本ページ>
- エディタの基本的な使い方
- ツクールデフォルト演出(天候・色調・BGS)
- リージョン連動
- disableコマンドでの手動制御
基本の使い方②
- 段階設定について
- フィルター
- フォグ
作例紹介①:雪
- パーティクル
- プラグインコマンド・スクリプト
作例紹介②:静謐な森
- パーティクルグループ
- MapObject
ゆらぎ機能の解説
対応エフェクト
※天候エディタで扱える一部エフェクトは別途販売している有料プラグインが必要です。
TRP_Weatherが含まれる「限定プラグインセット」のみで扱えるエフェクト
- フィルター(色調,ブルーム,チルトシフト,ヴィネット)<TRP_MapFilter>
- フォグ(霧)・マップの濃淡付加<TRP_FogTexture>
- BGSの並行再生<TRP_Audio>
ツクールデフォルト機能との連携
- 色調の変更
- (ツクールデフォルト)天候の再生
- 任意のプラグインコマンド/スクリプトの実行
別途販売中のプラグインとの連携
- パーティクル(グループ)表示<TRP_ParticleMZ>
- マップオブジェクト<TRP_MapObject>
└オブジェクトのアニメ停止・再開/表示・非表示の切り替えが可能
基本の使い方①
基本の使い方の説明としてツクールデフォのエフェクトを使って簡単な天候を設定していきます。
※テンポよく読み進めるために、初回は「飛ばしてOK」と書いてる項や、（グレーで書かれてる部分）は飛ばして進みましょう。
(※本チュートリアル記事はマニュアルも兼ねているため上級者向けの細かな機能もできるだけ解説しています。必要になったときに適宜読み直すと良いです)
プロジェクトへの導入
materialsより以下のファイルをコピペしてください。
- dataEx/TrpWeathers.json：天候データ。(最初は空の状態です)
- dataフォルダではなくdataExフォルダを作成してその中にコピペしてください
- plugins/TRP_CORE.js：各プラグインの基盤となる機能が入ったプラグイン
- plugins/TRP_Weather.js：天候を再生するプラグイン
- plugins/TRP_WeatherEditor.js：天候データを編集するプラグイン
- plugins/TRP_Audio.js：BGSを並列で再生するプラグイン
- plugins/TRP_FogTexture.js：フォグ・霧を表示するプラグイン
- plugins/TRP_MapFilter.js：マップにフィルターを適用するプラグイン
ファイルをプロジェクト内にコピペしたら、プラグイン管理ウィンドウより各プラグインを導入してください。
また、TRP_ParticleMZやTRP_MapObjectをお持ちの方はプロジェクトに導入しておくことで天候エディタにて扱うことができます。
このとき、TRP_Weatherはなるべく下側に配置してください。
- 天候：雨
- └ツクールデフォ天候：雨
- └ツクールデフォ色調：鈍色に
- └BGSの再生
まずは「TRP_Weather」の「天候のセット」コマンドを設定
- 天候ID：（重複しない）任意の天候名
- 天候の強さ：0~10の値
- (変化にかける)所要フレーム数：0以上の整数
- リージョンマップ：none/absolute/relative(後述)
- 編集モードフラグ：ON
- 天候名のデータが存在しないときはOFFでも自動でエディタが立ち上がります
（※天候の強さ・所要フレーム数はデフォルト値をエディタ上で設定できるので、とりあえず未設定でOKです。）
↓MV形式
「weather set 天候名 強さ フレーム数 リージョン設定」
- 設定例：「weather set sampleRain def def def」
- 編集するときは「set」を「edit」に変える。または最後に「edit」を付け足す
- 「def」はデフォルト値を使用の意味。「def」は省略可能
また、イベント名を「WEATHER」としておくことで、マップ開始直後(0フレーム目)に天候を適用できます。
テストプレイを行うと、天候エディタが表示されます！
補足:WEATHERイベント(飛ばしてOK)
イベント名「WEATHER」のイベント内ではウェイト処理は無効化されます。
また、WEATHERイベントでのみメモ欄に「<noEdit>」といれると編集フラグを無効化できるので編集モードの切り替えに便利です。
基本的に通常のイベントと同じように諸々の処理でも実行可能ですが、予期しない挙動やエラーを避けるためにも天候操作とあまり関係ない処理は入れないようにしましょう。
ツクールデフォルト天候
エディタ開始時に「[要素の追加]＋」にフォーカスされてます。
そのままEnterを推して要素を追加！
ここでは「天候(ツクールデフォ)」を選択。
（上の方の「天候」はTRP_Weatherの天候を入れ子で表示させる場合に使います）
個別のエフェクトの設定画面に移ります。
天候の「type」がrainになっており、左右キーで種類を切り替えられます。
ここではrainのままでOK！
画面上でも雨の天候がプレビュー表示されます！
パラメータがいろいろありますが、現段階で🔽のような設定が出来上がっています。
- 「天候：sampleRainの強さ0」のとき「雨エフェクトの強さ0」
- 「天候：sampleRainの強さ10」のとき「雨エフェクトの強さ10」
例えば、「天候：sampleRainの強さ5」のときは「雨エフェクトの強さ」は中間の値の5に自動で補正されます！
実際に、previewの数値を5にしてみると天候の強さ5のときのエフェクトを確かめられます。
（※ショートカットキーCtrl+5でもOK）
段階設定
少しややこしい話ですが、天候設定の要となる段階設定について解説します！
今のところ、「[段階設定]の項目」は🔽画像のようになっています。
これは、
- この天候には「強さ０」と「強さ１０」の２つの段階設定がある
- 現在は緑かけになっている「強さ１０」の段階設定を行っている
- 上のP矢印はプレビューしている強さ(今は5なので０と１０の間）
を表しています。
試しに左右キーで段階設定を左側の(強さ)０に切り替えてみます。
（ショートカットキーはTab）
power（ツクールデフォ天候(雨)の強さ）が10だったのが、0に変わります。
(※[power]の左の青い直線はパラメータの変化グラフを示し、天候の強さが上がるほどpowerの値も上がっていることが確認できます。)
また、previewの値(プレビューする天候の強さ)が0.1に変わっています。
(※強さ0では基本的にエフェクト非表示のため0.1の強さがプレビューされています。)
色調
続いて色調の設定を行っていきます。
Escキーで「天候の全体設定」に戻り、先ほどと同じように「[要素の追加]＋」を押して要素を追加します。
今度はウィンドウから「色調」を選択。
r(赤),g(緑),b(青),gray(グレー)の設定が表示されます。
初期値はすべて０となっているので
(天候強さ10での）パラメータを自由に設定しましょう！
ここでは鈍色っぽくなるように調整してみました。
BGS再生
最後に、BGS再生を追加していきます！
同じように「Esc」で戻って「[要素の追加]＋」→「BGS再生」
今までと比べてパラメータが多めです。
まずはBGSのファイル名「[name]」が未設定となっているので、Enterを押して設定しましょう。
画面左側にBGSファイルの一覧が表示されるので上下キーで雨のBGSを選び、Enterで決定します。
今回の設定はこれで完了！
……なのですが、パラメータについて少し補足しておきます。
BGS再生のパラメータのうち、[name]と[pitch](ピッチ)は段階設定の上側に配置されてます。
これらのパラメータは各段階で共通となっています！
（※つまり、段階を変えてもBGS名とピッチは変更できません）
逆に、段階設定の下側に配置されている[volume](音量)と[pan](パン)段階ごとに数値設定が可能です！
TRP_AudioでのBGS並列再生
限定プラグインに付属する「TRP_Audio.js」を導入することで、BGSの複数並行再生が可能になります！
- 「天候：雨」で雨のBGSを再生
- 「天候：滝音」で滝のBGSを再生(リージョンで滝の近くで音量が大きくなるように天候の強さ設定)
- マップのBGS再生やイベントコマンドで従来のBGS再生
といったようにBGSの再生管理を考えずに天候に紐づけて自動で再生・停止ができるようになります！
ぜひ導入してみましょう！
（TRP_AudioにはBGM・SEなどあらゆるオーディオ再生時に生成される音量ノード・パンノードをキャッシュして使いまわす機能もついてます。キャッシュ機能をONにすると、ゲーム長時間プレイ時に発生するプチプチ音が改善される……かもしれません。）
※TRP_Audioでのみ再生するBGSはデプロイメント時の未使用ファイル除外で除外されます。どこかの使わないマップに各BGSの再生コマンドを並べて置くと◯
ひとまず演出はこれで完成とします！
忘れずにCtrl+Sでデータを保存しましょう！
リージョンの連動設定
天候を手動でON/OFF、または強さの変更を行うには「天候のセット」コマンドを使用しますが、マップのリージョンを使って天候の強さを自動変更することもできます！
マップ内の位置によって天候・強さを変更させたいときに使ってみましょう！
リージョン設定用のマップの準備
天候設定用のリージョンは、そのマップで(リージョン連動で)使用する天候ごとに設定用マップをコピペで作成し、その設定用マップに対してリージョンを塗っていきます。
（これにより、複数の天候をそれぞれリージョンで設定できたり、本マップのリージョンは別のプラグインの使用に割り当てできます）
マップをコピー(Ctrl+C)し、そのままペースト(Ctrl+V)で直下に貼り付けましょう。
そして、コピペで作成したマップ名を「天候:天候名」とします。（ここでは天候sampleRainのリージョン設定を行うので「天候:sampleRain」）
あとは設定用マップに「１〜１０」のリージョンを塗っていけばOK！
塗っていないところは強さ０となります。
塗り分ける数値は1~10すべて使わずに飛び飛びの値でもOK！
漏れが無いようにざっくりと塗っていきましょう。
「天候のセット」コマンドの調整
次は「天候のセット」コマンドのパラメータを編集します。
最初に作ったコマンドを編集し、「リージョンマップ」の値が「def」となっているのを「relative/相対値設定」に変更。
ついでに「編集モードフラグ」もfalseにしておきましょう。
テストプレイを開始すると、ダイアログが表示されます。
指示通りにマップの編集画面を開く→メモ欄にCtrl+Vで貼り付けを行いましょう。
リージョン設定用マップではなく、元の親マップのメモ欄に貼り付けるように注意！
（※設定をメモに貼り付けることでゲームプレイ中にリージョン設定を読み込むロード時間が短縮され、またマップ移動後の天候表示のラグもなくなります）
（※コピペではなく直接マップのメモ欄を書き換えるようにプラグイン設定で変更も可能です。ただし、編集中のマップが上書き保存されたり、意図しない動作を引き起こす可能性があるため定期的なプロジェクトのバックアップなどを行ってください。）
これで完成！
ポップアップが正しく出ない場合は設定用マップが正しく設定されてるか確認を。
- 設定用のマップが、元マップの直下にあるか
- 設定用のマップ名が「天候:sampleRain」(sampleRainは設定した天候名)になっているか
- (親マップの)天候セットコマンドが「リージョンマップ=relative」になっているか
リージョン設定マップについて補足(読み飛ばしてOK)
リージョン設定が終わりメモ欄に貼り付けたら、リージョン設定マップは削除することができます。
マップIDがかつかつのときは適宜削除して整理しましょう。
プラグインコマンド「リージョン設定マップ復元」(MV形式は「weather restoreregion」)を実行することで設定用のマップを復元することも可能です(マップIDが満パンじゃないか注意)。
また、親マップのマップサイズが変更されるとリージョン設定が狂ってしまうので一度削除して設定マップ復元をすると良いでしょう。
「relative/相対値設定」と「absolute/絶対値指定」（読み飛ばしてOK）
リージョンマップ設定は「relative/相対値設定」と「absolute/絶対値指定」の二通りが可能です。
「absolute/絶対値指定」とすると、リージョンの値通りの天候の強さがセットされます。
一方、「relative/相対値設定」とすると、天候の強さは「setコマンドで指定した強さ x リージョン数値 (/10)」となります。
（relativeかつ強さを「def」のままの場合のみ、セット時には天候の強さ10としてセットされます。）
天候の強さが10の場合は絶対値指定と同じですが、セットコマンドで「5」とした場合は、リージョン「10」のマスに立っても「10 x 5 (/10) = 「5」の強さとなります。
「天候の無効化と解除」コマンド
天候の操作を一時的に無効にするには「天候の無効化と解除」コマンドを使用します。
操作無効化の種類はいくつか用意されてます。
たとえば「region」を無効化すると、リージョンによる天候強さの自動変更が無効化されます。
イベントシーンで天候は固定し、移動ルートでプレイヤーを歩かせても天候を変化させたくない場合などに無効化すると良いでしょう。
（※この場合、天候の強さをコマンドで指定するには、いったんセットコマンドでリージョンマップを「none」か「absolute」にする必要があります。）
一時無効化を解除するには「無効化の解除フラグ」を「1/指定した無効化タイプを解除」または「2/すべての無効化タイプを解除」とすればOKです。
(※"天候の"無効化ではなく、"天候操作の"無効化なので注意。天候を消すには「天候のクリア」コマンドを使用しましょう。)
今回の記事はここまで！
基本の使い方の後半では雨のエフェクトをもう少しリッチにしていきます！
