アイテムボックスにサブコマンドを追加する – FTKR_ItemSubCommand.js

タイトル
アイテムボックスにサブコマンドを追加する
作者名
ヘルプ
-----------------------------------------------------------------------------
概要
-----------------------------------------------------------------------------
本プラグインを実装することで、アイテム選択後にサブコマンドを表示して
実行内容を選択できます。

サブコマンドには以下のコマンドがあります。
1. 使う   - アイテムを使用します。使用できない場合はグレー表示になります。
2. 捨てる  - アイテムを捨てます。「大事なもの」は捨てることが出来ません。
3. 装備する - そのアイテムが、武器や防具ならアクターに装備させます。
     アクター選択画面を表示して装備させる対象を選びます。
4. やめる  - サブコマンドを閉じます。
5. カスタム - プラグインパラメータで設定したコモンイベントを実行します。


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


-----------------------------------------------------------------------------
表示するサブコマンドの設定
-----------------------------------------------------------------------------
プラグインパラメータ<Command List>で、表示するコマンドを設定します。
表示させたいコマンドのコードを、カンマ(,)で区切って入力すると
入力した順番にコマンドを表示します。(すべて小文字)

<コマンド> <コード>
使う    use
捨てる   discard
装備する  equip
やめる   cancel
カスタム  custom  (は各カスタムコマンド番号)

例)
use,discard,custom0,cancel


-----------------------------------------------------------------------------
アイテムを捨てる
-----------------------------------------------------------------------------
サブコマンドの「捨てる」を実行すると、捨てるアイテムの数を設定します。
数を決めると確認画面を表示し、その画面で「実行する」を選択することで、
アイテムを捨てることができます。
捨てるときのSEはプラグインパラメータで設定できます。

確認画面は、プラグインパラメータ<Enable Confirmation>で非表示設定に
することができます。

以下のタグをアイテムのメモ欄に記載すると、そのアイテムは捨てることが
できません。

<捨てられない>
<NOT_DISCARDABLE>

また、タグの後ろに数字をつけると、そのIDのスイッチがONの間は
捨てることが出来なくなります。

<捨てられない: x>
<NOT_DISCARDABLE: x>
x : スイッチID


-----------------------------------------------------------------------------
アイテムを装備する
-----------------------------------------------------------------------------
サブコマンドの「装備する」を実行すると、選択したアイテムが武器や防具なら
アクターを選択して装備を変更することができます。

このサブコマンドは、武器、防具以外のアイテムのを選択した場合は
サブコマンドウィンドウ上に表示しません。

!注意!
装備先のスロットは、そのアイテムの装備タイプによって自動的に設定されます。
他のプラグインにより、同じ装備タイプを複数装備できるようにしていた場合に
正しく動作しない可能性があります。


-----------------------------------------------------------------------------
カスタムコマンド
-----------------------------------------------------------------------------
任意のコモンイベントを実行するカスタムコマンドを設定することができます。
設定したコマンドは、プラグインパラメータ<Command List>に追加してください。

コマンド名
プラグインパラメータ<CustomFormat>で設定します。

実行するコモンイベントID
プラグインパラメータ<CustomEventID>で設定します。
アイテム毎に実行するコモンイベントIDを設定することもできます。(1)
プラグインパラメータとアイテムの個別設定が両方ある場合は
アイテムの設定を優先します。

表示条件:サブコマンドウィンドウに表示するための条件
プラグインパラメータ<CustomShow Condition>と
アイテム毎の個別条件(1)を設定できます。
スクリプト形式の条件式を入力します(2)。
設定しない場合は、表示しません。
プラグインパラメータとアイテムの個別設定が両方ある場合は
両方の条件を満たした場合にのみ表示します。

有効条件:サブコマンドウィンドウを実行するための条件
プラグインパラメータ<CustomEnabled Condition>と
アイテム毎の個別条件(1)を設定できます。
スクリプト形式の条件式を入力します(2)。
設定しない場合は、実行できません。
プラグインパラメータとアイテムの個別設定が両方ある場合は
両方の条件を満たした場合にのみ実行できます。

(1)アイテム毎の個別条件の設定方法
以下のタグをメモ欄に記入することで、アイテム別にs設定できます。
<カスタムコマンド:x>
表示条件: 条件式
有効条件: 条件式
コモンイベントID: y
</カスタムコマンド>
x : カスタムコマンドの番号
y : 実行するコモンイベントID

(2)条件式の入力方法
ダメージ計算式のように、スクリプト形式の計算式を入力することで、
固定値以外の値を使用することができます。以下のコードを使用できます。
item - 使用するアイテムのデータを参照します。(item.id でアイテムID)
number - 使用するアイテムの所持数を参照します。
v[x] - 変数ID x の値を参照します。
s[x] - スイッチID x の値を参照します。
true - 常に有効になります。


-----------------------------------------------------------------------------
条件式に使用可能なスクリプト例
-----------------------------------------------------------------------------
1.アイテムの種別(アイテム、武器、防具)を判別する

DataManager.isWeapon(item) :選択したアイテムが、種別「武器」
DataManager.isArmor(item) :選択したアイテムが、種別「防具」
DataManager.isItem(item) :選択したアイテムが、種別「アイテム」


2.選択したアイテムの所持数を取得

$gameParty.numItems(item)


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

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


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


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

v1.7.3 - 2020/01/05 : 不具合修正
1. プラグインパラメータ「捨てるサウンド」の入力値を正しく読み取れず
アイテムを捨てる時にエラーになる不具合を修正。

v1.7.2 - 2019/12/25 : 標準パラメータ表示設定の仕様修正
v1.7.1 - 2019/12/25 : 機能追加
1. 装備変更用に表示するパラメータの対象や順番を変更する機能を追加。

v1.7.0 - 2019/12/22 : 機能追加
1. 装備コマンド実行時に、アクターのパラメータを表示するウィンドウを追加。

v1.6.0 - 2018/08/30 : 機能追加
1. アクターが1人の場合に、装備コマンドでアクター選択を不要にする機能を追加。

v1.5.2 - 2018/03/15 : 不具合修正
1. カスタムコマンド名が表示されない不具合を修正。

v1.5.1 - 2018/02/24 : 不具合修正
1. スクリプト入力時に三項演算子を使うと反映されない不具合を修正。

v1.5.0 - 2018/02/22 : 機能追加
1. アイテム画面から装備する機能を追加。

v1.4.1 - 2017/12/02 : 不具合修正
1. プラグインパラメータ「Disposal SE Name」の初期値の誤字を修正。

v1.4.0 - 2017/09/24 : 機能追加
1. アイテム別に実行するコモンイベントIDを設定する機能を追加。
2. サブコマンドウィンドウの高さをコマンドの数で自動調整する機能を追加。

v1.3.0 - 2017/09/19 : 機能追加
1. 任意のコモンイベントを実行するコマンドの追加機能を追加。

v1.2.1 - 2017/08/19 : 不具合修正
1. アイテム無所持でもサブコマンドウィンドウを表示できてしまう不具合修正

v1.2.0 - 2017/07/23 : 機能追加
1. アイテムに個別に捨てられるかどうか設定する機能を追加。
2. アイテムを捨てる時に任意のSEを鳴らす機能を追加。

v1.1.0 - 2017/06/11 : 機能追加
1. サブコマンドのウィンドウサイズと位置を調整する機能を追加。
2. 数値入力画面の最大数の表示内容を変更する機能を追加。

v1.0.0 - 2017/06/04 : 初版作成

-----------------------------------------------------------------------------
パラメータ
param --アイテム情報取得--
default
param Use Item Id
desc 選択したアイテムのIDを指定した変数に格納します。
default
type number

param --サブコマンド--
default
param Command List
desc 実行コマンドの表示する対象と順番を設定します。
default use,discard,cancel

param Command Position X
desc コマンドウィンドウの左上のX座標を指定します。
(デフォルト 0)(-1 で、画面右寄せ)
default 0

param Command Position Y
desc コマンドウィンドウの左上のY座標を指定します。
(デフォルト 180)(-1 で、画面下寄せ)
default 180

param Command Width
desc コマンドウィンドウの幅を指定します。
(デフォルト 240)(参考値:余白 = 18)(-1 で、画面右端まで)
default 240

param Command Height
desc コマンドウィンドウの高さを指定します。
(参考値:1行 = 36、余白 = 18)(-1 :画面下端まで、0 :自動調整)
default -1

param --アクター選択画面--
default
param Disable Select Single Actor
desc アクターが1人の時にアクター選択画面を表示しない。
default 0
type select
option 表示する
value 0
option 表示しない
value 1

param --使うコマンド--
default
param Command Use Format
desc 実行コマンドの「使う」のコマンド名を設定します。
default 使う

param --やめるコマンド--
default
param Command Cancel Format
desc 実行コマンドの「やめる」のコマンド名を設定します。
default やめる

param discard
text --捨てるコマンド--
default
param Command Discard Format
parent discard
desc 実行コマンドの「捨てる」のコマンド名を設定します。
default 捨てる

param --数値入力画面--
parent discard
default
param Max Number Format
parent discard
desc 数値入力ウィンドウで最大数を示す表示内容を設定します。
%1 - 手持ちのアイテム数
default /MAX %1

param Number Position X
parent discard
desc 数値入力ウィンドウの左上のX座標を指定します。
(デフォルト 0)(-1 で、画面右寄せ)
default 240

param Number Position Y
parent discard
desc 数値入力ウィンドウの左上のY座標を指定します。
(デフォルト 180)(-1 で、画面下寄せ)
default 180

param Number Width
parent discard
desc 数値入力ウィンドウの幅を指定します。
(デフォルト 456)(参考値:余白 = 18)(-1 で、画面右端まで)
default 456

param Number Height
parent discard
desc 数値入力ウィンドウの高さを指定します。
(参考値:1行 = 36、余白 = 18)(-1 で、画面下端まで)
default -1

param --確認画面--
parent discard
default
param Enable Confirmation
parent discard
desc アイテム廃棄実行時に確認画面を表示するか。
1 - 表示する, 0 - 表示しない
default 1
type select
option 表示する
value 1
option 表示しない
value 0

param Conf Title Format
parent discard
desc アイテム廃棄実行時の確認内容を設定します。
%1 - アイテム名, %2 - 捨てる数
default [%1]を[%2]個 捨てますか?

param Confirmation Ok Format
parent discard
desc 確認コマンドの「実行する」のコマンド名を設定します。
default 実行する

param Confirmation Cancel Format
parent discard
desc 確認コマンドの「実行しない」のコマンド名を設定します。
default 実行しない

param --捨てるサウンド--
parent discard
default
param Disposal SE Name
parent discard
desc アイテムを捨てる時のSEを設定します。
default Decision1
type file
require 1
dir audio/se

param Disposal SE Pitch
parent discard
desc アイテムを捨てる時のSEのピッチを設定します。
default 100
min 50
max 150
type number

param Disposal SE Volume
parent discard
desc アイテムを捨てる時のSEの音量を設定します。
default 90
min 0
max 100
type number

param equip
text --装備コマンド--
default
param Command Equip Format
parent equip
desc 実行コマンドの「装備する」のコマンド名を設定します。
default 装備する

param display_timing_equipstatus
parent equip
text ウィンドウ表示タイミング
desc ウィンドウを表示するタイミングを指定します。
default 1
type select
option 表示しない(表示機能を無効にする)
value 0
option 装備コマンド実行時に表示
value 1
option 装備アイテム選択時に表示
value 2

param Status_Window_Layout
parent equip
text パラメータレイアウト設定
desc 装備パラメータウィンドウのサイズや表示位置を設定します。
type struct<windowLayout>
default {"posiX":"0","posiY":"180","width":"240","height":"-1"}

param Select_Default_Param
parent equip
text 標準パラメータ表示設定
desc 標準仕様で表示させるパラメータを設定します。0:最大HP,1:最大MP,2~7:攻撃力~運,8:名前。カンマ(,)で区切ること。
default 8,2,3,4,5,6,7

param Enabled_Window_Param
parent equip
desc ウィンドウパラメータ変更機能を使うか。FTKR_CustomSimpleActorStatusが必要。
type boolean
on 有効
off 無効
default false

param Status_Window_Param
parent equip
text ウィンドウパラメータ設定
desc 装備パラメータウィンドウのサイズや表示位置を設定します。FTKR_CustomSimpleActorStatusが必要。
type struct<windowParam>
default

param Enabled_statusList
parent equip
desc 表示内容変更機能を使うか。FTKR_CustomSimpleActorStatusが必要。
type boolean
on 有効
off 無効
default false

param statusList
parent equip
text 装備パラメータ表示内容
desc 表示するステータスとその位置を設定します。FTKR_CustomSimpleActorStatusが必要。
type struct<status>[]
default

param Actor Status Space In Text
parent equip
desc Text内で複数表示する場合の間隔を指定します。
default 5
number
param --カスタムコマンド0--
default
param Custom0 Format
desc 実行コマンドの「カスタムコマンド0」のコマンド名を設定します。
default

param Custom0 EventID
desc カスタムコマンド0で実行するコモンイベントのIDを設定します。
default
type number

param Custom0 Show Condition
desc カスタムコマンド0を表示する条件を設定します。
default

param Custom0 Enabled Condition
desc カスタムコマンド0を実行する条件を設定します。
default

param --カスタムコマンド1--
default
param Custom1 Format
desc 実行コマンドの「カスタムコマンド1」のコマンド名を設定します。
default

param Custom1 EventID
desc カスタムコマンド1で実行するコモンイベントのIDを設定します。
default
type number

param Custom1 Show Condition
desc カスタムコマンド1を表示する条件を設定します。
default

param Custom1 Enabled Condition
desc カスタムコマンド1を実行する条件を設定します。
default

param --カスタムコマンド2--
default
param Custom2 Format
desc 実行コマンドの「カスタムコマンド2」のコマンド名を設定します。
default

param Custom2 EventID
desc カスタムコマンド2で実行するコモンイベントのIDを設定します。
default
type number

param Custom2 Show Condition
desc カスタムコマンド2を表示する条件を設定します。
default

param Custom2 Enabled Condition
desc カスタムコマンド2を実行する条件を設定します。
default

param --カスタムコマンド3--
default
param Custom3 Format
desc 実行コマンドの「カスタムコマンド3」のコマンド名を設定します。
default

param Custom3 EventID
desc カスタムコマンド3で実行するコモンイベントのIDを設定します。
default
type number

param Custom3 Show Condition
desc カスタムコマンド3を表示する条件を設定します。
default

param Custom3 Enabled Condition
desc カスタムコマンド3を実行する条件を設定します。
default

param --カスタムコマンド4--
default
param Custom4 Format
desc 実行コマンドの「カスタムコマンド4」のコマンド名を設定します。
default

param Custom4 EventID
desc カスタムコマンド4で実行するコモンイベントのIDを設定します。
default
type number

param Custom4 Show Condition
desc カスタムコマンド4を表示する条件を設定します。
default

param Custom4 Enabled Condition
desc カスタムコマンド4を実行する条件を設定します。
default

ライセンス表記
$gameParty.numItems(item)
本プラグインのライセンスについて(License)
本プラグインはMITライセンスのもとで公開しています。
This plugin is released under the MIT License.
Copyright (c) 2019 Futokoro
http://opensource.org/licenses/mit-license.php

紹介ページ https://github.com/futokoro/RPGMaker