コマンドに枠を付けるプラグイン – FTKR_DisplayCommandFrame.js

-----------------------------------------------------------------------------
概要
-----------------------------------------------------------------------------
本プラグインを実装することで、メニュー等のコマンド(1)やリスト(2)に
枠を付けることができます。

枠は、単線や複線、画像などから選ぶことが出来ます。
また、どのタイミングで枠を付けるかも選ぶことが出来ます。

(1)本プラグインにおけるコマンドとは、Window_Commandオブジェクトを使って
生成しているウィンドウのコマンドを指します。
MV標準では、以下のウィンドウが相当します。
1.タイトルコマンド
2.メニュー
3.アイテム選択後のアイテムタイプリスト
4.装備選択後の装備変更、最強装備、等のリスト
5.スキル選択後のスキルタイプリスト
6.オプション
7.ショップメニュー
8.選択肢コマンド
9.戦闘コマンド
10.ゲームエンドコマンド
それぞれに対して、プラグインパラメータで個別に機能のON/OFFを設定可能。


(2)本プラグインにおけるリストとは、以下のウィンドウが相当します。
1.メニュー画面のスキルリスト
2.バトル画面のスキルリスト
それぞれに対して、プラグインパラメータで個別に機能のON/OFFを設定可能。


-----------------------------------------------------------------------------
設定方法
-----------------------------------------------------------------------------
1.「プラグインマネージャー(プラグイン管理)」に、本プラグインを追加して
ください。

2. FTKR_ExBattleCommand.jsと組み合わせる場合は、本プラグインが下になるように
配置してください。

FTKR_ExBattleCommand.js
FTKR_DisplayCommandFrame.js


-----------------------------------------------------------------------------
基本設定
-----------------------------------------------------------------------------
枠のタイプや表示タイミングなどの基本設定は、以下のプラグインパラメータで
変更できます。

<Display Frame Type>
:表示する枠のタイプを設定します
:0 - 非表示, 1 - 単線, 2 - 複線, 3 - 画像
:4 - 単線 + 画像, 5 - 複線 + 画像
:6 - 単線 + 塗潰し, 7 - 複線 + 塗潰し

<When To Display Frame>
:枠を表示するタイミングを設定します
:0 - 常時, 1 - カーソルと重なる時, 2 - カーソルと重ならない時

<Change Frame On Cursor>
:カーソルと重なった時に枠を変更する機能を設定します
:0 - 無効, 1 - 有効

<Hide Cursor>
:カーソルを非表示にする機能を設定します
:0 - 無効, 1 - 有効


-----------------------------------------------------------------------------
単線、複線の設定
-----------------------------------------------------------------------------
枠のタイプを単線または複線にした場合の表示設定は、
以下のプラグインパラメータで変更できます。

<Default Line Color>
:標準で枠線に使用する色番号

<Line Color On Cursor>
:カーソルと重なった時に使用する色番号

<Line Thick>
:枠線の太さ

<Sub Line Color>
:複線時に使用する枠線の色番号
:複線専用の線色は、カーソルと重なっても変わりません

<Sub Line Thick>
:複線時に使用する枠線の太さ


-----------------------------------------------------------------------------
枠内塗潰しの設定
-----------------------------------------------------------------------------
枠のタイプを枠内塗潰し有にした場合の表示設定は、
以下のプラグインパラメータで変更できます。

<Default Fill Color>
:標準で枠内塗潰しに使用する色番号

<Fill Color On Cursor>
:カーソルと重なった時に使用する色番号

<Fill Color Opacity>
:枠内塗潰し色の透明度


-----------------------------------------------------------------------------
画像の設定
-----------------------------------------------------------------------------
枠のタイプを画像にした場合のや表示設定は、以下のプラグインパラメータで
変更できます。

<Image Name>
:使用する画像名を設定します。
:画像は、プロジェクトフォルダ内の/img/system/に保存してください。(1)

<Image Width>
:枠画像の幅を設定します。(1)

<Image Height>
:枠画像の高さを設定します。(1)

<Enabled Change Scale>
:枠画像とカーソルサイズが異なる時の自動サイズ調整機能(2)を設定します。
:0 - 無効, 1 - 有効

<Image Offset X>
:カーソル枠に対して枠画像の表示位置をX方向にずらしたい場合に設定します。
:単位はpixelで、正の値の場合に画面右側にずれます。

<Image Offset Y>
:カーソル枠に対して枠画像の表示位置をY方向にずらしたい場合に設定します。
:単位はpixelで、正の値の場合に画面下側にずれます。

<Image Offset Width>
:カーソル枠の幅に対して枠画像の幅を変える場合に設定します。(3)
:単位はpixelで、正の値の場合に幅が大きくなります。

<Image Offset Height>
:カーソル枠の高さに対して枠画像の高さを変える場合に設定します。(3)
:単位はpixelで、正の値の場合に高さが大きくなります。

<Default Image Index>
:標準で表示する画像の番号を設定します。(4)

<Image Index On Cursor>
:カーソルと重なった時に表示する画像の番号を設定します。(4)


(1)複数の枠画像を使用する場合は、画像ファイル内に複数の枠画像を
並べてください。横に並べる数は4つまでです。
このとき、それぞれの枠画像のサイズは同じにしてください。
そのサイズを、<Flame Image Width><Flame Image Height>に
設定してください。
(2)自動サイズ調整機能は、枠画像の四隅66の部分を固定として、
それ以外の部分を拡大縮小するものです。そのため、本機能を
有効にするためには、枠画像は最低でも1313のサイズが必要です。
(3)自動サイズ調整機能を有効にする必要があります。
(4)画像ファイル内に並べた枠画像の内、左上にある画像が0番になります。
そこから右に1番、2番、...と数えます。


-----------------------------------------------------------------------------
本プラグインのライセンスについて(License)
-----------------------------------------------------------------------------
本プラグインはMITライセンスのもとで公開しています。
This plugin is released under the MIT License.

Copyright (c) 2017 Futokoro
http://opensource.org/licenses/mit-license.php


プラグイン公開元
https://github.com/futokoro/RPGMaker/blob/master/README.md

-----------------------------------------------------------------------------
変更来歴
-----------------------------------------------------------------------------

v1.2.2 - 2020/05/17 : 不具合修正
1. 枠画像が初回時に表示されないことがある不具合を修正。(by emptybraces氏)

v1.2.1 - 2017/11/24 : 不具合修正
1. FTKR_ExBattleCommand.jsとの競合回避。

v1.2.0 - 2017/11/20 : 機能追加
1. スキルリストに枠を表示する機能を追加。
2. プラグインパラメータの入力方式を見直し。

v1.1.1 - 2017/04/21 : 枠画像ディプロイメント対応

v1.1.0 - 2017/03/31 : 仕様変更
1. 枠線の表示仕様を変更。
2. 枠内塗りつぶしに透明度の設定を追加。

v1.0.5 - 2017/03/15 : 機能追加
1. 枠内を指定の色で塗潰す機能を追加。

v1.0.4 - 2017/03/10 : 機能追加
1. 枠の表示タイプに、枠線と枠画像を両方表示する項目を追加。

v1.0.3 - 2017/03/09 : 機能追加
1. コマンド毎に有効無効にできる機能を追加。
2. 選択肢コマンドにも枠が付けられるように修正。

v1.0.2 - 2017/03/09 : 機能追加
1. 枠画像のサイズ調整機能を追加。

v1.0.1 - 2017/03/08 : 不具合修正、一部処理を見直し
1. FTKR.DCF.frame.image.offsetXとFTKR.DCF.frame.image.offsetYの
プラグインパラメータに対する記述ミスを修正。
2. 単線タイプの枠線の太さに対して、プラグインパラメータ<Line Thick>の値が
適用されていない不具合を修正。
3. 一部処理を見直し。

v1.0.0 - 2017/03/08 : 初版作成

-----------------------------------------------------------------------------