制御文字拡張プラグイン – MKR_ControlCharacterEx.js

タイトル
制御文字拡張プラグイン
作者名
ヘルプ
= 制御文字拡張プラグイン =
MKR_ControlCharacterEx.js

メッセージ内で利用可能な制御文字を追加/拡張します。


新規追加した制御文字:
\IM[アイコン右余白]
・この制御文字の後から表示されるアイコンの右余白をpx単位で設定します。

余白は数値で指定、または制御文字の\v[n]を利用可能です。

なお、ここでの余白設定は
プラグインパラメータで指定できる初期値よりも優先されます。

余白設定はメッセージウィンドウが開かれている間、持続します。
1度ウィンドウが閉じられると、余白はプラグインパラメーターの設定に
戻ります。

\SE[SE名,SE音量,SEピッチ,SE位相]
・メッセージ表示中にSEを演奏します。
SE名は必須です。
audio/se/配下にあるSEファイル名(拡張子は除く)を指定してください。

音量、ピッチ、位相は数値で指定、または
制御文字の\v[n]を利用可能です。

なお、ここでの音量、ピッチ、位相設定は
プラグインパラメータで指定できる初期値よりも優先されます。

音量、ピッチ、位相を初期値のまま使用する場合は、
SE名のみ指定してください。
(音量のみを指定して、残りを初期設定値で再生させることも可能です)

\ME[ME名,ME音量,MEピッチ,ME位相]
・メッセージ表示中にMEを演奏します。
ME名は必須です。
audio/me/配下にあるMEファイル名(拡張子は除く)を指定してください。

音量、ピッチ、位相は数値で指定、または
制御文字の\v[n]を利用可能です。

なお、ここでの音量、ピッチ、位相設定は
プラグインパラメータで指定できる初期値よりも優先されます。

音量、ピッチ、位相を初期値のまま使用する場合は、
ME名のみ指定してください。
(音量のみを指定して、残りを初期設定値で再生させることも可能です)

\$[X,Y]
・メッセージ中に挿入すると、画面右上に所持金ウィンドウを表示します。
本プラグインでは、所持金ウィンドウの背景をメッセージウィンドウと
同じく選択可能にしました。

Xには0~2の数値、または制御文字の\v[n]を指定してください。
Xが0で所持金ウィンドウを通常表示(デフォルト設定)、
1で暗くして表示、2で透明表示します。

Yには0~8の数値、または制御文字の\v[n]を指定してください。
Yが0で所持金ウィンドウを画面左上に表示、1で左中央、2で左下、
3で上中央、4で中央、5で下中央、6で右上(デフォルト)、
7で右中央、8で右下に表示されます。


機能を拡張した制御文字:
\.
・メッセージ中に挿入すると、その位置で15フレーム待機してから
続きのメッセージを表示する制御文字です。
本プラグインでは、待機フレーム数をプラグインパラメーターで
指定できます。

\|
・メッセージ中に挿入すると、その位置で60フレーム待機してから
続きのメッセージを表示する制御文字です。
本プラグインでは、待機フレーム数をプラグインパラメーターで
指定できます。

\n[X] (\n[X,Y])
・メッセージ中に挿入すると、アクターID:Xの名前に置き換わる制御文字です。
本プラグインでは、名前の部分に自動的に色をつけて表示します。
(つまり、\c[2]\n[X]\c[0] のように制御文字\cで囲むのと同じ状態ですが、
この制御文字の記述を\n[X]単体で済ますことができます)

つける色はプラグインパラメーターで指定できます。

この制御文字の直前に色変更の制御文字が記述されていた場合は、
本プラグインによる色変更を行わず、直前に記述されている
色変更の制御文字に従い色が変更されます。

[X,Y]と指定されている場合、アクターID:Xの名前を
最初からY文字目まで切り取った文字列を表示します。
例)
\n[1] = ハロルド
\n[1,2] = ハロ

\p[X] (\p[X,Y])
・メッセージ中に挿入すると、パーティーメンバーX番目の
アクターの名前に置き換わる制御文字です。
本プラグインでは、自動的に名前の部分に色をつけて表示します。
(つまり、\c[2]\p[X]\c[0] のように制御文字\cで囲むのと同じ状態ですが、
この制御文字の記述を\p[X]単体で済ますことができます)

つける色はプラグインパラメーターで指定できます。

この制御文字の直前に色変更の制御文字が記述されていた場合は、
本プラグインによる色変更を行わず、直前に記述されている
色変更の制御文字に従い色が変更されます。

[X,Y]と指定されている場合、パーティーメンバーX番目の名前を
最初からY文字目まで切り取った文字列を表示します。
例)
\n[1] = マーシャ
\n[1,2] = マー

\$
・メッセージ中に挿入すると、画面右上に所持金ウィンドウを表示します。

本プラグインでは、プラグインパラメーター[Default_Gold_Background]に
指定されている数値または制御文字の\v[n]によって
ウィンドウの背景が自動的に変更されるようになります。

数値が0で所持金ウィンドウを通常表示(デフォルト設定)、
1で暗くして表示、2で透明表示します。

また、プラグインパラメーター[Default_Gold_Potision]によって
ウィンドウの位置が変更可能です。

値は数値の0~8、または制御文字の\v[n]を指定してください。
0で所持金ウィンドウを画面左上に表示、1で左中央、2で左下、
3で上中央、4で中央、5で下中央、6で右上(デフォルト)、
7で右中央、8で右下に表示されます。



制御文字の設定例:
\se[Cat,20,100,0]
・猫のSEを音量20、ピッチ100、位相0で再生します。

\SE[Bell1]
・ベル1のSEを初期値の設定で再生します。

\SE[Coin,\v[20]]
・コインのSEを音量[変数20番に格納されている数値]、
他は初期値の設定を使い再生します。

\ME[Fanfare1]
・ファンファーレ1のMEを初期値の設定で再生します。

\$[1]
・所持金ウィンドウを背景を暗くした状態で画面右上に表示します。


プラグインコマンド:
ありません。


スクリプトコマンド:
ありません。


補足:
・このプラグインに関するメモ欄の設定、プラグインコマンド、
制御文字は大文字/小文字を区別していません。
ですが、SEファイル名を指定する部分は念のため実際のファイル名と
名前を合せておくことを推奨します。

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

・プラグインパラメーターの説明に、[変数可]と書かれているものは
設定値に変数の制御文字である\v[n]を使用可能です。
変数を設定した場合、そのパラメーターの利用時に変数の値を
参照するため、パラメーターの設定をゲーム中に変更できます。


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

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

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

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

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

パラメータ
param Default_SE_Volume
desc [初期値:変数可] 制御文字 \SE 使用時に再生するSEの音量です。
type string
default 90

param Default_SE_Pitch
desc [初期値:変数可] 制御文字 \SE 使用時に再生するSEのピッチです。
type string
default 100

param Default_SE_Pan
desc [初期値:変数可] 制御文字 \SE 使用時に再生するSEの位相です。
type string
default 0

param Default_ME_Volume
desc [初期値:変数可] 制御文字 \ME 使用時に再生するMEの音量です。
type string
default 90

param Default_ME_Pitch
desc [初期値:変数可] 制御文字 \ME 使用時に再生するMEのピッチです。
type string
default 100

param Default_ME_Pan
desc [初期値:変数可] 制御文字 \ME 使用時に再生するSEの位相です。
type string
default 0

param Default_Wait_Period
desc [変数可] 制御文字 \. 使用時に待機するフレーム数です。デフォルト15フレーム(15フレーム=1/4秒)
type string
default 15

param Default_Wait_Line
desc [変数可] 制御文字 \| 使用時に待機するフレーム数です。デフォルト60フレーム(60フレーム=1秒)
type string
default 60

param Default_Name_Color
desc [変数可] 制御文字 \N[n] または \P[n] 使用時に名前部分につける色の番号です。番号でつく色は制御文字 \C[n] を参考にしてください。
type string
default 0

param Default_Icon_Margin
desc [変数可] 制御文字 \I[n] または \p 使用時に名前部分につける色の番号です。番号でつく色は制御文字 \C[n] を参考にしてください。
type string
default 0

param Default_Gold_Background
desc [初期値:変数可] 制御文字 \$ 使用時に表示する所持金ウィンドウの背景を指定します。(0:ウィンドウ 1:暗くする 2:透明)
type string
default 0

param Default_Gold_Position
desc [初期値:変数可] 制御文字 \$ 使用時に表示する所持金ウィンドウの位置を指定します。詳細はヘルプを確認してください。
type string
default 6

param Message_Icon_Margin
desc [初期値] 制御文字 \I[n] 使用時に表示されるアイコンの余白を指定します。
type number
decimals 0
min 0
default 4

==============================================================================
ライセンス表記
・作者に無断で本プラグインの改変、再配布が可能です。
(ただしヘッダーの著作権表示部分は残してください。)
・利用形態(フリーゲーム、商用ゲーム、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_ControlCharacterEx.js