パラメータ解析を提供する共通基盤 - PluginCommonBase.js
シェア用テキスト：
▼パラメータ解析を提供する共通基盤（トリアコンタン様作） - PluginCommonBase.js
https://plugin-mz.fungamemake.com/archives/364
他のプラグインから参照されることを前提としたベースプラグインです。本プラグインを導入すると様々な場面で以下の制御文字が使えるようになります。
ふりがな：ぱらめーたかいせきをていきょうするきょうつうきばん
機能概要： 他のプラグインから参照されることを前提としたベースプラグインです。本プラグインを導入すると様々な場面で以下の制御文字が使えるようになります。
利用規約（ライセンス）：
・ツクールシリーズ利用規約にのみ従ってください。
・商用利用：許可
・追加改変：許可
・再配布：許可
作者：トリアコンタン
ダウンロードページ：https://tkool.jp/mz/download/
ファイル名：PluginCommonBase.js
備考：RPGツクールMZ公式プラグイン。 C:Program Files (x86)SteamsteamappscommonRPG Maker MZdlc C:Program FilesKADOKAWARPGMZdlcBasicResources
プラグインのヘルプ：
/*:ja
* @target MZ
* @plugindesc パラメータ解析を提供する共通基盤です
* @author トリアコンタン
*
* @help PluginCommonBase.js
*
* 本プラグインは他のプラグインから参照されることを前提としたベースプラグインです。
* 本プラグインを導入すると様々な場面で以下の制御文字が使えるようになります。
*
* 利用可能な制御文字
* v[n] : n番目の変数の値に変換されます。
* s[n] : n番目のスイッチの値(true, false)に変換されます。
* ss[n] : セルフスイッチの値(true, false)に変換されます。
* n -> A, B, C, D
*
* 制御文字を利用可能な場面は以下の通りです。
* ・文章の表示
* ・メモ欄(※)
* ・プラグインコマンド(※)
* ・プラグインパラメータ(※)
* ・スキルなどの説明欄
* ※ PluginCommonBase.jsをベースとして取り込んだプラグインのみ
*
* 以下は開発者向けの解説です。
*
* このプラグインをベースとして取り込むことで、パラメータの解析や
* プラグインコマンド、メモ欄の取得時にパラメータ型および制御文字の変換を自動化します。
* 制御文字の変換処理を共通化することで配下の全てのプラグインで一貫した
* 制御文字の変換仕様を実現します。
*
* ・プラグインパラメータの型解析
* プラグインパラメータを自動で型解析し変換します。
* また、パラメータ取得時に制御文字の変換を自動で行います。
* 以下のメソッドを呼んで戻り値を取得します。
* 引数には必ず「document.currentScript」を指定します。
*
* PluginManagerEx.createParameter(document.currentScript);
*
* ただし、パラメータ名の末尾が(大文字小文字問わず)以下の値の場合
* 制御文字や型の変換は行われず、そのままの値を返します。
* text
* name
* note
* desc
* script
*
* ・プラグインコマンドパラメータの型解析
* プラグインコマンドパラメータを自動で型解析し変換します。
* また、パラメータ取得時に制御文字の変換を自動で行います。
* PluginManager.registerCommandの代わりに以下を使用します。
* 引数には必ず「document.currentScript」を指定します。
*
* PluginManagerEx.registerCommand(document.currentScript, ”command”, args => {
* });
*
* ・メモ欄の解析
* 指定したオブジェクトからメモ欄情報を取得します。
* 制御文字の変換を自動で行います。
* 名称は複数指定することも可能です。
*
* PluginManagerEx.findMetaValue(obj, tagName1, tagName2...);
*
* ・動的コモンイベントの実行
* 動的コモンイベントを実行できます。
* 動的コモンイベントとは、スタック型の並列処理コモンイベントです。
* 同一IDのコモンイベントも好きなだけ並列実行できます。
* 実行が終わったものから自働で破棄されます。
*
* $gameMap.setupDynamicCommon(commonEventId);
*/