TRP_Particle.jsのプラグイン設定【パーティクルプラグイン】

←MV版マニュアルトップ
←MZ版マニュアルトップ

パーティクルプラグイン本体(TRP_Particle.js/TRP_ParticleMZ.js)のプラグイン設定の項目を解説します。
（エディタプラグインの設定についてはTRP_ParticleEditor.jsのプラグイン設定）

ライブラリインポート

基本ライブライブラリであるpixi-particles.jsの中身をこのプラグイン内で定義する設定です。独自にpixi-particles.jsを導入する場合のみOFFにしてください。

pixi-filtersインポート

パーティウルにフィルターをかける機能に必要なpixi-filters.jsライブラリをプラグイン内で導入する場合のみONにしてください。（この機能は現バージョンでは非公式のためOFF推奨です）

常用パーティクル

ゲーム中に常に使用するパーティクル設定の登録が行えます。
主にマウスクリック・ドラッグ用の設定や、プレイヤーの歩行時に常に表示するパーティクル演出に使うと良いです。

プラグインコマンドでsetで表示するときと同じ要領でコマンドを登録します。

常用パーティクルとして登録したパーティクルはイベントコマンドで操作できないので注意。
編集したい場合は一度常用パーティクルの設定を外してイベントコマンドから編集を行ってください。

コマンド名

プラグインコマンドで先頭に使用する「particle」という単語が他のプラグインのコマンドとかぶっている場合に変更してください。

移動時イベント対象クリア

イベントを対象として表示している各種パーティクル設定を、マップ移動時に自動的にクリアする設定。

移動時パーティ対象クリア

プレイヤー・フォロワーを対象として表示している各種パーティクル設定を、マップ移動時に自動的にクリアする設定。

移動時Screen対象クリア

対象をscreen/weather/regionとして表示している各種パーティクル設定を、マップ移動時に自動的にクリアする設定。

戦闘終了時に戦闘Screen対象クリア

対象をbattle/battleWeatherとして表示している各種パーティクル設定を、戦闘終了時に自動的にクリアする設定。

戦闘終了時に戦闘キャラ対象クリア

対象をparty/enemy/attach:party/attach:enemyとして表示している各種パーティクル設定を、戦闘終了時に自動的にクリアする設定。

キャラ対象の画面外幅

キャラクターを対象としたパーティクル発生源について、キャラクターが画面外の指定したタイル幅以上に離れた場合にパーティクルのアップデートを停止して処理付加を軽減する設定。（マイナス値をいれると自動停止制御を無効）

イベントごとに画面外マージンを調整したい場合はイベントのメモ欄に<pMargin:10>といった形式で設定が可能です。（この場合はイベントが画面から10マス以上外に出るとパーティクルが停止します。また、-1とすると画面外でも常に表示＆更新されます。）

リージョンの画面外幅

ターゲットをregionとして表示しているパーティクル設定は、画面内のタイルのみパーティクルが発生します。画面外幅として余白のタイル数を設定することで、スクロール時にも画面外だったタイルにパーティクルが十分発生している状態で表示させることができます（余白を設ける分、処理は重くなります）

walk時のオフセット

walk対象時にパーティクルをキャラの進行方向に指定したオフセットだけずらして表示させます。

↓オフセットが0のときと16のとき。

最大パーティクル数

画面上の最大パーティクル数制限の初期値を設定します。(0以下で制限なし）
プラグインコマンド「particle max 最大制限数」でゲーム中に変更も可能です。

※制限されるのはそれぞれのエミッターの射出能力であり、表示の仕方によっては一時的に制限数を超えることがあるので注意。

ピクチャ重ね順保持

ピクチャ対象のパーティクル発生源について、重ね順保持をONにするとZ軸値のabove、belowが個々のピクチャの間の階層に表示されます。ピクチャ - パーティクル - ピクチャといった感じで細かく階層を指定したい場合にONにしてください。（OFFにすると全てのピクチャの表・裏の重ね順で表示されます。）

ステート表示無効

ONにするとステートと付随したパーティクル設定機能を無効化します。競合時にON推奨です。

スキル表示無効

ONにすると戦闘時のスキル実行に付随したパーティクル設定機能を無効化します。競合時にON推奨です。

パーティクル数表示

ONにすることで現在画面上に表示されているパーティクル数を画面左上に表示します。また、最大パーティクル数の制限がかかっている場合の警告も表示されます。
デバッグ用のパラメータで若干の処理負荷がかかるため、デプロイメントと同じ環境でテストプレイしたい場合はOFFにしてください。
（なお、イベントを対象として画面外で更新停止中のパーティクルは、パーティクルの実態とメモリ割り当てはある状態ですが、パーティクル数表示にはカウントされません）

Particle関数の上書きを無効化

pixi-particles.jsで定義されている一部の基幹関数を上書きする処理を無効化します。
pixi-particles.jsのバージョンアップでの機能追加に対応させたい場合などにONにして対応できますが、TRP_Particle.jsで独自に行なっている以下の修正が無効化されます。

• speedの値を一定にしなかった場合にaccelerationの値が反映されない仕様の修正
• minScaleMultiplier/minSpeedMultiplierの値を途中で1に変更した際に反映されない仕様の修正

エラー表示

ONにすることで、正しくないIDや設定データ名でプラグインコマンドを実行した場合にエラー表示をします。

再生対象の種類とZ軸【パーティクルプラグイン】

←MV版マニュアルトップ
←MZ版マニュアルトップ

パーティクル再生系のコマンド(set,play,edit)における、対象のパラメータの種類について解説します。

再生系コマンドのパラメータ「ID 対象 設定名 Z軸値」
例）『particle set par1 this』におけるthisにあたる部分が対象の種類です。

Z軸値の基本

また、対象によってとりうるZ軸値も異なるので対象の種類と合わせて紹介しますが、Z軸値の基本について先に解説しておきます。

Z軸値の最も基本的な値はaboveかbelowのどちらかの値です。
対象の上に重ねたい場合はabove、下/裏側に表示したい場合はbelowとしてください。

一部の対象ではscreen、spritesetという値も指定可能です。
screenは画面の一番手前、spritesetはウィンドウメッセージなどUI表示の裏側の重ね順に表示されます。
（spritesetとすれば画面フェードアウト時にも暗くなった上に表示され、screenとすればさらにメッセージウィンドウなどの上にも表示されます。また、spriteset/screenでは画面色調変更の影響を受けません。）

また、Z軸値が同じであれば後にset/playコマンドで表示させたパーティクルが上に重なって表示されます。

(MZ版ではマップ上のタイルの後ろかつ背景の手前であるbackも指定可能です）

対象の種類一覧

キャラクター対象

• player
• event/this
• follower
• attach
• walk
• startdash

画面全体/マップ対象

• screen
• weather
• region

マウス

• click
• drag

戦闘画面用

• party
• enemy
• battle
• battleWeather

ピクチャ関連

• picture
• battlePicture
• skit
• battleSkit

キャラクター対象

player

• particle set ID player 設定名

プレイヤーに対してパーティクルの発生源を設定します。

this

• particle set ID this 設定名

イベントコマンドを実行しているイベントに対してパーティクルの発生源を設定します。

follower

• particle set ID follower:1~3 設定名

(1~3番目の)フォロワーに対してパーティクルの発生源を設定します。

attach

• particle set ID attach:対象 設定名
  └対象はplayer、this、event:イベントID、follower:1~3など

指定した対象キャラにピタリと付随させてパーティクルを発生させます。
単にplayer,event,followerで指定した場合は一度発生したパーティクルはキャラが移動しても発生した位置を基準に残りますが、attach:対象で指定した場合はキャラが移動すると発生したパーティクルもそのキャラの周りにまとわりついたまま移動します。

例）「particle set ID attach:event:10 設定名」とするとイベントID10のイベントにピタリと付随してパーティクルが発生

↓ターゲットをplayerとして表示した場合と、ターゲットをattach:playerで表示した場合

walk

• particle set ID walk:対象:リージョンID 設定名
  └対象はplayer、this、event:イベントID、follower:1~3など
  └リージョンIDはカンマ<,>続きで複数指定◯。(省略も可)

指定した対象キャラの移動時にパーティクルを発生。

例）「particle set ID walk:player:1,2 設定名」とするとプレイヤーがリージョンID1,2のタイルの上を歩くときにパーティクルが発生します

startdash

• particle set ID startDash:対象ID 設定名
  └対象はplayer、this、event:イベントID、follower:1~3など

指定した対象キャラがダッシュ開始or方向転換時にパーティクルを発生。

キャラクター対象のZ軸値の値

キャラクター対象の場合は、基本はマップタイル上にパーティクルが発生します。
Z軸値を0以上の数値の範囲で変えることで細かく重なり順を制御できます。

0:下層タイル
1:「通常キャラの下」表示のキャラクター
3:「通常キャラと同じ」表示のキャラクター
4:上層タイル
5:「通常キャラの上」表示のキャラクター
6:飛空船の影
7:吹き出しバルーン
8:アニメーション

下層タイルと「通常キャラの下」の間の重なり順にしたい場合は0.5などとすると良いです。（blowは1、aboveは5の数値となります）

screen/spritesetの値も指定可能です。
(MZ版ではマップ上のタイルの後ろかつ背景の手前であるbackも指定可能です。）

画面全体/マップ対象

（画面全体/マップ対象の場合のZ軸値についても↑のキャラクター対象のZ軸値の値と同じです。）

（↑screenの場合とweatherの場合の挙動のちがい）

screen

• particle set ID screen 設定名

画面の指定位置に対して発生。(スクロール時も完全固定）

weather

• particle set ID weather 設定名

画面の指定位置に対して発生。
screenとは違い、発生したパーティクルは画面のスクロールに連動して動きます。

（※ピクチャの後ろに表示させたい場合は「Z値」を「above」または「below」に設定してください。例：particle set 管理ID weather 設定名 above）

region

指定したリージョンのタイルからランダムに発生。
画面内のタイルからのみ発生しますが、プラグインの設定「リージョンの画面外幅」を大きくすることで十分画面外であるタイルからも発生させることができます。

リージョンを対象としたときは「発生方法」に関するパラメータ設定は無効になり、それぞれのタイル内部48x48からランダムな位置からパーティクルが発生します。

マウス

Z軸値は取らずに、常に画面の一番上に表示されます。

click

マウスクリック/タップ時に発生。
タイトル画面などでも表示させるにはプラグイン設定「常用パーティクル」に登録してください。

drag

ドラッグ操作時に発生。
タイトル画面などでも表示させるにはプラグイン設定「常用パーティクル」に登録してください。

戦闘画面用

Z軸値はaboveかbelowのどちらかとなります。

party

• *particle set ID party:1~4 設定名

戦闘画面中に、指定の味方から発生。（party:1とすると先頭のメンバー）
（※マップ画面上では無効）

enemy

• *particle set ID enemy:1~4 設定名

戦闘画面中に、指定の敵から発生。（enemy:1とすると1番目の敵）
（※マップ画面上では無効）

battle

• *particle set ID battle 設定名

戦闘画面中に、画面上から発生。
（※マップ画面上では無効）

battleWeather

• *particle set ID battleWeather 設定名

戦闘画面中に、背景から発生。ズーム時に背景に付随
（※マップ画面上では無効）

キャラクター対象

picture

• *particle set ID picture:ピクチャID 設定名

マップ上で指定したピクチャIDのピクチャ上に表示。
戦闘シーンではpictureの代わりにbattlePictureを使用してください。

プラグイン設定の「ピクチャ重ね順保持」をONにすることでピクチャの間にパーティクルを挟む形で表示することができます。（OFFでは全てのピクチャの前or後ろに表示）

battlePicture

• *particle set ID batlePicture:ピクチャID 設定名

戦闘シーンで指定したピクチャIDのピクチャ上に表示。
マップ上ではbattlePictureの代わりにpictureを使用してください。

skit

• *particle set ID skit:キャラ名 設定名

立ち絵プラグインTRP_Skit(別売り)との連携用の対象設定。
マップ上で指定したキャラ名の立ち絵に表示
戦闘シーンではskitの代わりにbattleSkitを使用してください。

battleSkit

• *particle set ID battleSkit:キャラ名 設定名

立ち絵プラグインTRP_Skit(別売り)との連携用の対象設定。
戦闘シーンで指定したキャラ名の立ち絵に表示
マップ上ではbattleSkitの代わりにSkitを使用してください。

利用上の注意【パーティクルプラグイン】

←MV版マニュアルトップ
←MZ版マニュアルトップ

パーティクルプラグイン、ならびに付属プラグイン（以降、本プラグイン）はツクールのコアスクリプトのバージョンによっては正しく動作しない場合や他のプラグインとの競合も起こり得ます。

以下の点について十分理解した上でご利用ください。

• 対応するコアスクリプトのバージョン
• プラグインの競合について
• アップデート時の注意点
• 生成されるファイルについて
• 動作の保証範囲と不具合報告

また、使用条件にも同意の上でご利用ください。

サンプルデータベースの利用について

収録されているサンプルデータベースは対応するRPGツクールプロジェクトの正規登録を行ったユーザーのみサンプルデータベースをご利用頂けます。
また、画像やプラグインの素材を各自のプロジェクトにインポートする場合には、素材フォルダ内の素材を利用し、サンプルプロジェクトの素材は利用しないでください。
（※サンプルデータベース内の画像は容量削減のために圧縮しております）

対応するコアスクリプトのバージョン

ツクールのコアスクリプトのバージョンアップには出来る限りで対応することを考えていますが、内部の仕様が大きく変わった際には動作対応できない可能性がございます。

そのため、(現時点での)「MV版プラグインが対応するRPGツクールMVのコアスクリプトのバージョンは"1.6.2"、MZ版プラグインが対応するRPGツクールMZのコアスクリプトは"1.2.0"とさせていただきます。」それ以外のコアスクリプトバージョンには対応を保証致しかねますのでご理解願います。

プラグインの競合について

本プラグインは「プラグインの競合には対応致しません」のでご理解お願いいたします。
本プラグインは他にプラグインが入っていない状態での動作を前提に製作しております。

プラグイン競合への対応要望については不具合報告フォームにて受け付けますが、対応や返信はお約束できせんのでご了承ください。

アップデート時の注意点

アップデートファイルはBoothのマイページの購入履歴よりダウンロードが可能です。
何らかの不具合によってプロジェクトが破損する恐れがありますので、ファイルを更新する際は必ずプロジェクトフォルダのバックアップをお願いします。

生成されるファイルについて

MV版「TRP_Particle」では、エディタプラグインでdata/TrpParticles.jsonのデータファイル及び、js/plugins/TRP_ParticleList.jsのプラグインファイルが自動で生成＆上書きされます。

MZ版「TRP_ParticleMZ」では、エディタプラグインでdataEx/TrpParticles.jsonのデータファイル、dataEx/TrpParticleGroups.json及び、js/plugins/TRP_ParticleMZList.jsのプラグインファイルが自動で生成＆上書きされます。

MV版TRP_ParticleのiOS14以上での動作について

RPGツクールMVは描画エンジンであるPIXIのバージョンが古いため、iOS14以降でWebGLモードでの描画に異常が生じる不具合が発生しています。TRP_ParticleもWebGLでの描画を行っているため描画に異常生じるケースがあります。

現在のところ、iOS14以上で正しく動作させるにはご自身でPIXIのバージョンを上げるほか対応が取れない状況ですのでご承知ください。

（「RPGツクールMV iOS14」などと検索すると関連する情報が得られると思います）

動作の保証範囲と不具合報告

それぞれの対応するRPGツクールのコアスクリプトバージョンであり、かつ他のプラグインを用いていない状況においては、本プラグインをマニュアル通りに利用して正しく動作しない場合は、基本的に不具合として対応いたします。

不具合については不具合報告フォームよりご連絡をお願いいたします。

（なお、不具合報告の前に、今一度マニュアルの該当箇所を読み直して、プラグインコマンドのパラメータ設定に間違いがないかご確認頂けると助かります。）

パーティクルプラグインの使用条件

←MV版マニュアルトップ
←MZ版マニュアルトップ

※DLC版「TRP_ParticleMZ」については付属のドキュメントに記載されている利用条件をお読みください。本記事の内容はBooth、DLSiteで販売しているプラグインの使用条件となります。

パーティクルプラグイン使用条件

PC版RPGツクールMV向け「パーティクルプラグイン『TRP_Particle』」（以下、本プラグイン）ならびにRPGツクールMZ向け「パーティクルプラグイン『TRP_Particle_MZ』」をご利用いただく際の取り扱いにつき定めるものです。本使用条件に同意した上で本プラグインをご利用下さい。

(1)TRP_Particle、TRP_ParticleMZならびに付属するプラグイン（以下、本プラグイン）の著作権はシロップ（以下、当方）に帰属します。
(2)TRP_Particleを購入した正規のユーザー（以下、利用者）は最新コアスクリプトバージョンにおけるRPGツクールMVプロジェクトにおいて使用することが可能です。また、TRP_ParticleMZのユーザーは最新コアスクリプトバージョンにおけるRPGツクールMZプロジェクトにおいて使用することが可能です。ただし、利用者の判断及び責任において、動作対応外のコアスクリプトバージョンにて使用することが可能です。動作対応外のコアスクリプトバージョンプロジェクトでの本プラグイン利用によって生じるいかなる損害、及び、本プラグインの動作不良について、当方はその責任を負わないものとします。
(3)他のプラグインとの併用は、利用者の判断及び責任において利用できます。ただし、他のプラグインとの併用によって生じるいかなる損害、及び、本プラグインの動作不良について、当方はその責任を負わないものとします。
(4)本プラグインのバージョンの更新により本プラグインを使用したプログラムや作品のセーブデータ、ならびに本プラグインが提供する機能の互換性が損なわれる場合があります。本プラグインのバージョン更新は利用者の責任において行うものとし、本プラグインのバージョン更新に伴って生じるいかなる損害、及び、本プラグインの動作不良について、当方はその責任を負わないものとします。
(5)商用・非商用・年齢制限を問わず、どのようなプロジェクトにも使用いただけます。
(6)本プラグインは、自由に改変して利用することができます。ただし、改変によって生じるいかなる損害、及び、本プラグインの動作不良について、当方はその責任を負わないものとします。
(7)改変の有無に限らず、本プラグインを無断で公開・配布・販売することを禁止します。
(8)本プラグインを使用した作品の公開・配布・販売する際には、同梱のテキストなどに本素材を使用した旨を明記して下さい。ただし、作品内で明記する必要はありません。
(9)利用者は、本プラグインを事故の責任と負担にて使用するものとします。ただし、正規の利用者が利用規約を遵守した上で当方の責めに帰すべき事由により、損害を被った場合には、その損害を賠償します。
(10)当方の賠償額は、賠償の原因となる事由が発生した時点から3000円を限度とします。
(11)本使用条件については、事前の予告なく変更となる可能性があります。

※ RPGツクールは、株式会社Gocha Gocha Gamesの登録商標です。
※ その他、記載されている会社名、製品名は、各社の登録商標または商標です。

2022年4月12日

動作確認用サンプル【パーティクルプラグイン】

←MV版マニュアルトップ
←MZ版マニュアルトップ

記事の最後よりパーティクルプラグインの動作確認用プラグインを含んだプロジェクトをダウンロードできます。

禁止事項と動作確認方法をよく読んでご同意の上ご利用ください。

このプラグインは「パーティクルプラグイン」の動作確認目的でのみRPGツクールのテストプレイ内で利用できます。

動作確認用プロジェクトの禁止事項/免責事項

• このプラグイン(検証用プラグイン「TRP_ParticleTest」「TRP_ParticleMZ_Test」）の改変を禁じます。
• このプラグインの再配布を禁じます。
• このプラグインをプロジェクトに含んだ状態での制作物の公開や配布を禁じます。
• 動作確認以外の用途でのサンプルプロジェクト内の画像の利用を禁じます。
• 本プラグインならびにサンプルプロジェクトは利用者の責任によって行うものとし、利用によって生じるいかなる責任もシロップは負わないものとします。

プラグイン機能の確認

プラグインの動作を確認したい場合は、サンプルプロジェクトをRPGツクールで開いてテストプレイを実行してイベントを調べてください。基本的な機能の実演が見ることができます。

下の動画のような実行結果になれば、テスト範囲内ではプラグインが正しく動いている可能性が高いです。

MV版

MZ版

ユーザープロジェクトでの動作確認

本プラグインは基本的に、対応するコアスクリプトバージョンにおいて他のプラグインを使用しない場合の利用を想定しております。（詳しくは、利用上の注意【パーティクルプラグイン】）

ただし、上記の環境を満たさない場合にも一部機能が動作する可能性があります。各自のプロジェクトで基本コマンドが動作するために動作確認プロジェクト内のTRP_ParticleTest/TRP_ParticleMZ_Testプラグインと画像(particlesフォルダ)を対象プロジェクトにインポートして動作確認を行うことができます。

あくまで、動作対応環境の範囲外ですので各自の判断にてご確認・ご利用ください。

1. サンプルプロジェクト内のプラグインフォルダ内(js/plugins/）のTRP_ParticleTest.jsまたはTRP_ParticleMZ_Test.jsとTRP_ParticlePreset.jsを動作確認したいプロジェクトのjs/pluginsフォルダに入れてください。
2. プラグイン管理からプラグインを取り込んでONにしてください。
3. サンプルプロジェクト内のimg/particlesフォルダ内のファイルを動作確認したいプロジェクトのimgフォルダ内にコピー・ペーストしてください。
4. 適当なイベントにスクリプトコマンドにて「this.trpParticleTest()」を入力して下さい。
5. イベントを実行して動作を確認してください。
6. 動作確認が済みましたらこのプラグインをプロジェクトより削除してください。

ダウンロード

動作確認プロジェクト（MV版）

※上記、禁止事項/免責事項に同意の上でご利用下さい。また、RPGツクールMVの正規ユーザーのみご利用頂けます。

動作確認プロジェクト（MZ版）

※上記、禁止事項/免責事項に同意の上でご利用下さい。また、RPGツクールMZの正規ユーザーのみご利用頂けます。