イベントゲージプラグイン – MKR_EventGauge.js

タイトル
イベントゲージプラグイン
作者名
ヘルプ
= イベントゲージプラグイン =
MKR_EventGauge.js

指定したイベントの足元にゲージを表示します。(表示位置は調節が可能)
ゲージの最大値/残量はイベント生成(マップ移動)時に
イベント_メモ欄で指定した値(変数も使用可能)で設定されます。

(ゲージ最大値/残量に変数を使用した場合、)
ゲージ最大値/残量は変数の値に対応し、変数の値とゲージ残量が同期します。
(ただし、ゲージ残量は最大値より上になることは無く、
0より小さくなることもありません)

ゲージはイベントの透明化によって非表示になり、
透明化を解除すると再表示されます。

イベント画像が設定されていないイベント(ページ)の場合、ゲージは表示されません。
タイルセット画像を使ったイベントの場合、プラグインパラメータでゲージを表示させるか
設定することが可能です。
(タイルセットBの一番左上は[何もない]マス扱いとなりゲージが表示されません)

ただし、後述するプラグイン/スクリプトコマンドで
ゲージを非表示設定にした場合は透明化や画像設定の有無に関わらず、
プラグイン/スクリプトコマンドでゲージを表示設定にする必要があります。

イベントコマンド[イベントの一時消去]が実行されると、そのイベントに紐づく
ゲージも一緒に消去されます。


[コピペ用使用例、メモ欄設定・コマンド]
※各項目の意味は後述しています。
内容は1行毎になっていますので、
必要な行の使用例部分をコピーしてお使いください。

イベント_メモ欄:
<Egauge:vr10>
<Egauge:mvr11>
<Egauge:vr10 mvr11>
<Egauge:15>
<Egauge:3 Wh20 Ht6>
<Egauge:vr12 Wh100 Ht10 Fx3 Vs0>
<Egauge:5 Ys-50>
<Egauge:vr5 Xs10 Ys10 Fx1 Fc3 Sc11 Bc7>
<Egauge:50 op80>

プラグインコマンド(実行したイベントが持つゲージに対して効果を発揮):
Egauge show
Egauge hide
Egauge add 3
Egauge set 5
Egauge maxset 5
Egauge setx 20
Egauge sety 40
Egauge backcolor 16
Egauge color1 17
Egauge color2 17
Egauge add \V[10]
Egauge set \V[15]
Egauge maxset \V[20]
Egauge opacity 255

スクリプトコマンド(指定したIDのイベントが持つゲージに対して効果を発揮):
$gameMap.showGaugeWindow(1);
$gameMap.hideGaugeWindow(1);
$gameMap.isHideGaugeWindow(1);
$gameMap.addGaugeValue(1, 3);
$gameMap.addGaugeValue(this._eventId, 3);
$gameMap.setGaugeValue(1, 5);
$gameMap.setGaugeValue(this._eventId, 5);
$gameMap.setGaugeMaxValue(1, 5);
$gameMap.setGaugeOffsetX(1, 20);
$gameMap.setGaugeOffsetY(1, 40);
$gameMap.setGaugeBackColor(1, 16);
$gameMap.setGaugeColor1(1, 17);
$gameMap.setGaugeColor2(1, 17);
$gameMap.addGaugeValue(1, $gameVariables.value(10));
$gameMap.addGaugeValue(this._eventId, $gameVariables.value(10));
$gameMap.setGaugeValue(1, $gameVariables.value(15));
$gameMap.setGaugeMaxValue(1, $gameVariables.value(20));
$gameMap.setOpacity(1, 255);


ゲージの色について:
このプラグインでは、ゲージの色番号をプラグインパラメーターまたはメモ欄で
指定する必要があります。
(スクリプト/プラグインコマンドによって後からでも変更可能です)

色番号はsystem/Window.pngの右下側にある
色とりどりの四角い枠群に対応しています。

四角い枠群の左上(デフォルトだと白く塗られている四角い枠)を0番として
右に向かって数えていきます。一番右下が31です。

プラグインパラメーター
Gauge_Color_1
Gauge_Color_2
で指定されているデフォルト値である色番号20と21は、
メニュー等で表示されるHPゲージの色と同じものです。
(デフォルトだと赤みがかった黄色で塗られている四角い枠)

同じく、プラグインパラメーター
Gauge_Back_Color
で指定されているデフォルト値である色番号19は、
メニュー等で表示されるゲージの背景色と同じものです。
(デフォルトだと紺色で塗られている四角い枠)


イベント_メモ欄_基本設定:
<Egauge:vr[変数番号]>
・イベントにゲージを表示します。ゲージの残量は変数を使用します。
[変数番号]の部分に変数の番号を指定してください。

・ゲージ残量に使用する変数は0より大きい値を入れてください。

・ゲージ最大値の指定がされていない場合、
イベント生成時点の変数の値を最大値として設定します。
(設定後、変数の値はゲージ残量として機能します)

<Egauge:mvr[変数番号]>
・イベントにゲージを表示します。ゲージの最大値は変数を使用します。
[変数番号]の部分に変数の番号を指定してください。

・ゲージ最大値に使用する変数は0より大きい値を入れてください。

・ゲージ残量の指定がされていない場合、
イベント生成時点の変数の値を残量として設定します。
(設定後、変数の値はゲージ最大値として機能します)

<Egauge:vr[変数番号1] mvr[変数番号2]>
・イベントにゲージを表示します。ゲージの残量/最大値は変数を使用します。
[変数番号1],[変数番号2]の部分に変数の番号を指定してください。

・[変数番号1]がゲージ残量として使われる変数、
[変数番号2]がゲージ最大値として使われる変数になります。

・ゲージ残量/最大値に使用する変数は0より大きい値を入れてください。

・ゲージ残量に設定された変数の値が
ゲージ最大値に設定された変数の値より大きい場合、
自動的にゲージ最大値の値が残量として設定されます。

<Egauge:[数字]>
・イベントにゲージを表示します。[数字]がゲージの最大値・残量になります。
ゲージ残量の設定、最大値の設定は後述するコマンドでも可能です。
変数を利用したくない場合はこちらをご使用ください。

・ゲージ最大値に使用する[数字]は0より大きい値を入れてください。

※ ゲージの値指定に変数と数字を使う2パターンを用意しましたが、
両方指定した場合は変数設定が優先されます。

イベント毎に値指定方法を変えることは可能ですので、
どちらか片方を使い設定を行ってください。


メモ欄_オプション(各オプションはスペースで区切る):
Wh[数字]
・ゲージの長さを数字で指定します。

Ht[数字]
・ゲージの高さを数字で指定します。

Xs[数字]
・ゲージX座標を[数字]分、ズラして表示します。
(プラス値で右へ、マイナス値で左に)

Ys[数字]
・ゲージY座標を[数字]分、ズラして表示します。
(プラス値で下へ、マイナス値で上に)

Vs[0~1の数字]
・ゲージの初期表示状態を指定します。
0 : イベント生成時、ゲージは非表示設定です。
1 : イベント生成時、ゲージは表示設定です。

Fx[1~3の数字]
・ゲージを画面下側に固定表示します。
(デフォルト設定でゲージ底辺と画面との余白が20pxになります)

・ゲージのX座標は[1~3の数字]によって変わり、
1 : 画面左側とゲージ左辺の余白が20pxになるよう配置されます。
2 : ゲージの長さを考慮して画面中央に表示されます。
3 : 画面右側とゲージ右辺の余白が20pxになるよう配置されます。
ゲージオフセットによって余白の数値は変化します。

Fc[数字]
・ゲージカラー1を数字で指定します。
(プラグインパラメーターのGauge_Color_1設定より優先されます)

Sc[数字]
・ゲージカラー2を数字で指定します。

・ゲージのグラデーションが必要ない場合は
ゲージカラー1と同じ数字を指定します。
(プラグインパラメーターのGauge_Color_2設定より優先されます)

Bc[数字]
・ゲージ背景カラーを数字で指定します。
(プラグインパラメーターのGauge_Back_Color設定より優先されます)

Op[数字]
・ゲージ不透明度を数字で指定します。
(プラグインパラメーターのGauge_Opacity設定より優先されます)


イベント_メモ欄の設定例:
<Egauge:vr10>
・イベントにゲージを表示します。
ゲージの表示は最大値/残量ともに変数10番の値が反映されます。
(変数の変動によりゲージ残量が変化します)

<Egauge:mvr11>
・イベントにゲージを表示します。
ゲージの表示は最大値/残量ともに変数11番の値が反映されます。
(変数の変動によりゲージ最大値が変化します)

<Egauge:vr10 mvr11>
・イベントにゲージを表示します。
ゲージの表示は最大値が変数11番、残量が変数10番の値で反映されます。
(変数11番の変動によりゲージ最大値が、
変数10番の変動により残量が変化します)

<Egauge:15>
・イベントにゲージを表示します。
ゲージの表示は最大値15、残量15で設定されます。

<Egauge:3 Wh20 Ht6>
・イベントにゲージを表示します。
ゲージの表示は最大値3、残量3で設定されます。
・ゲージの長さを20px、高さを6pxで表示します。

<Egauge:vr20 Xs30 Ys-40>
・イベントにゲージを表示します。
ゲージの表示は最大値/残量ともに変数20番の値が反映されます。
(変数が変動するとゲージ残量が変化します)
・ゲージのX座標をデフォルト+30px、Y座標をデフォルト-40pxで表示します。

<Egauge:200 Wh300 Ht10 Xs-10 Ys-10 Fx1>
・画面下、左側固定でゲージを表示します。
ゲージの表示は最大値200、残量200で設定されます。
・ゲージの長さを300px、高さを10px、
X座標をデフォルト-10px、Y座標をデフォルト-10pxで表示します。

<Egauge:vr5 Xs10 Ys10 Fx1 Fc3 Sc11 Bc7>
・画面下、右側固定でゲージを表示します。
ゲージの表示は最大値/残量ともに変数5番の値が反映されます。
(変数が変動するとゲージ残量が変化します)
・ゲージの長さ、高さはデフォルト、
X座標をデフォルト+10px、Y座標をデフォルト+10pxで表示します。
・ゲージのカラー1を3番、カラー2を11番、ゲージ背景を7番の色で描画します。


プラグインコマンド: ※使用する際は、[]を実際の値に置き換えてください。
Egauge show
・実行したイベントのゲージを表示設定にします。

・イベントが透明、イベント画像が未設定のとき、コマンドを実行しても
ゲージは表示されません。

・ゲージが非表示設定になっている場合、
このコマンドで表示設定にすることが可能です。

・イベント_メモ欄にゲージ表示が設定されていない場合、何も変化しません。

Egauge hide
・実行したイベントのゲージを非表示設定にします。

・イベントが透明ではない、イベント画像が設定されているとき、
コマンドの実行によりゲージが非表示になります。

・イベント_メモ欄にゲージ表示が設定されていない場合、何も変化しません。

Egauge add [数字]
・実行したイベントのゲージ残量を指定した[数字]分、
増加/減少させます。([数字]がマイナス値だと減少します)

・[数字]の代わりに制御文字\V[n]を使うことで、変数n番の値を
増加/減少させることができます。

・変数によってゲージ残量が決められている場合、このコマンドによって
変数の値が変化します。

・ゲージ残量は最大値より多くなることはなく、
0より小さくなることもありません。

・イベント_メモ欄にゲージ表示が設定されていない場合、何も変化しません。

Egauge set [数字]
・実行したイベントのゲージ残量を指定した[数字]に設定します。
([数字]は0以上の値を指定してください。
また、ゲージ最大値より残量が多くなることはありません)

・[数字]の代わりに制御文字\V[n]を使うことで、変数n番の値を
ゲージ残量に設定することができます。

・変数によってゲージ残量が決められている場合、このコマンドによって
変数の値が変化します。

・イベント_メモ欄にゲージ表示が設定されていない場合、何も変化しません。

Egauge maxset [数字]
・実行したイベントのゲージ最大値を指定した[数字]に設定します。
([数字]は0より大きい値を指定してください)

・[数字]の代わりに制御文字\V[n]を使うことで、変数n番の値を
ゲージ最大値に設定することができます。

・ゲージ最大値がゲージ残量を下回る場合、このコマンドによって
ゲージ残量がゲージ最大値と同じになります。

・変数によってゲージ最大値/残量が決められている場合、このコマンドによって
変数の値が変化します。

・イベント_メモ欄にゲージ表示が設定されていない場合、何も変化しません。

Egauge setx [数字]
・実行したイベントのゲージX座標オフセットを指定した[数字]に設定します。
オフセットが指定されたゲージは指定された[数字]分、
本来の描画位置から横方向にズレて表示されます。

・[数字]の代わりに制御文字\V[n]を使うことで、変数n番の値を
ゲージオフセットに設定することができます。

Egauge sety [数字]
・実行したイベントのゲージY座標オフセットを指定した[数字]に設定します。
オフセットが指定されたゲージは指定された[数字]分、
本来の描画位置から縦方向にズレて表示されます。

・[数字]の代わりに制御文字\V[n]を使うことで、変数n番の値を
ゲージオフセットに設定することができます。

Egauge backcolor [数字]
・実行したイベントのゲージ背景色番号を指定した[数字]に設定します。

・[数字]の代わりに制御文字\V[n]を使うことで、変数n番の値を
ゲージ背景色番号に設定することができます。

Egauge color1 [数字]
・実行したイベントのゲージ表示色番号を指定した[数字]に設定します。

・[数字]の代わりに制御文字\V[n]を使うことで、変数n番の値を
ゲージ表示色番号に設定することができます。

Egauge color2 [数字]
・実行したイベントのゲージ表示色番号を指定した[数字]に設定します。
(ゲージのグラデーションが必要ない場合はcolor1と同じ数字を指定します)

・[数字]の代わりに制御文字\V[n]を使うことで、変数n番の値を
ゲージ表示色番号に設定することができます。

Egauge opacity [数字]
・実行したイベントのゲージ不透明度を指定した[数字]に設定します。
([数字]は0-255の間の値を指定してください)

・[数字]の代わりに制御文字\V[n]を使うことで、変数n番の値を
ゲージ不透明度に設定することができます。


スクリプトコマンド:
※使用する際は、[]を実際の値やスクリプトに置き換えてください。
$gameMap.showGaugeWindow([イベントID]);
・指定した[イベントID]のゲージを表示設定にします。

・[イベントID]をthis._eventIdにすることで、
コマンドを実行したイベントを対象にします。

・イベントが透明、イベント画像が未設定のとき、コマンドを実行しても
ゲージは表示されません。

・ゲージが非表示設定になっている場合、
このコマンドで表示設定にすることが可能です。

・イベント_メモ欄にゲージ表示が設定されていない場合、何も変化しません。

$gameMap.hideGaugeWindow([イベントID]);
・指定した[イベントID]のゲージを非表示設定にします。

・[イベントID]をthis._eventIdにすることで、
コマンドを実行したイベントを対象にします。

・イベントが透明ではない、イベント画像が設定されているとき、
コマンドの実行によりゲージが非表示になります。

・イベント_メモ欄にゲージ表示が設定されていない場合、何も変化しません。

$gameMap.isHideGaugeWindow([イベントID]);
・指定した[イベントID]のゲージが非表示設定であればtrue、
表示設定であればfalseを返します。

・[イベントID]をthis._eventIdにすることで、
コマンドを実行したイベントを対象にします。

・イベント_メモ欄にゲージ表示が設定されていない場合、falseが返ります。

$gameMap.addGaugeValue([イベントID], [数字]);
・指定した[イベントID]のゲージ残量を指定した[数字]分、
増加/減少させます。([数字]がマイナス値だと減少します)

・[イベントID]をthis._eventIdにすることで、
コマンドを実行したイベントを対象にします。

・[数字]の代わりにスクリプト$gameVariables.value(n)を使うことで、
変数n番の値を増加/減少させることができます。

・変数によってゲージ残量が決められている場合、このコマンドによって
変数の値が変化します。

・ゲージ残量は最大値より多くなることはなく、
0より小さくなることもありません。

・イベント_メモ欄にゲージ表示が設定されていない場合、何も変化しません。

$gameMap.setGaugeValue([イベントID], [数字]);
・指定した[イベントID]のゲージ残量を指定した[数字]に設定します。
([数字]は0以上の値を指定してください。
また、ゲージ最大値より残量が多くなることはありません)

・[イベントID]をthis._eventIdにすることで、
コマンドを実行したイベントを対象にします。

・[数字]の代わりにスクリプト$gameVariables.value(n)を使うことで、
変数n番の値をゲージ残量に設定することができます。

・変数によってゲージ残量が決められている場合、このコマンドによって
変数の値が変化します。

・イベント_メモ欄にゲージ表示が設定されていない場合、何も変化しません。

$gameMap.setGaugeMaxValue([イベントID], [数字]);
・指定した[イベントID]のゲージ最大値を指定した[数字]に設定します。
([数字]は0より大きい値を指定してください)

・[イベントID]をthis._eventIdにすることで、
コマンドを実行したイベントを対象にします。

・[数字]の代わりにスクリプト$gameVariables.value(n)を使うことで、
変数n番の値をゲージ最大値に設定することができます。

・ゲージ最大値がゲージ残量を下回る場合、このコマンドによって
ゲージ残量がゲージ最大値と同じになります。

・変数によってゲージ最大値/残量が決められている場合、このコマンドによって
変数の値が変化します

・イベント_メモ欄にゲージ表示が設定されていない場合、何も変化しません。

$gameMap.getGaugeValue([イベントID]);
・指定した[イベントID]のゲージ残量を返します。

・[イベントID]をthis._eventIdにすることで、
コマンドを実行したイベントを対象にします。

・変数によってゲージ残量が決められている場合、
返ってくる値は変数の値と同じです。

・イベント_メモ欄にゲージ表示が設定されていない場合、-1を返します。

$gameMap.getGaugeMaxValue([イベントID]);
・指定した[イベントID]のゲージ最大値を返します。

・[イベントID]を0にすることで、コマンドを実行したイベントを対象にします。

・イベント_メモ欄にゲージ表示が設定されていない場合、-1を返します。

$gameMap.setGaugeOffsetX([イベントID], [数字]);
・指定した[イベントID]のゲージX座標オフセットを
指定した[数字]に設定します。

・オフセットが指定されたゲージは指定された[数字]分、
本来の描画位置から横方向にズレて表示されます。

・[イベントID]をthis._eventIdにすることで、
コマンドを実行したイベントを対象にします。

・[数字]の代わりにスクリプト$gameVariables.value(n)を使うことで、
変数n番の値をゲージオフセットに設定することができます。

$gameMap.setGaugeOffsetY([イベントID], [数字]);
・指定した[イベントID]のゲージY座標オフセットを
指定した[数字]に設定します。

・オフセットが指定されたゲージは指定された[数字]分、
本来の描画位置から縦方向にズレて表示されます。

・[イベントID]をthis._eventIdにすることで、
コマンドを実行したイベントを対象にします。

・[数字]の代わりにスクリプト$gameVariables.value(n)を使うことで、
変数n番の値をゲージオフセットに設定することができます。

$gameMap.setGaugeBackColor([イベントID], [数字]);
・指定した[イベントID]のゲージ背景色番号を指定した[数字]に設定します。

・[イベントID]をthis._eventIdにすることで、
コマンドを実行したイベントを対象にします。

・[数字]の代わりにスクリプト$gameVariables.value(n)を使うことで、
変数n番の値をゲージ背景色番号に設定することができます。

$gameMap.setGaugeColor1([イベントID], [数字]);
・指定した[イベントID]のゲージ表示色番号を指定した[数字]に設定します。

・[イベントID]をthis._eventIdにすることで、
コマンドを実行したイベントを対象にします。

・[数字]の代わりにスクリプト$gameVariables.value(n)を使うことで、
変数n番の値をゲージ表示色番号に設定することができます。

$gameMap.setGaugeColor2([イベントID], [数字]);
・指定した[イベントID]のゲージ表示色番号を指定した[数字]に設定します。

・ゲージのグラデーションが必要ない場合は
ゲージカラー1と同じ数字を指定します。

・[イベントID]をthis._eventIdにすることで、
コマンドを実行したイベントを対象にします。

・[数字]の代わりにスクリプト$gameVariables.value(n)を使うことで、
変数n番の値をゲージ表示色番号に設定することができます。

$gameMap.setGaugeOpacity([イベントID], [数字]);
・指定した[イベントID]のゲージ不透明度を指定した[数字]に設定します。
([数字]は0-255の間の値を指定してください)

・[イベントID]をthis._eventIdにすることで、
コマンドを実行したイベントを対象にします。

・[数字]の代わりにスクリプト$gameVariables.value(n)を使うことで、
変数n番の値をゲージ不透明度に設定することができます。


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

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


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

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

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

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


パラメータ
param Gauge_Width
desc [初期値] ゲージの長さを数値で指定してください。(デフォルト:40)
default 40

param Gauge_Height
desc [初期値] ゲージの高さを数値で指定してください。(デフォルト:40)
default 10

param Gauge_Offset_X
desc [初期値] ゲージX座標をズラして表示する場合は指定してください。(プラス値で右へ、マイナス値で左に)(デフォルト:0)
default 0

param Gauge_Offset_Y
desc [初期値] ゲージY座標をズラして表示する場合は指定してください。(プラス値で下へ、マイナス値で上に)(デフォルト:0)
default 0

param Gauge_Visible
desc [初期値] 初めからゲージを表示しておく場合はON、後から表示させる場合はOFFを指定してください。(デフォルト:ON)
default ON

param Gauge_Color_1
desc [初期値] ゲージの表示色番号を指定してください。(実際に表示される色はsystem/Window.pngを参照してください)(デフォルト:20)
default 20

param Gauge_Color_2
desc [初期値] ゲージの表示色番号を指定してください。(この項目はグラデーション用です)(デフォルト:21)
default 21

param Gauge_Back_Color
desc ゲージ背景の表示色番号を指定してください。(ゲージ全体が背景色で塗られ、残量分がゲージ表示色で塗られます)(デフォルト:19)
default 19

param Gauge_Opacity
desc [初期値] ゲージの不透明度(0~255)を指定してください。(0でゲージが透明になります)(デフォルト:255)
default 255

param Gauge_In_Picture
desc 指定した番号のピクチャーよりゲージを上に表示します。(0の場合、ゲージは全ピクチャーの下に表示)(デフォルト:0)
default 0

param Tile_Gauge_Enable
desc タイルセットイベントに対してゲージを表示させるか選択します。(デフォルト:表示させない)
type boolean
on 表示させる
off 表示させない
default false

ライセンス表記
・作者に無断で本プラグインの改変、再配布が可能です。
(ただしヘッダーの著作権表示部分は残してください。)
・利用形態(フリーゲーム、商用ゲーム、R-18作品等)に制限はありません。
・本プラグインを使用したことにより発生した問題について作者は一切の責任を
Copyright (c) 2016 マンカインド
This software is released under the MIT License.
http://opensource.org/licenses/mit-license.php

紹介ページ https://github.com/mankindGames/RPGTkool/blob/master/MKR_EventGauge.js