Sakura キーボードガイドウィンドウを表示 - Sakura_FreeKeyboardGuide.js

シェア用テキスト：

▼Sakura キーボードガイドウィンドウを表示（Sakurano様作） - Sakura_FreeKeyboardGuide.js
https://plugin-mz.fungamemake.com/archives/7353
キーボードガイドウィンドウを表示するプラグインです。

ふりがな：きーぼーどがいどうぃんどうをひょうじ

機能概要： キーボードガイドウィンドウを表示するプラグインです。

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

作者：Sakurano

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

解説ページ：https://github.com/Sakurano6130/SakuraPlugins/blob/main…

ファイル名：Sakura_FreeKeyboardGuide.js

プラグインのヘルプ：

*:
 * @target MZ
 * @plugindesc キーボードガイドを自由に出せるプラグイン
 * @author Sakurano
 * @url https://github.com/Sakurano6130/SakuraPlugins/
 *
 * @help
 * キーボードガイドウィンドウを表示するプラグインです。
 *
 * -------------------------------------------------
 * Sakura_MapNameExtend
 * Copyright (c) 2024 Sakurano
 * This software is released under the MIT license.
 * http://opensource.org/licenses/mit-license.php
 * -------------------------------------------------
 * 2024/09/09 1.0.2 ツクールのシステム設定で、画面の幅・高さとUIエリアの幅・高さが
 *                  異なる設定をしている場合の位置を調整。
 * 2024/09/02 1.0.1 デフォルト値変更
 * 2024/09/02 1.0.0 公開
 * 2024/09/02 0.5.0 ほぼ形に
 * 2024/08/31 0.0.1 作成
 * -------------------------------------------------
 *
 *
 * シーンごとにキーとその説明を定義し、スイッチで表示/非表示を制御することが
 * できます。
 *
 * 同じシーン名に複数設定がある場合、それぞれが独立して表示されます。
 *
 * また、メッセージウィンドウ内で BTN[ボタン名]
 * を使用してボタンを描画する機能もついています。
 *
 * 利用方法:
 *
 * - キーボードガイドウィンドウを表示させるには、SceneKeysでシーンごとの設定を
 *   行い、指定したスイッチをONにしてください。
 *
 * - メッセージウィンドウ内で BTN[ボタン名] を使用すると、指定したボタンが描画
 *   されます。
 *
 * @param SceneKeys
 * @text シーン別キー設定
 * @type struct<SceneKeySetting>[]
 * @desc 各シーンにおけるキーとその説明を定義します。設定されたスイッチによって表示内容が変わります。
 * @default [”{”SceneName”:”Scene_Map”,”KeyDescriptions”:”[\”{\\\”KeyName\\\”:\\\”←\\\”,\\\”Description\\\”:\\\”\\\”,\\\”TriggerKey\\\”:\\\”ArrowLeft\\\”}\”,\”{\\\”KeyName\\\”:\\\”↑\\\”,\\\”Description\\\”:\\\”\\\”,\\\”TriggerKey\\\”:\\\”ArrowUp\\\”}\”,\”{\\\”KeyName\\\”:\\\”→\\\”,\\\”Description\\\”:\\\”\\\”,\\\”TriggerKey\\\”:\\\”ArrowRight\\\”}\”,\”{\\\”KeyName\\\”:\\\”↓\\\”,\\\”Description\\\”:\\\”移動\\\”,\\\”TriggerKey\\\”:\\\”ArrowDown\\\”}\”,\”{\\\”KeyName\\\”:\\\”Enter\\\”,\\\”Description\\\”:\\\”決定/アクション\\\”,\\\”TriggerKey\\\”:\\\”Enter\\\”}\”,\”{\\\”KeyName\\\”:\\\”Esc\\\”,\\\”Description\\\”:\\\”メニューを開く\\\”,\\\”TriggerKey\\\”:\\\”Escape\\\”}\”]”,”WindowPosition”:”left-bottom”,”WindowOffsetX”:”0”,”WindowOffsetY”:”0”,”ShowDimmer”:”true”,”GameSwitch”:””}”]
 *
 * @param GlobalHideSwitch
 * @text 全体非表示スイッチ
 * @type switch
 * @desc このスイッチがONの時、キーボードガイドウィンドウを非表示にします。
 * @default 0
 *
 * @param FontSize
 * @text フォントサイズ
 * @type number
 * @min 10
 * @max 40
 * @desc ボタンの文字のフォントサイズです。
 * @default 16
 *
 * @param ButtonTextColor
 * @text ボタンの文字の色
 * @type string
 * @desc ボタンの文字の色です。
 * @default #FFFFFF
 *
 * @param ButtonEdgeColor
 * @text ボタンの外枠の色
 * @type string
 * @desc ボタンの外枠の色です。
 * @default #808080
 *
 * @param ButtonInnerColor
 * @text ボタンの内側の色
 * @type string
 * @desc ボタンの内側の色です。
 * @default #333333
 *
 * @param ButtonHeight
 * @text ボタンの高さ
 * @type number
 * @min 0
 * @max 40
 * @desc ボタンの高さです。
 * @default 32
 *
 * @param ButtonPaddingX
 * @text ボタンのX軸内側余白
 * @type number
 * @min -40
 * @max 40
 * @desc ボタンのX軸内側余白です。
 * @default 8
 *
 * @param ButtonPaddingY
 * @text ボタンのY軸内側余白
 * @type number
 * @min -40
 * @max 40
 * @desc ボタンのY軸内側余白です。
 * @default 2
 *
 * @param ButtonMarginX
 * @text ボタンと説明の間の余白
 * @type number
 * @min -40
 * @max 40
 * @desc ボタンと説明の間の余白です。
 * @default 14
 *
 * @param ButtonOffsetYInWindowMessage
 * @text メッセージ内ボタンYオフセット
 * @type number
 * @min -40
 * @max 40
 * @desc メッセージウィンドウ内でボタンを描画する際のY軸のオフセット。正の値で下に、負の値で上に移動します。別プラグインでルビを振る際に高さを揃えるために調整してください。
 * @default 0
 *
 * @param ButtonNameOffsetYInWindowMessage
 * @text メッセージ内ボタンの中のテキストYオフセット
 * @type number
 * @min -40
 * @max 40
 * @desc ボタン内のテキストを描画する際のY軸のオフセット。正の値で下に、負の値で上に移動します。フォントによってうまく真ん中に収まらない場合に調整してください。
 * @default 0
 *
 */