Tsumio Menu System - TsumioMenuSystem.js

シェア用テキスト：

▼Tsumio Menu System（ツミオ様作） - TsumioMenuSystem.js
https://plugin.fungamemake.com/archives/1809
メニュー画面を改造するプラグインです。

ふりがな：つみお　めにゅーかくちょう

機能概要： メニュー画面を改造するプラグインです。

利用規約（ライセンス）： MITライセンス

作者：ツミオ

作者サイト：https://x.com/TsumioNtGame

解説ページ：https://forum.tkool.jp/index.php?threads/471/

ダウンロードページ：https://raw.githubusercontent.com/Tsumio/rmmv-plugins/m…

ファイル名：TsumioMenuSystem.js

プラグインのヘルプ：

/*:ja
 * @plugindesc メニュー画面を改造するプラグインです。
 * @author ツミオ
 *
 * @param ----基本的な設定----
 * @desc 
 * @default 
 * 
 * @param メニューの行数
 * @type number
 * @max 10
 * @desc メニューの行数を設定します。
 * @default 2
 * 
 * @param メニューの最大列数
 * @type number
 * @max 10
 * @desc メニューの最大列数を設定します。
 * @default 5
 * 
 * @param ステータスの最大列数
 * @type number
 * @max 10
 * @desc ステータスウィンドウの最大列数を設定します。3～5程度を推奨します。
 * @default 4
 * 
 * @param 章ウィンドウを表示する
 * @type boolean
 * @desc 章ウィンドウを表示するかどうかを設定します。
 * @default true
 * 
 * @param 章ウィンドウの高さ
 * @type number
 * @max 1000
 * @desc 章ウィンドウの高さを設定します。
 * @default 70
 * 
 * @param ステータスウィンドウの高さ
 * @type number
 * @max 1000
 * @desc ステータスウィンドウの高さを設定します。
 * @default 290
 * 
 * 
 * @param 顔グラフィックのサイズ
 * @type struct<Size>
 * @desc 顔グラフィックのサイズを設定します。初期値:105*30 フルサイズ:144*144
 * @default {”width”:”105”,”height”:”30”}
 * 
 * 
 * @param サブウィンドウのフォントサイズ
 * @type number
 * @max 1000
 * @desc サブウィンドウ（チップスウィンドウと情報ウィンドウ）のフォントサイズを設定します。
 * @default 17
 * 
 * @param ----ヘルプの設定----
 * @desc 
 * @default 
 * 
 * @param ヘルプを利用する
 * @type select
 * @option 利用する
 * @value On
 * @option 切り替え
 * @value Switching
 * @option 利用しない
 * @value Off
 * @desc ヘルプを利用するかどうかを設定します。
 * @default Switching
 * 
 * @param ヘルプ用テキスト
 * @type string[]
 * @desc コマンドの順にヘルプ用のテキストを設定します。
 * @default [”アイテムシーンへ移行します。”, ”スキルシーンへ移行します。”, ”装備シーンへ移行します。”, ”ステータス画面へ移行します。”, ”並び替え機能を実行します。”, ”オプションシーンへ移行します。”, ”セーブ画面へ移行します。”, ”ゲームを終了します。”]
 * 
 * @param ----文字列の設定----
 * @desc 
 * @default 
 * 
 * @param 項目名の色
 * @type number
 * @max 31
 * @desc サブウィンドウ内における項目名の色を設定します。色と番号の対応はウィンドウ画像に準拠します。
 * @default 1
 * 
 * @param 項目内容の色
 * @type number
 * @max 31
 * @desc サブウィンドウ内における項目内容の色を設定します。色と番号の対応はウィンドウ画像に準拠します。
 * @default 0
 * 
 * @param 現在地を表す文字列
 * @type string
 * @desc 現在地を表す文字列を設定します。
 * @default 現在地
 * 
 * @param 所持金を表す文字列
 * @type string
 * @desc 所持金を表す文字列を設定します。
 * @default 所持金
 * 
 * @param 戦闘回数を表す文字列
 * @type string
 * @desc 戦闘回数を表す文字列を設定します。
 * @default 戦闘回数
 * 
 * @param プレイ時間を表す文字列
 * @type string
 * @desc プレイ時間を表す文字列を設定します。
 * @default プレイ時間
 * 
 * @param オプション1
 * @type string
 * @desc オプション1を表す文字列を設定します。
 * @default オプション1
 * 
 * @param オプション1の内容
 * @type string
 * @desc オプション1の内容を設定します。変数の内容を指定したい場合、例えばV[1]と記入してください。
 * @default V[1]
 * 
 * @param オプション2
 * @type string
 * @desc オプション2を表す文字列を設定します。
 * @default オプション2
 * 
 * @param オプション2の内容
 * @type string
 * @desc オプション2の内容を設定します。Chronus.jsと連携したい場合、[Chronus1]か[Chronus2]と記入してください。
 * @default [Chronus2]
 * 
 * 
 * @param ----背景の設定----
 * @desc 
 * @default 
 * 
 * @param メイン背景の画像
 * @type file
 * @require 1
 * @desc メイン背景の画像を設定します。
 * @dir img/tsumio
 * @default
 * 
 * @param メイン背景の設定
 * @type struct<Background>
 * @desc メイン背景の設定を設定します。幅と高さにマイナスの値を設定すると、スクリーンサイズが代入されます。
 * @default {”x”:”0”, ”y”:”0”, ”width”:”-1”, ”height”:”-1”, ”speedX”:”0.00”, ”speedY”:”0.00”}
 * 
 * @param サブ背景の画像
 * @type file
 * @require 1
 * @desc メイン背景の画像を設定します。
 * @dir img/tsumio
 * @default
 * 
 * @param サブ背景の設定
 * @type struct<Background>
 * @desc メイン背景の設定を設定します。幅と高さにマイナスの値を設定すると、スクリーンサイズが代入されます。
 * @default {”x”:”0”, ”y”:”0”, ”width”:”-1”, ”height”:”-1”, ”speedX”:”0.00”, ”speedY”:”0.00”}
 * 
 * @param パーティクルの画像
 * @type file
 * @require 1
 * @desc パーティクルの画像を設定します。
 * @dir img/tsumio
 * @default
 * 
 * @param パーティクルの設定
 * @type struct<Particle>
 * @desc パーティクルの設定を設定します。幅と高さにマイナスの値を設定すると、スクリーンサイズが代入されます。
 * @default {”x”:”0”, ”y”:”0”, ”width”:”-1”, ”height”:”-1”, ”speedX”:”-1.00”, ”speedY”:”1.00”, ”opacity”:”150”, ”blendMode”:”0”}
 * 
 * @param パーティクルの点滅
 * @type boolean
 * @desc パーティクルを点滅させるかどうかを設定します。
 * @default true
 * 
 * @param ----特殊な設定----
 * @desc 
 * @default 
 * 
 * @param 比率
 * @type number[]
 * @max 1
 * @decimals 2
 * @desc サブウィンドウ内における文字列の配置の比率を設定します。
 * @default [”0.00”, ”0.35”, ”0.70”]
 * 
 * @param コンテンツの高さ
 * @type struct<LineHeight>
 * @desc ステータスウィンドウ内のコンテンツの高さを設定します。数字が大きいほど下に表示されます。
 * @default {”class”:”-1”, ”face”:”0”, ”name”:”1”, ”level”:”2”, ”icons”:”2”, ”hp”:”3”, ”mp”:”4”, ”tp”:”5”, ”exp”:”6”}
 * 
 * @param ウィンドウスキン
 * @type struct<WindowSkin>
 * @desc 各ウィンドウのスキンを設定します。
 * @default {”command”:””, ”status”:””, ”chapter”:””, ”tips”:””, ”info”:””}
 * 
 * @param 情報ウィンドウの更新
 * @type number
 * @min -1
 * @desc 情報ウィンドウを指定フレームで更新します。マイナスの値が設定された場合は更新しません。
 * @default -1
 * 
 * 
 * @help メニュー画面を改造するプラグインです。
 * 
 * 【特徴】
 * ・メニュー画面の見た目を改造します。
 * ・メニュー画面のキー操作を向上させます。
 * ・章表示用のウィンドウが用意されています。
 * ・チップス表示用のウィンドウが表示されています。
 * ・情報ウィンドウに任意の変数内容を表示することもできます。
 * ・プラグインコマンドでセットした情報はセーブデータに保存されます。
 * ・トリアコンタンさんが制作したプラグインChronus.jsと連携できます。
 * 
 * 【使用方法】
 * プラグインの導入後、プラグインパラメーターを設定することによって使用できます。
 * 
 * メニュー画面にはサイドビューバトラーが表示されますが、データーベースの「サイドビュー戦闘を使用」がOFFになっている場合は表示されません。
 * 
 * 【章ウィンドウ】
 * プラグインコマンドから章タイトルを設定できます。
 * また、メニューのヘルプを表示させることにも使えます。
 * 詳しくはプラグインパラメーターの「ヘルプを利用する」をご覧ください。
 * 制御文字の使用も可能です。
 * 
 * v1.0.1より、章ウィンドウの非表示が可能になりました。
 * 章ウィンドウを非表示にした場合、パラメーターで設定した章ウィンドウの高さ分だけウィンドウが詰めて表示されます。
 * このとき、拡大されるウィンドウはチップスウィンドウと情報ウィンドウです。
 * ステータスウィンドウを拡大したい場合はプラグインパラメーターでステータスウィンドウの高さを変更してください。
 * 
 * 【チップスウィンドウ】
 * プラグインコマンドから各チップスを設定できます。
 * 制御文字の使用も可能です。
 * 
 * 【オプション】
 * プラグインパラメーターの「オプション」には任意の情報を記すことができます。
 * 例えば「V[1]」と入力すると、変数1の内容がオプションに表示されます。
 * 
 * 【Chronus.jsとの連携】
 * 当プラグインはトリアコンタンさんが制作したChronus.jsとの連携をサポートしています。
 * オプションの内容に「[Chronus1]」と入力すると日時フォーマット1を取得します。
 * また、「[Chronus2]」と入力すると日時フォーマット2を取得します。
 * 
 * 参考URL：https://raw.githubusercontent.com/triacontane/RPGMakerMV/master/Chronus.js
 * 
 * 【DestinationWindow.jsとの連携】
 * 当プラグインはトリアコンタンさんが制作したDestinationWindow.jsとの連携をサポートしています。
 * オプションの内容に「[Destination]」と入力すると、設定した行動目標をを取得します。
 * 
 * 参考URL：https://raw.githubusercontent.com/triacontane/RPGMakerMV/master/DestinationWindow.js
 * 
 *【コンテンツの高さ】
 * プラグインパラメーターのコンテンツの高さを設定すると、ステータスウィンドウにおける表示内容の高さを変更することができます。
 * 数字を大きくすれば大きくするほど表示内容は下に表示されます。
 * なお、高さはピクセルで指定するのではなく行単位です。
 * 
 * 【背景画像とパーティクル】
 * 背景画像とパーティクルを設定することができます。
 * サブ背景はメイン背景よりも上に表示されます。
 * X軸Y軸のスピードを変更することにより、画像をループさせて移動させることもできます。
 * 
 * 【ウィンドウスキン】
 * ウィンドウスキンを設定しない場合、標準のウィンドウスキンが適用されます。
 * 
 * 【情報ウィンドウの更新】
 * 指定したフレームで情報ウィンドウが更新されます（-1を指定すると更新はおこなわれません）。
 * 使用する場合、60程度を推奨します。
 * 
 * なお、Chronus.jsの情報は更新されません。
 * 
 * 【プラグインコマンド】
 * 全てのプラグインコマンドは「TMS」から始まります。
 * また、説明上では視認性のためにカギカッコを使用していますが、実際にプラグインコマンドに入力する際には
 * カギカッコの入力は不要です。
 * 
 * 全てのプラグインコマンドは大文字と小文字を区別します。
 * 各単語の間は半角スペースで区切ります（全角では認識しません）。
 * 間違わないように気をつけてください。
 * 
 * 「TMS setChapterName 設定する文字列」 : 章ウィンドウに文字列を設定します。制御文字の使用も可能です。
 * 「TMS setTips1 設定する文字列」 : チップスウィンドウ上部の文字列を設定します。制御文字の使用も可能です。
 * 「TMS setTips2 設定する文字列」 : チップスウィンドウ下部の文字列を設定します。制御文字の使用も可能です。
 * 
 * 【その他】
 * メニュー画面のキー操作の仕様が通常のツクールMV製のものと異なります。
 * 基本的には操作性が向上していると思っていただいて問題ないですが、キー操作向上系のプラグインと併用すると競合するかもしれません。
 * 
 * また、解像度を変えたり、行数や列数を変えたりした場合、不具合が出るかもしれません。
 * 
 * 【更新履歴】
 * 1.1.3 2017/10/27 情報ウィンドウのリアルタイム更新機能を追加。
 * 1.1.2 2017/10/13 メソッド名の修正。
 * 1.1.1 2017/10/12 バグ修正。背景設定・ウィンドウスキン設定・DestinationWindow.jsとの連携機能の追加。
 * 1.1.0 2017/10/11 コンテンツの高さパラメーターの追加とコードの改善。
 * 1.0.2 2017/10/10 バグ修正とコードの改善。
 * 1.0.1 2017/10/10 バグ修正と設定項目の追加。
 * 1.0.0 2017/10/09 公開。
 * 
 * 【備考】
 * 当プラグインを利用したことによるいかなる損害に対しても、制作者は一切の責任を負わないこととします。
 * 
 * 【利用規約】
 * ソースコードの著作権者が自分であると主張しない限り、
 * 作者に無断で改変、再配布が可能です。
 * 利用形態（商用、18禁利用等）についても制限はありません。
 * 自由に使用してください。
 * 
 */
/*~struct~Size:
 *
 * @param width
 * @type number
 * @desc 幅(width).
 * 
 * @param height
 * @type number
 * @desc 高さ(height).
 */
/*~struct~Background:
 *
 * @param x
 * @type number
 * @min -2000
 * @max 2000
 * @desc X座標(X coordinate).
 * 
 * @param y
 * @type number
 * @min -2000
 * @max 2000
 * @desc Y座標(Y coordinate).
 * 
 * @param width
 * @type number
 * @min -2000
 * @max 2000
 * @desc 幅(width).
 * 
 * @param height
 * @type number
 * @min -2000
 * @max 2000
 * @desc 高さ(height).
 * 
 * @param speedX
 * @type number
 * @min -255
 * @max 255
 * @decimals 2
 * @desc X軸のスピード(The speed of the X direction).
 * 
 * @param speedY
 * @type number
 * @min -255
 * @max 255
 * @decimals 2
 * @desc Y軸のスピード(The speed of the Y direction).
 * 
 */
/*~struct~Particle:
 *
 * @param x
 * @type number
 * @min -2000
 * @max 2000
 * @desc X座標(X coordinate).
 * 
 * @param y
 * @type number
 * @min -2000
 * @max 2000
 * @desc Y座標(Y coordinate).
 * 
 * @param width
 * @type number
 * @min -2000
 * @max 2000
 * @desc 幅(width).
 * 
 * @param height
 * @type number
 * @min -2000
 * @max 2000
 * @desc 高さ(height).
 * 
 * @param speedX
 * @type number
 * @min -255
 * @max 255
 * @decimals 2
 * @desc X軸のスピード(The speed of the X direction).
 * 
 * @param speedY
 * @type number
 * @min -255
 * @max 255
 * @decimals 2
 * @desc Y軸のスピード(The speed of the Y direction).
 * 
 * @param opacity
 * @type number
 * @max 255
 * @desc 透明度(opacity).
 * 
 * @param blendMode
 * @type number
 * @max 3
 * @desc ブレンドモード(blend mode).0：通常 1：加算 2：乗算 3：スクリーン(0:Normal 1:Addition 2:Multiplication 3:Screen).
 * 
 */
/*~struct~LineHeight:
 * 
 * @param class
 * @type number
 * @min -255
 * @max 255
 * @desc 職業(class).
 * 
 * @param face
 * @type number
 * @min -255
 * @max 255
 * @desc 顔グラフィック(face).
 * 
 * @param name
 * @type number
 * @min -255
 * @max 255
 * @desc 名前(name).
 * 
 * @param level
 * @type number
 * @min -255
 * @max 255
 * @desc レベル(level).
 * 
 * @param icons
 * @type number
 * @min -255
 * @max 255
 * @desc アイコン(icons).
 * 
 * @param hp
 * @type number
 * @min -255
 * @max 255
 * @desc HP.
 * 
 * @param mp
 * @type number
 * @min -255
 * @max 255
 * @desc MP.
 * 
 * @param tp
 * @type number
 * @min -255
 * @max 255
 * @desc TP.
 * 
 * @param exp
 * @type number
 * @min -255
 * @max 255
 * @desc 経験値(exp).
 */
/*~struct~WindowSkin:
 *
 * @param command
 * @type file
 * @require 1
 * @desc コマンドウィンドウのスキン(The skin of the command window).
 * @dir img/tsumio
 * 
 * @param status
 * @type file
 * @require 1
 * @desc ステータスウィンドウのスキン(The skin of the status window).
 * @dir img/tsumio
 * 
 * @param chapter
 * @type file
 * @require 1
 * @desc 章ウィンドウのスキン(The skin of the chapter window).
 * @dir img/tsumio
 * 
 * @param tips
 * @type file
 * @require 1
 * @desc チップスウィンドウのスキン(The skin of the tips window).
 * @dir img/tsumio
 * 
 * @param info
 * @type file
 * @require 1
 * @desc 情報ウィンドウのスキン(The skin of the info window).
 * @dir img/tsumio
 * 
 */