NRP アイテムの入手処理を共通化 - NRP_GetItemCommon.js

シェア用テキスト：

▼NRP アイテムの入手処理を共通化（砂川赳様作） - NRP_GetItemCommon.js
https://plugin.fungamemake.com/archives/28697
アイテムの入手処理を共通化します。

ふりがな：あいてむのにゅうしゅしょりをきょうつうか

機能概要： アイテムの入手処理を共通化します。

利用規約（ライセンス）：
・著作権：保持
・商用利用：許可
・追加改変：許可
・再配布：許可
・詳細はダウンロードページ・プラグイン内を確認

作者：砂川赳

作者サイト：https://newrpg.seesaa.net/

解説ページ：https://newrpg.seesaa.net/article/484654978.html

ファイル名：NRP_GetItemCommon.js

プラグインのヘルプ：

/*:ja
 * @target MV MZ
 * @plugindesc v1.00 アイテムの入手処理を共通化します。
 * @author 砂川赳（http://newrpg.seesaa.net/）
 * @url http://newrpg.seesaa.net/article/484654978.html
 *
 * @help アイテムの入手処理を共通化します。
 * なお、以下ではアイテムと記載していますが、
 * 武器、防具、所持金の全てに対して有効です。
 * 
 * アイテムの増減時、自動的にコモンイベントを呼び出します。
 * さらにアイテム名や増減量などの情報をプラグインコマンドで参照できます。
 * これにより、入手処理の共通化を実現します。
 * 
 * また、指定のスイッチがオンの間だけ、
 * コモンイベントの呼び出しを禁止することもできます。
 * 
 * ------------------------------------------
 * ■ＭＺ版プラグインコマンド
 * ------------------------------------------
 * 直前に入手したアイテムの各情報を変数に格納します。
 * メッセージ内でv[1]のように変数を指定すると、値が表示されます。
 * ※対象が『所持金』の場合は増減量のみが有効となります。
 * 
 * ◆アイテム名を取得
 * 直前に入手したアイテムの名前を変数へ格納します。
 * 
 * ◆増減量を取得
 * 直前に入手したアイテムの増減量を変数へ格納します。
 * 
 * ◆説明文を取得
 * 直前に入手したアイテムの説明文を変数へ格納します。
 * 改行も有効です。
 * 
 * ◆アイコンを取得
 * 直前に入手したアイテムのアイコンＩＤを変数へ格納します。
 * 
 * ◆分類を取得
 * 直前に入手したアイテムの分類を変数へ格納します。
 * 
 * ◆ＩＤを取得
 * 直前に入手したアイテムＩＤを変数へ格納します。
 * 
 * ◆タイプを取得
 * 直前に入手したアイテムのタイプを変数へ格納します。
 * アイテム、武器、防具、それぞれのタイプに対応します。
 * 
 * アイテムの場合は以下の通りです。
 * 　1:通常アイテム、2:大事なもの、3:隠しアイテムA、4:隠しアイテムB
 * 武器防具についてはデータベースの設定値を参照してください。
 * 
 * ◆装備タイプを取得
 * 直前に入手した防具の装備タイプを変数へ格納します。
 * 
 * ◆メタ値を取得
 * 直前に入手したアイテムのメタ値を変数へ格納します。
 * この項目のみ定義名の指定が必要です。
 * 
 * メタ値とはメモ欄にユーザが定義した値のことです。
 * 例えば、<Test:100>と記述した場合、
 * 『Test』の部分を定義名に指定すると、変数に100が格納されます。
 * 
 * ------------------------------------------
 * ■ＭＶ版プラグインコマンド
 * ------------------------------------------
 * 機能はＭＺ版と全く同じなので割愛します。
 * 以下のコマンドを呼び出してください。
 * ※大文字個別は区別しません。また[]は含まないでください。
 * 
 * ◆アイテム名を取得
 * NRP.GetItemCommon.GetName [変数ＩＤ]
 * 
 * ◆増減量を取得
 * NRP.GetItemCommon.GetAmount [変数ＩＤ]
 * 
 * ◆説明文を取得
 * NRP.GetItemCommon.GetDescription [変数ＩＤ]
 * 
 * ◆アイコンを取得
 * NRP.GetItemCommon.GetIcon [変数ＩＤ]
 * 
 * ◆分類を取得
 * NRP.GetItemCommon.GetCategory [変数ＩＤ]
 * 
 * ◆ＩＤを取得
 * NRP.GetItemCommon.GetId [変数ＩＤ]
 * 
 * ◆タイプを取得
 * NRP.GetItemCommon.GetType [変数ＩＤ]
 * 
 * ◆装備タイプを取得
 * NRP.GetItemCommon.GetEquipType [変数ＩＤ]
 * 
 * ◆メタ値を取得
 * NRP.GetItemCommon.GetMetaValue [定義名] [変数ＩＤ]
 * 
 * ------------------------------------------
 * ■利用規約
 * ------------------------------------------
 * 特に制約はありません。
 * 改変、再配布自由、商用可、権利表示も任意です。
 * 作者は責任を負いませんが、不具合については可能な範囲で対応します。
 * 
 * @command GetName
 * @text アイテム名を取得
 * @desc 直前に入手したアイテム（武器・防具）の名前を変数へ格納します。
 * 
 * @arg Variable
 * @text 変数
 * @desc アイテム名を格納する変数です。
 * @type variable
 * 
 * 
 * @command GetAmount
 * @text 増減量を取得
 * @desc 直前に入手したアイテム（武器・防具）または所持金の増減量を変数へ格納します。
 * 
 * @arg Variable
 * @text 変数
 * @desc 増減量を格納する変数です。
 * @type variable
 * 
 * 
 * @command GetDescription
 * @text 説明文を取得
 * @desc 直前に入手したアイテム（武器・防具）の説明文を変数へ格納します。
 * 
 * @arg Variable
 * @text 変数
 * @desc 説明文を格納する変数です。
 * @type variable
 * 
 * 
 * @command GetIcon
 * @text アイコンを取得
 * @desc 直前に入手したアイテムのアイコンＩＤを変数へ格納します。
 * 
 * @arg Variable
 * @text 変数
 * @desc アイテムのアイコンＩＤを格納する変数です。
 * @type variable
 * 
 * 
 * @command GetCategory
 * @text 分類を取得
 * @desc 直前に入手したアイテムの分類を変数へ格納します。
 * 0:所持金、1:アイテム、2:武器、3:防具
 * 
 * @arg Variable
 * @text 変数
 * @desc アイテム分類を格納する変数です。
 * @type variable
 * 
 * 
 * @command GetId
 * @text アイテムＩＤを取得
 * @desc 直前に入手したアイテム（武器・防具）のＩＤを変数へ格納します。
 * 
 * @arg Variable
 * @text 変数
 * @desc アイテムＩＤを格納する変数です。
 * @type variable
 * 
 * 
 * @command GetType
 * @text タイプを取得
 * @desc 直前に入手したアイテムのタイプを変数へ格納します。
 * アイテム、武器、防具、それぞれのタイプに対応します。
 * 
 * @arg Variable
 * @text 変数
 * @desc タイプを格納する変数です。
 * @type variable
 * 
 * 
 * @command GetEquipType
 * @text 装備タイプを取得
 * @desc 直前に入手した防具の装備タイプを変数へ格納します。
 * 
 * @arg Variable
 * @text 変数
 * @desc 装備タイプを格納する変数です。
 * @type variable
 * 
 * 
 * @command GetMetaValue
 * @text メタ値を取得
 * @desc 直前に入手したアイテム（武器・防具）のメタ値を変数へ格納します。
 * 
 * @arg MetaName
 * @text 定義名
 * @desc メタ値の定義名です。
 * ※例：<Test:100>ならTestの部分に当たります。
 * @type string
 * 
 * @arg Variable
 * @text 変数
 * @desc メタ値を格納する変数です。
 * @type variable
 * 
 * 
 * @param GoldCommonEvent
 * @text 所持金コモンイベント
 * @type common_event
 * @desc 所持金の増減時に呼び出されるコモンイベントです。
 * 
 * @param ItemCommonEvent
 * @text アイテムコモンイベント
 * @type common_event
 * @desc アイテムの増減時に呼び出されるコモンイベントです。
 * 
 * @param WeaponCommonEvent
 * @text 武器コモンイベント
 * @type common_event
 * @desc 武器の増減時に呼び出されるコモンイベントです。
 * 
 * @param ArmorCommonEvent
 * @text 防具コモンイベント
 * @type common_event
 * @desc 防具の増減時に呼び出されるコモンイベントです。
 * 
 * @param DisableSwitch
 * @text 無効化スイッチ
 * @type switch
 * @desc 指定のスイッチがオンの間、コモンイベントの呼び出しを無効化します。
 */