アイテムの入手処理を共通化【RPGツクールMZ&MVプラグイン】

2022年01月08日

 アイテムの入手処理を共通化します。
 ※なお、以下ではアイテムと記載していますが、武器、防具、所持金の全てに対して有効です。


 アイテムの増減時、自動的にコモンイベントを呼び出します。


 さらに直前に入手したアイテムの情報(アイテム名や増減量など)をプラグインコマンドで参照することによって、入手処理の共通化を実現します。

 また、指定のスイッチがオンの間だけ、コモンイベントの呼び出しを禁止することもできます。

 ※ちなみに上記のアイコンのポップアップはIconBalloon.js(シロップ様)によるものです。当プラグインはあくまで処理を共通化するだけとなります。

目次


導入方法(Install)

更新履歴(History)

使用方法(Usage)

MZ用プラグインコマンド(Plugin Command MZ)

MV用プラグインコマンド(Plugin Command MV)

プラグインパラメータ(Plugin Parameter)

所持金コモンイベント(GoldCommonEvent)

アイテムコモンイベント(ItemCommonEvent)

武器コモンイベント(WeaponCommonEvent)

防具コモンイベント(ArmorCommonEvent)

無効化スイッチ(DisableSwitch)


導入方法(install)


 以下のファイルを右クリックで保存し 、[プロジェクト]\js\plugins に放り込みます。ツクールのプラグイン管理から機能をONにしてください。
 ※このプラグインはMV、MZの両方で有効です。

 NRP_GetItemCommon.js ver1.01(2022/01/08)

更新履歴(History)


2022/01/08(ver1.01)

  • 説明文などの文字列が空の場合、不要な文字列が表示される不具合修正。
  • 他プラグインとの競合対処用に微調整。

2021/12/04(ver1.00)

  • 公開!

使用方法(Usage)


 アイテム入手後に呼び出されるコモンイベントを作成し、プラグインパラメータに設定してください。
 ※アイテム、武器、防具、所持金のそれぞれに対して設定可能ですが、所持金以外は同じコモンイベントでも問題ないと思います。

 プラグインコマンドで入手したアイテムの情報を取得し、変数に格納します。
 以下の例では……

  • アイテム名を変数1
  • 増減量を変数2
  • 説明文を変数3
  • アイコンIDを変数4

 ……にそれぞれ格納しています。

 さらにそれをメッセージで表示します。
 増減量によって、メッセージを分岐させたほうが違和感ないと思います。

アイテム、武器、防具の場合



増減量が1の時

\i[\v[4]]\v[1]を手に入れた!
\v[3]

アイテムの増減量が2以上の時

\i[\v[4]]\v[1]を\v[2]個手に入れた!
\v[3]

アイテムの増減量が−1以下の時

\i[\v[4]]\v[1]を\v[2]個失った……。
\v[3]

※増減量に-1を乗算して反転させています。
所持金の場合

 ※対象が『所持金』の場合は増減量のみが有効となります。



増減量が1以上の時

\v[2]\gを手に入れた!
\v[3]

増減量が−1以下の時

\v[2]\gを失った……。
\v[3]

※増減量に-1を乗算して反転させています。


 これらはあくまで一例です。演出なども自由に挟んでください。

 後は『アイテムの増減』『武器の増減』『防具の増減』『所持金の増減』の各処理を実行した際にメッセージが表示されればOKです。

 また、必ずしも全ての場合に対してメッセージが必要なわけではありません。例えば「アイテムの『増減量が−1以下の時』については、頻度も低いので、通常のイベント内でメッセージを記述する」といった運用でもよいと思います。

 共通処理を実行したくない場合は『無効化スイッチ』を設定することもできますので、柔軟に対応してください。

MZ用プラグインコマンド(Plugin Command MZ)


 直前に入手したアイテムの各情報を変数に格納します。
 メッセージ内で\v[1]のように変数を指定すると、値が表示されます。
 ※対象が『所持金』の場合は増減量のみが有効となります。

アイテム名を取得

 直前に入手したアイテムの名前を変数へ格納します。

増減量を取得

 直前に入手したアイテムの増減量を変数へ格納します。

説明文を取得

 直前に入手したアイテムの説明文を変数へ格納します。
 改行も有効です。

アイコンを取得

 直前に入手したアイテムのアイコンIDを変数へ格納します。

分類を取得

 直前に入手したアイテムの分類を変数へ格納します。

IDを取得

 直前に入手したアイテムIDを変数へ格納します。

タイプを取得

 直前に入手したアイテムのタイプを変数へ格納します。
 アイテム、武器、防具、それぞれのタイプに対応します。

 アイテムの場合は以下の通りです。
  1:通常アイテム、2:大事なもの、3:隠しアイテムA、4:隠しアイテムB
 ※武器防具についてはデータベースの設定値を参照してください。

装備タイプを取得

 直前に入手した防具の装備タイプを変数へ格納します。
 ※選択はできませんが、実際には武器も1が固定で設定される模様です。

メタ値を取得

 直前に入手したアイテムのメタ値を変数へ格納します。
 この項目のみ定義名の指定が必要です。

 メタ値とはメモ欄にユーザが定義した値のことです。
 例えば、<Test:100>と記述した場合、『Test』の部分を定義名に指定すると、変数に100が格納されます。

 独自にアイテムの区別を行いたい場合などに便利かもしれません。
 ※<Important:1>の場合のみ、入手時にファンファーレを鳴らすなど。

MV用プラグインコマンド(Plugin Command MV)


 機能はMZ版と全く同じなので割愛します。
 以下のコマンドを呼び出してください。
 ※大文字個別は区別しません。また[]は含まないでください。

アイテム名を取得

NRP.GetItemCommon.GetName [変数ID]

増減量を取得

NRP.GetItemCommon.GetAmount [変数ID]

説明文を取得

NRP.GetItemCommon.GetDescription [変数ID]

アイコンを取得

NRP.GetItemCommon.GetIcon [変数ID]

分類を取得

NRP.GetItemCommon.GetCategory [変数ID]

IDを取得

NRP.GetItemCommon.GetId [変数ID]

タイプを取得

NRP.GetItemCommon.Type [変数ID]

装備タイプを取得

NRP.GetItemCommon.EquipType [変数ID]

メタ値を取得

NRP.GetItemCommon.GetMetaValue [定義名] [変数ID]


プラグインパラメータ(Plugin Parameter)


所持金コモンイベント(GoldCommonEvent)

 所持金の増減時に呼び出されるコモンイベントです。

アイテムコモンイベント(ItemCommonEvent)

 アイテムの増減時に呼び出されるコモンイベントです。

武器コモンイベント(WeaponCommonEvent)

 武器の増減時に呼び出されるコモンイベントです。

防具コモンイベント(ArmorCommonEvent)

 防具の増減時に呼び出されるコモンイベントです。

無効化スイッチ(DisableSwitch)

 指定のスイッチがオンの間、コモンイベントの呼び出しを無効化します。
 ※なお、コモンイベントの先頭でスイッチ分岐させて『イベント処理の中断』を実行しても同じです。よく考えたらなくてもいいですよね、この項目……。

 >RPGツクールMZ&MV目次に戻る
posted by 砂川赳 at 18:10 | RPGツクールMZ&MV | このブログの読者になる | 更新情報をチェックする