マップアイテムスロットプラグイン – MKR_MapItemSlot.js

= マップアイテムスロットプラグイン =
MKR_MapItemSlot.js

マップ画面上に表示したアイテムスロットからアイテムの使用/装備を
することができるようになります。

アイテムスロットの選択は
・キーボードの1～9,0キー(デフォルト設定)
・ゲーム画面上でマウスホイール操作
・画面上のアイテムアイコン部分をクリック(デフォルト無効)
・キーボードの左右キー(デフォルト無効)
で可能です。

スロット数を10としたとき、スロット番号は以下のようになります。
(デフォルトでキーボードの数字キーに対応しています。
0キーはスロット番号10として扱います)
アイテムスロット:[1] [2] [3] [4] [5] [6] [7] [8] [9] [10]
キーボードキー : 1 2 3 4 5 6 7 8 9 0

プラグインパラメータ[方向キー選択モード]を有効にすることにより、
キーボードの左右キーでアイテムスロットの選択が行なえます。
(左矢印キーで左スロット選択、右矢印キーで右スロット選択)

このモードを有効にする場合は、プラグインパラメータ[スロット○選択キー]は
"なし"(null)に設定変更することをオススメします。


選択したスロットにアイテム(道具/スキル)が登録されていた場合、
画面上をマウスで左クリック、または指定したキーを押すことで
選択されたアイテムを使用することができます。
(範囲が[味方単体]、[使用者]の場合は先頭のアクターに使用。
[味方全体]の場合はパーティ全体に効果を発揮します)

アイテムの使用をマウス(タッチ)、またはキーボード、どちらの方法で
行うかは選択可能です。

なお、アイテム使用方法にマウスクリック(画面タッチ)を選択した場合、
プラグインパラメータでクリック(タッチ)範囲をゲーム画面全体か、
スロット上に限定するかを設定することができます。
(デフォルトは画面全体)

クリック(タッチ)範囲をゲーム画面全体にした場合、
マップ上を移動するためにクリック(タッチ)操作を
使うことはできなくなります。

クリック(タッチ)範囲をアイテムスロット部分にした場合、
アイテムを使用するためには画面上のアイテムスロット部分を
左クリックする必要があります。
(アイテムスロット以外をクリックした場合、
マップ上のプレイヤーキャラが移動します)


同じアイテムを複数個所持している場合、
その個数がスロット右下に数字として表示されます。
(プラグインパラメータで非表示に設定可能)
(プラグインパラメータ「アイテム個数の制限」が有効な場合は登録個数)

アイテム個数が0になったとき、
アイテムスロットからそのアイテムを削除するか、
グレーアウトさせた状態で残しておくかはプラグインパラメータから設定可能です。


選択したスロットに装備が登録されていた場合、
装備可能なものであれば選択と同時にパーティ先頭のアクターに装備されます。
なお、選択カーソルが装備の登録されたスロットから外れると
アクターの装備も外れます。

装備中アイテム(=カーソルが装備の登録されているスロット上にある)の場合、
スロット左上に E と表示されます。

プラグインパラメータ[武器登録可否]がONのとき、
メニューの装備画面から先頭アクターの武器変更をすることができなくなります。
(アイテムスロットの選択によって武器の変更を行ってください)

プラグインパラメータ[防具登録可否]がONのとき、
メニューの装備画面から先頭アクターの防具変更をすることができなくなります。
(アイテムスロットの選択によって防具の変更を行ってください)


アイテムスロットは先頭から、
既に所持しているアイテム、または入手したアイテムが自動的に
登録されていきます。
(スロットが空いている場合のみ。ゲーム開始時にアイテムを装備済みの場合は
そのアイテムがスロットの先頭に登録されます)
プラグインパラメータ:[アイテム自動使用機能]をOFFにすることで
この機能を無効にすることができます。

メニュー画面の項目[アイテムスロット]からスロットに
登録するアイテムを変更可能です。

[登録]はアイテムスロットにアイテムを登録します。
マップ画面で選択されているスロットに
装備アイテムを登録した場合は自動的に装備されます。

プラグインパラメータ「アイテム個数の制限」が有効なとき、
アイテムスロットに登録するアイテムの個数を設定できます。
(武器/防具/スキルは対象外)

[削除]は選択したスロットを空にします。
装備していたアイテムをアイテムスロットから削除した場合、
アクターからその装備が外れます。

[戻る]はメニュー画面に戻ります。
(プラグインパラメータ「画面戻るコマンド名」設定時のみ表示)


アイテムスロット画面のカテゴリ表示について:
プラグインパラメータ[カテゴリー表示]にて、
アイテムスロットメニュー画面上に表示されるカテゴリウィンドウの扱いを
変更することができます。
(アイテムカテゴリウィンドウは、アイテムと武器、といった
2種類以上のアイテムをアイテムスロットへ登録する設定となっているときに
表示されます)

・カテゴリを表示する
カテゴリウィンドウからアイテムのカテゴリを選択することで、
選択したカテゴリに沿ったアイテムがアイテムリストに表示されます。
デフォルトの設定です。

・カテゴリを表示しない
カテゴリウィンドウを非表示にして、アイテムリスト上でアイテムを
カテゴリごとに分類し表示します。
並び順はプラグインパラメータ[アイテムリストソート設定]から
設定することができます。


プラグインパラメータによる動作について:
アイテムスロットに対する操作はプラグインパラメータにより変更できます。

・マウス使用モード.アイテム使用(Mouse_Mode.Use_Enable)
マウスクリック(画面タッチ)でアイテムの使用が可能になります。

・マウス使用モード.スロット選択(Mouse_Mode.Select_Enable)
マウスホイールでスロットの選択が可能になります。

・マウス使用モード.アイテム使用方法(Mouse_Mode.Use_Enable)
アイテム使用のためのクリック範囲を画面全体とするか、
アイテムスロット部分に限定するかを設定できます。
(タッチ操作でのゲームプレイを想定)

・マウス使用モード.機能無効スイッチ(Mouse_Mode.Function_Disable)
スイッチがONの間、マウスによるスロット操作を無効にします。

・キーボード使用モード.アイテム使用(Keyboard_Mode.Use_Enable)
キーボードでアイテムの使用が可能になります。

・キーボード使用モード.スロット選択(Keyboard_Mode.Select_Enable)
キーボードでスロットの選択が可能になります。

・キーボード使用モード.機能無効スイッチ(Keyboard_Mode.Function_Disable)
スイッチがONの間、キーボードによるスロット操作を無効にします。

・イベント実行中の動作.スロットの表示(Event_Mode.Slot_Enable)
イベント実行中、スロットの表示/非表示を設定できます。

・イベント実行中の動作.アイテム使用(Event_Mode.Use_Enable)
イベント実行中、スロットアイテムの使用可/不可を設定できます。

・イベント実行中の動作.スロット選択(Event_Mode.Select_Enable)
イベント実行中、スロット選択の可/不可を設定できます。

以下のプラグインパラメータによりアイテムスロットの挙動が変化します。

・アイテム登録モード(Slot_Add_Mode)
ONの場合、入手したアイテムは自動的にスロットへと登録されます。
自動で登録させたくない場合はOFFにするか、後述するメモ欄の設定を
行ってください。

・アイテム使用モード(Item_Use_Mode)
ONの場合、アイテムが登録されたスロットにカーソルが移動すると、
自動的にそのアイテムが使用されます。
スマートフォンなど、タッチ操作でのゲームプレイが前提の場合は
ONにすることを推奨します。

・武器登録可否(Slot_Set_Weapon)
ONの場合、スロットに武器が登録可能になります。
また、装備画面から武器の変更が行えなくなります。
アイテムのみ登録させたい、武器は自由に変更したい場合は
OFFにしてください。

・防具登録可否(Slot_Set_Armor)
ONの場合、スロットに防具が登録可能になります。
また、装備画面から防具の変更が行えなくなります。
アイテムのみ登録させたい、防具は自由に変更したい場合は
OFFにしてください。

・スキル登録可否(Slot_Set_Skill)
ONの場合、スロットにスキルが登録可能になります。
登録できるスキルは回復系のものに限られます。

・アイテム消去モード(Item_Remove_Mode)
ONの場合、スロットにセットされたアイテムの個数が0個になると
スロットからアイテムが自動的に削除されます。
OFFにすると、アイテムは個数0の状態でグレー表示になります。
アイテム個数が0のため、使用することはできません。

・スロット不透明度調整
イベント実行中にスロットがフェードアウト
イベント終了後にスロットがフェードイン
等するときに、1フレーム中に操作するスロットの不透明度を指定します。
ここで指定した数値分、
不透明度を減らしながらフェードアウト
不透明度を増やしながらフェードイン
するようになります。

・アイテム個数の制限(Item_Count_Save)
アイテムスロットにアイテムを手動登録するとき
登録するアイテムの個数を設定することができます。
マップ画面のアイテムスロットには設定した個数が表示され、
設定個数より多くのアイテムを使うことができなくなります。
再び使いたい場合は手動登録をもう1度行ってください。
(アイテム登録モードがOFFの場合のみ機能します。)

・透明スロット使用モード(Use_Transparent_Slot)
スロットの不透明度が0のときに
スロットの操作を行えるようになります。

・ワンスロットモード(One_Slot)
マップ上のスロット表示数を1つのみにします。
キー、マウスホイールなどによるスロット選択を行うと
1つしかないスロット上で登録されたアイテムが切り替わり表示されます。
なお、本モードはタッチ操作によるスロット選択に対応しません。

・スロット選択モード(Slot_Select)
マップ上のスロットを選択するとき、
アイテムが設定されているスロットのみ選択対象にします。


スロットサイズ倍率について:
プラグインパラメータ[スロットサイズ倍率]からスロットの大きさを
変更することができます。(1.0倍～2.0倍まで)

サイズ倍率と最大スロット数によってはスロットが画面外へと
飛び出してしまう可能性があります。
(例えばスロット10個でサイズを2.0倍にすると、
デフォルトのゲーム画面の横サイズである816pxより大きくなってしまいます)

自動的にゲーム画面内に収まるよう超過サイズを調整する機能はありませんので、
ゲーム画面内に収まるよう設定の考慮をお願いします。


武器・アイテム・スキルメモ欄:
<itemslot:noadd>
・このメモを設定された武器、アイテム、スキルはアイテムスロットへの登録が
できなくなります。


プラグインコマンド:
itemslot hide
・アイテムスロットを非表示にします。

itemslot show
・アイテムスロットを表示します。パラメータ:Slot_Visibleが
OFFの場合、このコマンドを使い任意のタイミングでアイテムスロットを
表示させる必要があります。

itemslot set [スロット番号] [アイテムタイプ] [アイテムID] [装備フラグ]
・指定したアイテムスロットに指定したアイテムを登録します。

・[スロット番号]は1～スロット最大数までの番号を指定します。
自動的に空きスロットを探してアイテムを登録したい場合は 0 を
指定します。(空きスロットが存在しない場合は登録されません)

・[アイテムタイプ]は登録したいアイテムの種類を指定します。
(item / weapon / armor のいずれか)
データベース【アイテム】のアイテムを登録したい場合は item を、
データベース【武器】のアイテムを登録したい場合は weapon を
データベース【防具】のアイテムを登録したい場合は armor を
データベース【スキル】のアイテムを登録したい場合は skill を
指定してください。

・[アイテムID]はアイテムのIDを指定します。
例えば、初期登録されている【ポーション】はID:1となります。
初期登録されている【弓】はID:4となります。

・[装備フラグ]は、登録した武器を
すぐに装備(カーソル選択)させる場合に true を指定します。
アイテムを登録する場合は true を設定しても意味はありません。

itemslot remove [スロット番号]
・指定した[スロット番号]のスロットに登録されているアイテムを
スロットから削除します。

・[スロット番号]は1～スロット最大数までの番号を指定します。

・スロットからは削除されますが、
所持アイテムを失うわけではありません。

・装備中の武器をスロットから削除した場合、
アクターから装備が外れますのでご注意ください、

itemslot clear
・アイテムスロットに登録されているアイテムを全て削除します。

itemslot menu [方式番号]
・メニュー項目[アイテムスロット]の表示方式を変更します。
番号と方式の対応は以下のとおりです。
(パーティに誰も居ない場合、項目はメニューに表示されますが
選択不能状態となります)
0 : メニューに追加しない
1 : メニューに追加し選択有効状態
2 : メニューに追加するが選択不能状態

itemslot use [スロット番号]
・指定したスロットに登録されているアイテム、スキルを使用します。

・[スロット番号]は1～スロット最大数までの番号を指定します。

・指定したスロットに装備品、
または使用条件を満たさないアイテム、スキルが
登録されている場合は使用することができません。

itemslot select [スロット番号 / left / right]
・アイテムスロットの選択カーソルを移動します。

・スロット番号を数値で指定した場合、カーソルは指定した番号の
スロットへと移動します。

・leftを指定した場合、カーソルは一つ左に移動します。
カーソルがスロット先頭を選択していた場合は末端に移動します。

・rightを指定した場合、カーソルは一つ右に移動します。
カーソルがスロット末端を選択していた場合は先頭に移動します。

itemslot edit
・アイテムスロット編集画面を開きます。


スクリプトコマンド:
$gameParty.getItemSlotFreeNumber();
・アイテムが登録されていない(=空いている)スロット番号を返します。
空いているスロットが存在しない場合は-1を返します。
[例]
～変数1番に空きスロット番号を代入する～
◆変数の操作：#0001 空きスロット = $gameParty.getItemSlotFreeNumber();

$gameParty.isItemSlotItem([スロット番号], [アイテムID]);
・指定したスロット番号(1～)に登録されたアイテムが、
指定したアイテムID(1～)である場合にtrueを返します。
[例]
◆条件分岐：スクリプト：$gameParty.isItemSlotItem(1, 10);
～スロット1番にID10のアイテムが
登録されているときの処理～
：分岐終了

$gameParty.isItemSlotWeapon([スロット番号], [武器ID]);
・指定したスロット番号(1～)に登録された武器が、
指定した武器ID(1～)である場合にtrueを返します。
[例]
◆条件分岐：スクリプト：$gameParty.isItemSlotWeapon(2, 7);
～スロット2番にID7の武器が
登録されているときの処理～
：分岐終了

$gameParty.isItemSlotArmor([スロット番号], [防具ID]);
・指定したスロット番号(1～)に登録された防具が、
指定した防具ID(1～)である場合にtrueを返します。
[例]
◆条件分岐：スクリプト：$gameParty.isItemSlotArmor(3, 23);
～スロット3番にID23の防具が
登録されているときの処理～
：分岐終了

$gameParty.isItemSlotSkill([スロット番号], [スキルID]);
・指定したスロット番号(1～)に登録されたスキルが、
指定したスキルID(1～)である場合にtrueを返します。
[例]
◆条件分岐：スクリプト：$gameParty.isItemSlotSkill(4, 7);
～スロット4番にID7のスキルが
登録されているときの処理～
：分岐終了

$gameParty.getItemSlotLastIndex();
・現在選択されているスロットインデックスを取得します。
(インデックス = スロット番号を-1した値)
[例]
◆条件分岐：スクリプト：$gameParty.getItemSlotLastIndex() == 0
～スロット1番が選択されているときの処理～
：分岐終了
◆条件分岐：スクリプト：$gameParty.getItemSlotLastIndex() == 1
～スロット2番が選択されているときの処理～
：分岐終了

$gameParty.getItemSlotId([スロット番号]);
・指定したスロット番号(1～)に登録された
アイテム(武器/防具/スキルを含む)のIDを取得します。

$gameParty.getItemSlotType([スロット番号]);
・指定したスロット番号(1～)に登録された
アイテム(武器/防具/スキルを含む)の種類文字列を返します。
返ってくる文字列は以下のいずれかです。
値 : 意味
"item" セットされているのはアイテムです
"weapon" セットされているのは武器です
"armor" セットされているのは防具です
"skill" セットされているのはスキルです
null (空文字) 何もセットされていない。またはスロット番号が不正です

$gameParty.getItemSlotCount([スロット番号]);
・指定したスロット番号(1～)に登録された
アイテムのスロット上の個数を取得します。

$gameParty.openItemSlotMenu();
・アイテムスロットメニューを開きます。


補足：
・このプラグインに関するメモ欄の設定、プラグインコマンド/パラメーター、
制御文字は大文字/小文字を区別していません。

・プラグインパラメーターの説明に、[初期値]と書かれているものは
プラグインコマンドで個別に設定変更が可能です。
変更した場合、[初期値]より変更後の設定が
優先されますのでご注意ください。

・プラグインパラメータの説明に、[制御文字可]と書かれているものは
設定値に制御文字を使用可能です。
(例えば、変数を表示する\v[n]や、文章の改行を行う\nなどです)

・変数を設定した場合、そのパラメータの利用時に変数の値を
参照するため、パラメータの設定をゲーム中に変更できます。


利用規約:
・作者に無断で本プラグインの改変、再配布が可能です。
(ただしヘッダーの著作権表示部分は残してください。)

・利用形態(フリーゲーム、商用ゲーム、R-18作品等)に制限はありません。
ご自由にお使いください。

・本プラグインを使用したことにより発生した問題について作者は一切の責任を
負いません。

・要望などがある場合、本プラグインのバージョンアップを行う
可能性がありますが、
バージョンアップにより本プラグインの仕様が変更される可能性があります。
ご了承ください。

==============================================================================