Free_Game / maimai_6_0418 /js /plugins /DTextPicture.js
Sageen's picture
Super-squash branch 'main' using huggingface_hub
99b0de1 verified
Raw
History Blame Contribute Delete
28.3 kB
//=============================================================================
// DTextPicture.js
// ----------------------------------------------------------------------------
// (C)2015 Triacontane
// This software is released under the MIT License.
// http://opensource.org/licenses/mit-license.php
// ----------------------------------------------------------------------------
// Version
// 2.6.3 2023/07/23 2.6.2の修正で高さが反映されていなかった問題を修正
// 2.6.2 2023/07/23 ウィンドウのカーソル設定のコマンドでX, Y座標の変更が機能していなかった問題と、高さ項目の表示名が間違っていた問題を修正
// 2.6.1 2022/06/26 2.6.0で不透明度を指定せず実行するとエラーになる問題を修正
// 2.6.0 2022/06/26 背景ウィンドウの透明度を指定できる機能を追加
// 2.5.0 2022/05/26 動的文字列ピクチャの設定を解除するコマンドを追加
// 2.4.0 2021/10/29 行の高さをコマンドから指定できる機能を追加
// 直前に生成したピクチャの横幅、高さを変数に格納する機能
// 2.3.0 2021/06/05 フォントロードプラグインと組み合わせて動的文字列ピクチャに好きなフォントを指定できる機能を追加
// 2.2.3 2021/05/04 一部の制御文字を使っていると揃えを中央もしくは右揃えにしたときに正しく表示されない問題を修正
// フォントサイズを小さくして複数行表示したときに1行目の高さが正しく計算されない問題を修正
// 競合対策のためのリファクタリング
// 2.2.2 2021/03/27 文字列を太字にする機能とイタリック体にする機能が正常に動作していなかった問題を修正
// 2.2.1 2021/02/08 色調変更したピクチャを消去し、同一の番号で動的文字列ピクチャを作成したとき文字列ピクチャが表示されない場合がある問題を修正
// 2.2.0 2021/01/22 複数行の動的文字列を中央揃え、右揃えにできる機能を追加
// 2.1.0 2021/01/10 動的文字列のフォントサイズを指定できる機能を追加
// 2.0.4 2021/01/06 制御文字\v[n,m]でもリアルタイム描画されるよう修正
// 2.0.3 2020/09/01 制御文字\oc[c], \ow[n]の移植が漏れていた問題を修正
// 2.0.2 2020/08/26 ベースプラグインの説明を追加
// 2.0.1 2020/08/26 描画文字列に数値のみを指定するとエラーになる問題を修正
// 2.0.0 2020/08/15 MZ対応用に全面リファクタリング
// 1.0.0 2015/11/06 初版
// ----------------------------------------------------------------------------
// [Blog] : https://triacontane.blogspot.jp/
// [Twitter]: https://twitter.com/triacontane/
// [GitHub] : https://github.com/triacontane/
//=============================================================================
/*:
* @plugindesc 動的文字列ピクチャ生成プラグイン
* @target MZ
* @url https://github.com/triacontane/RPGMakerMV/tree/mz_master/DTextPicture.js
* @author トリアコンタン
* @base PluginCommonBase
* @orderAfter PluginCommonBase
*
* @param frameWindowSkin
* @text フレームウィンドウスキン
* @desc フレームウィンドウのスキンファイル名です。ウィンドウビルダーを使っている場合は、指定する必要があります。
* @default
* @require 1
* @dir img/system/
* @type file
*
* @param frameWindowPadding
* @text フレームウィンドウ余白
* @desc フレームウィンドウの余白です。
* @default 18
* @type number
*
* @param padCharacter
* @text 埋め文字
* @desc 数値描画時、指定桁数に満たないときに埋められる文字です。半角で1文字だけ指定してください。
* @default 0
*
* @param prefixText
* @text 接頭辞文字列
* @desc すべての文字列ピクチャの前に挿入されるテキストです。主にデフォルトの制御文字などを指定します。
* @default
*
* @param widthVariable
* @text 横幅格納変数
* @desc 直前に描画した動的文字列の横幅(ピクセル数)を格納する変数です。
* @default 0
* @type variable
*
* @param heightVariable
* @text 高さ格納変数
* @desc 直前に描画した動的文字列の高さ(ピクセル数)を格納する変数です。
* @default 0
* @type variable
*
* @command dText
* @text 文字列ピクチャ準備
* @desc 文字列ピクチャで表示する文字列を準備します。
*
* @arg text
* @text 表示文字列
* @desc 文字列ピクチャとして表示するテキストです。
* @default
* @type multiline_string
*
* @arg fontSize
* @text フォントサイズ
* @desc 動的文字列の初期フォントサイズです。0を指定するとシステムで設定したデフォルトサイズになります。
* @default 0
* @type number
*
* @command dTextSetting
* @text 文字列ピクチャ設定
* @desc 文字列ピクチャの表示方法に関する設定です。変更した設定は描画後も保持されます。未設定の項目は現状維持されます。
*
* @arg backGroundColor
* @text 背景色
* @desc 文字列ピクチャの背景色です。
* @default
*
* @arg gradationLeft
* @text 左方向グラデーション
* @desc 文字列ピクチャの背景の左方向グラデーションのピクセル数です。
* @type number
* @default
*
* @arg gradationRight
* @text 右方向グラデーション
* @desc 文字列ピクチャの背景の右方向グラデーションのピクセル数です。
* @type number
* @default
*
* @arg realTime
* @text リアルタイム描画
* @desc 制御文字\v[n]を使っている場合、変数の内容が変化したらピクチャを再描画します。
* @type boolean
* @default
*
* @arg window
* @text ウィンドウ
* @desc 文字列ピクチャの背景にウィンドウを表示します。
* @type boolean
* @default
*
* @arg windowOpacity
* @text ウィンドウ不透明度
* @desc 文字列ピクチャ背景のウィンドウの不透明度です。
* @type number
* @default
*
* @arg align
* @text 揃え
* @desc 複数行の動的文字列を指定したときの揃えです。
* @default
* @type select
* @option 左揃え
* @value left
* @option 中央揃え
* @value center
* @option 右揃え
* @value right
*
* @arg fontFace
* @text フォント
* @desc 文字列ピクチャのフォントです。フォントロードプラグインで読み込んだフォントの名称を指定します。
* @default
*
* @arg lineHeight
* @text 行の高さ
* @desc 文字列ピクチャの1行分の高さです。
* @default 0
*
* @command dTextSettingClear
* @text 文字列ピクチャ設定解除
* @desc 文字列ピクチャの表示方法に関する設定を全て解除し初期化します。
*
* @command windowCursor
* @text ウィンドウカーソル設定
* @desc 表示中の文字列ピクチャの背景ウィンドウにカーソルを表示します。
*
* @arg pictureId
* @text ピクチャ番号
* @desc 対象のピクチャ番号です。すでに表示中のピクチャである必要があります。
* @type number
* @default 1
*
* @arg x
* @text X座標
* @desc カーソルのX座標です。
* @type number
* @default 0
*
* @arg y
* @text Y座標
* @desc カーソルのY座標です。
* @type number
* @default 0
*
* @arg width
* @text 横幅
* @desc カーソルの横幅です。
* @type number
* @default 100
*
* @arg height
* @text 高さ
* @desc カーソルの高さです。
* @type number
* @default 100
*
* @arg activateSwitch
* @text 有効スイッチ
* @desc 指定した場合、スイッチがONのときのみアクティブになります。指定なしの場合常にアクティブになります。
* @type switch
* @default 0
*
* @help 指定した文字列でピクチャを動的に生成するコマンドを提供します。
* 文字列には各種制御文字(\v[n]等)も使用可能で、制御文字で表示した変数の値が
* 変更されたときにリアルタイムでピクチャの内容を更新できます。
*
* 以下の手順で表示します。
* 1 : プラグインコマンド[文字列ピクチャ準備]で描画内容を準備
* 2 : イベントコマンド「ピクチャの表示」で「画像」を未選択に指定。
* ※ 1の時点ではピクチャは表示されないので必ずセットで呼び出してください。
*
* 専用制御文字
* \V[n,m](m桁分のパラメータで指定した文字で埋めた変数の値)
* \item[n] n 番のアイテム情報(アイコン+名称)
* \weapon[n] n 番の武器情報(アイコン+名称)
* \armor[n] n 番の防具情報(アイコン+名称)
* \skill[n] n 番のスキル情報(アイコン+名称)
* \state[n] n 番のステート情報(アイコン+名称)
* \oc[c] アウトラインカラーを「c」に設定(※1)
* \ow[n] アウトライン幅を「n」に設定(例:\ow[5])
* \f[b] フォントの太字化
* \f[i] フォントのイタリック化
* \f[n] フォントの太字とイタリックを通常に戻す
*
* ※1 アウトラインカラーの指定方法
* \oc[red] 色名で指定
* \oc[rgb(0,255,0)] カラーコードで指定
* \oc[2] 文字色番号\c[n]と同様のもので指定
*
* 動的文字列ピクチャのフォントを変えたい場合は、
* 別途フォントロードプラグインを使って読み込んでください。
* https://github.com/triacontane/RPGMakerMV/blob/mz_master/FontLoad.js
*
* このプラグインの利用にはベースプラグイン『PluginCommonBase.js』が必要です。
* 『PluginCommonBase.js』は、RPGツクールMZのインストールフォルダ配下の
* 以下のフォルダに格納されています。
* dlc/BasicResources/plugins/official
*
* 利用規約:
* 作者に無断で改変、再配布が可能で、利用形態(商用、18禁利用等)
* についても制限はありません。
* このプラグインはもうあなたのものです。
*/
(function() {
'use strict';
const script = document.currentScript;
const param = PluginManagerEx.createParameter(script);
PluginManager.registerCommand(PluginManagerEx.findPluginName(script), 'dText', function(args) {
$gameScreen.setDTextPicture(args.text, PluginManagerEx.convertVariables(args.fontSize));
});
PluginManagerEx.registerCommand(script, 'dTextSetting', function(args) {
$gameScreen.setDtextSetting(args);
});
PluginManagerEx.registerCommand(script, 'dTextSettingClear', function(args) {
$gameScreen.clearDtextSetting();
});
PluginManagerEx.registerCommand(script, 'windowCursor', function(args) {
$gameScreen.setDTextWindowCursor(args.pictureId, args, args.activateSwitch);
});
//=============================================================================
// Game_Screen
// 動的ピクチャ用のプロパティを追加定義します。
//=============================================================================
Game_Screen.prototype.setDtextSetting = function(setting) {
if (setting.backGroundColor !== '') {
this.dTextBackColor = setting.backGroundColor;
}
if (setting.gradationLeft !== '') {
this.dTextGradationLeft = setting.gradationLeft;
}
if (setting.gradationRight !== '') {
this.dTextGradationRight = setting.gradationRight;
}
if (setting.realTime !== '') {
this.dTextRealTime = setting.realTime;
}
if (setting.window !== '') {
this.dWindowFrame = setting.window;
}
if (setting.align !== '') {
this.dTextAlign = setting.align;
}
if (setting.fontFace !== '') {
this.dTextFontFace = setting.fontFace;
}
if (setting.lineHeight > 0) {
this.dTextLineHeight = setting.lineHeight;
}
if (setting.windowOpacity !== '') {
this.dTextWindowOpacity = setting.windowOpacity;
}
};
Game_Screen.prototype.clearDtextSetting = function() {
this.dTextBackColor = null;
this.dTextGradationLeft = null;
this.dTextGradationRight = null;
this.dTextRealTime = null;
this.dWindowFrame = null;
this.dTextAlign = null;
this.dTextFontFace = null;
this.dTextLineHeight = null;
this.dTextWindowOpacity = null;
};
Game_Screen.prototype.clearDTextPicture = function() {
this.dTextValue = null;
};
Game_Screen.prototype.setDTextPicture = function(value, size) {
if (typeof TranslationManager !== 'undefined') {
TranslationManager.translateIfNeed(value, function(translatedText) {
value = translatedText;
});
}
if (size > 0) {
value = `\\fs[${size}]${value}`;
}
this.dTextValue = value;
this.dTextSize = size;
};
Game_Screen.prototype.setDTextWindowCursor = function(pictureId, rect, switchId) {
const picture = this.picture(pictureId);
if (picture) {
picture.setWindowCursor(rect, switchId);
}
};
Game_Screen.prototype.getDTextPictureInfo = function() {
const prefix = param.prefixText || '';
return {
value : prefix + this.dTextValue,
size : this.dTextSize,
color : this.dTextBackColor,
realTime : this.dTextRealTime,
windowFrame : this.dWindowFrame,
gradationLeft : this.dTextGradationLeft,
gradationRight: this.dTextGradationRight,
align : this.dTextAlign,
font : this.dTextFontFace,
lineHeight : this.dTextLineHeight,
windowOpacity : this.dTextWindowOpacity
};
};
Game_Screen.prototype.isSettingDText = function() {
return !!this.dTextValue;
};
//=============================================================================
// Game_Picture
// 動的ピクチャ用のプロパティを追加定義し、表示処理を動的ピクチャ対応に変更します。
//=============================================================================
const _Game_Picture_initBasic = Game_Picture.prototype.initBasic;
Game_Picture.prototype.initBasic = function() {
_Game_Picture_initBasic.call(this);
this.dTextValue = null;
this.dTextInfo = null;
};
const _Game_Picture_show = Game_Picture.prototype.show;
Game_Picture.prototype.show = function(name, origin, x, y, scaleX,
scaleY, opacity, blendMode) {
if ($gameScreen.isSettingDText() && !name) {
arguments[0] = Date.now().toString();
this.dTextInfo = $gameScreen.getDTextPictureInfo();
this.updateDText();
$gameScreen.clearDTextPicture();
} else {
this.dTextInfo = null;
this._dTextValue = null;
}
_Game_Picture_show.apply(this, arguments);
};
const _Game_Picture_update = Game_Picture.prototype.update;
Game_Picture.prototype.update = function() {
_Game_Picture_update.apply(this, arguments);
if (this.dTextInfo && this.dTextInfo.realTime) {
this.updateDText();
}
};
Game_Picture.prototype.updateDText = function() {
const text = PluginManagerEx.convertEscapeCharacters(this.dTextInfo.value);
if (text !== this._dTextValue) {
this._name = Date.now().toString();
}
this._dTextValue = text;
};
Game_Picture.prototype.getDText = function() {
return this._dTextValue;
};
Game_Picture.prototype.setWindowCursor = function(rect, switchId) {
this._windowCursor = rect;
this._windowCursorActive = switchId;
};
Game_Picture.prototype.getWindowCursor = function() {
return this._windowCursor;
};
Game_Picture.prototype.getWindowCursorActive = function() {
const switchId = this._windowCursorActive;
return !switchId || $gameSwitches.value(switchId);
};
//=============================================================================
// Window_Base
// 文字列変換処理に追加制御文字を設定します。
//=============================================================================
const _PluginManagerEx_convertEscapeCharactersEx = PluginManagerEx.convertEscapeCharactersEx;
PluginManagerEx.convertEscapeCharactersEx = function(text, data = null) {
text = _PluginManagerEx_convertEscapeCharactersEx.call(this, text, data);
text = text.replace(/\x1bV\[(\d+),\s*(\d+)]/gi, function() {
return this.getVariablePadCharacter($gameVariables.value(parseInt(arguments[1], 10)), arguments[2]);
}.bind(this));
text = text.replace(/\x1bITEM\[(\d+)]/gi, function() {
const item = $dataItems[parseInt(arguments[1])];
return this.getItemInfoText(item);
}.bind(this));
text = text.replace(/\x1bWEAPON\[(\d+)]/gi, function() {
const item = $dataWeapons[parseInt(arguments[1])];
return this.getItemInfoText(item);
}.bind(this));
text = text.replace(/\x1bARMOR\[(\d+)]/gi, function() {
const item = $dataArmors[parseInt(arguments[1])];
return this.getItemInfoText(item);
}.bind(this));
text = text.replace(/\x1bSKILL\[(\d+)]/gi, function() {
const item = $dataSkills[parseInt(arguments[1])];
return this.getItemInfoText(item);
}.bind(this));
text = text.replace(/\x1bSTATE\[(\d+)]/gi, function() {
const item = $dataStates[parseInt(arguments[1])];
return this.getItemInfoText(item);
}.bind(this));
return text;
};
PluginManagerEx.getItemInfoText = function(item) {
return item ?`\x1bi[${item.iconIndex}]${item.name}` : '';
};
PluginManagerEx.getVariablePadCharacter = function(value, digit) {
let numText = String(Math.abs(value));
const pad = String(param.padCharacter) || '0';
while (numText.length < digit) {
numText = pad + numText;
}
return (value < 0 ? '-' : '') + numText;
};
//=============================================================================
// Sprite_Picture
// 画像の動的生成を追加定義します。
//=============================================================================
const _Sprite_Picture_update = Sprite_Picture.prototype.update;
Sprite_Picture.prototype.update = function() {
_Sprite_Picture_update.apply(this, arguments);
if (this._frameWindow) {
this.updateFrameWindow();
}
};
Sprite_Picture.prototype.updateFrameWindow = function() {
const padding = param.frameWindowPadding;
this._frameWindow.x = this.x - (this.anchor.x * this.width * this.scale.x) - padding;
this._frameWindow.y = this.y - (this.anchor.y * this.height * this.scale.y) - padding;
this._frameWindow.opacity = this.opacity;
if (this.dTextInfo && this.dTextInfo.windowOpacity >= 0) {
this._frameWindow.backOpacity = this.dTextInfo.windowOpacity;
}
if (!this.visible || !this.dTextInfo) {
this.removeFrameWindow();
return;
}
if (!this._addFrameWindow) {
this.addFrameWindow();
}
if (Graphics.frameCount % 2 === 0) {
this.adjustScaleFrameWindow();
}
this.updateFrameWindowCursor();
};
Sprite_Picture.prototype.updateFrameWindowCursor = function() {
const picture = this.picture();
if (!picture) {
return;
}
const rect = picture.getWindowCursor();
if (rect) {
const width = rect.width || this._frameWindow.contentsWidth();
const height = rect.height || this._frameWindow.contentsHeight();
const x = rect.x || 0;
const y = rect.y || 0;
this._frameWindow.setCursorRect(x, y, width, height);
this._frameWindow.active = picture.getWindowCursorActive();
} else {
this._frameWindow.setCursorRect(0, 0, 0, 0);
}
};
Sprite_Picture.prototype.adjustScaleFrameWindow = function() {
const padding = param.frameWindowPadding;
const newFrameWidth = Math.floor(this.width * this.scale.x + padding * 2);
const newFrameHeight = Math.floor(this.height * this.scale.x + padding * 2);
if (this._frameWindow.width !== newFrameWidth || this._frameWindow.height !== newFrameHeight) {
this._frameWindow.move(this._frameWindow.x, this._frameWindow.y, newFrameWidth, newFrameHeight);
}
};
Sprite_Picture.prototype.addFrameWindow = function() {
const parent = this.parent;
if (parent) {
const index = parent.getChildIndex(this);
parent.addChildAt(this._frameWindow, index);
this._addFrameWindow = true;
}
};
Sprite_Picture.prototype.removeFrameWindow = function() {
const parent = this.parent;
if (parent) {
parent.removeChild(this._frameWindow);
this._frameWindow = null;
this._addFrameWindow = false;
}
};
Sprite_Picture.prototype.makeFrameWindow = function(width, height) {
const padding = param.frameWindowPadding;
const rect = new Rectangle(0, 0, width + padding * 2, height + padding * 2);
this._frameWindow = new Window_Base(rect);
if (param.frameWindowSkin) {
this._frameWindow.windowskin = ImageManager.loadSystem(param.frameWindowSkin);
}
};
const _Sprite_Picture_loadBitmap = Sprite_Picture.prototype.loadBitmap;
Sprite_Picture.prototype.loadBitmap = function() {
this.dTextInfo = this.picture().dTextInfo;
if (this.dTextInfo) {
this.makeDynamicBitmap();
} else {
_Sprite_Picture_loadBitmap.apply(this, arguments);
}
};
Sprite_Picture.prototype.makeDynamicBitmap = function() {
const tempWindow = new Window_Dummy();
this.bitmap = tempWindow.createTextContents(this.picture().getDText(), this.dTextInfo);
if (param.widthVariable) {
$gameVariables.setValue(param.widthVariable, this.bitmap.width);
}
if (param.heightVariable) {
$gameVariables.setValue(param.heightVariable, this.bitmap.height);
}
if (this.dTextInfo.color) {
this.makeDynamicBitmapBack();
}
this.setColorTone([0, 0, 0, 0]);
tempWindow.drawTextContents();
if (this._frameWindow) {
this.removeFrameWindow();
}
if (this.dTextInfo.windowFrame) {
const scaleX = this.picture().scaleX() / 100;
const scaleY = this.picture().scaleY() / 100;
this.makeFrameWindow(this.bitmap.width * scaleX, this.bitmap.height * scaleY);
}
};
Sprite_Picture.prototype.makeDynamicBitmapBack = function() {
this.bitmap.fillAll(this.dTextInfo.color);
const h = this.bitmap.height;
const w = this.bitmap.width;
const gradationLeft = this.dTextInfo.gradationLeft;
if (gradationLeft > 0) {
this.bitmap.clearRect(0, 0, gradationLeft, h);
this.bitmap.gradientFillRect(0, 0, gradationLeft, h, 'rgba(0, 0, 0, 0)', this.dTextInfo.color, false);
}
const gradationRight = this.dTextInfo.gradationRight;
if (gradationRight > 0) {
this.bitmap.clearRect(w - gradationRight, 0, gradationRight, h);
this.bitmap.gradientFillRect(w - gradationRight, 0, gradationRight, h, this.dTextInfo.color, 'rgba(0, 0, 0, 0)', false);
}
};
/**
* Window_Dummy
* 動的文字列ピクチャ描画用のダミーウィンドウ
*/
class Window_Dummy extends Window_Base {
constructor() {
super(new Rectangle());
}
createTextContents(text, dTextInfo) {
this._size = dTextInfo.size;
this._face = dTextInfo.font;
this._lineHeight = dTextInfo.lineHeight;
this._text = text;
const rect = this.textSizeEx(text);
this.textPictureWidth = rect.width;
this.textPictureAlign = dTextInfo.align;
this.contents = new Bitmap(rect.width, rect.height);
return this.contents;
}
drawTextContents() {
this.drawTextEx(this._text, 0, 0);
this.contents = null;
this.destroy();
}
calcTextHeight(textState) {
return this._lineHeight || super.calcTextHeight(textState);
}
processAllText(textState) {
if (textState.drawing) {
this.setStartXForAlign(textState);
}
super.processAllText(textState);
}
processNewLine(textState) {
super.processNewLine(textState);
if (textState.drawing) {
this.setStartXForAlign(textState);
}
}
setStartXForAlign(textState) {
const lines = textState.text.slice(textState.index).split("\n");
textState.widthList = lines.map(line => this.textSizeEx(line).width);
textState.x = this.findStartXForAlign(textState);
}
resetFontSettings() {
super.resetFontSettings();
if (this._size) {
this.contents.fontSize = this._size;
}
if (this._face) {
this.contents.fontFace = this._face;
}
}
processEscapeCharacter(code, textState) {
super.processEscapeCharacter(code, textState);
switch (code) {
case 'OC':
const colorCode = this.obtainEscapeParamString(textState);
const colorIndex = Number(colorCode);
this.changeOutlineColor(!isNaN(colorIndex) ? ColorManager.textColor(colorIndex) : colorCode);
break;
case 'OW':
this.contents.outlineWidth = this.obtainEscapeParam(textState);
break;
case 'F':
this.changeFontStyle(this.obtainEscapeParamString(textState));
break;
}
}
changeFontStyle(value) {
switch (value.toUpperCase()) {
case 'B':
this.contents.fontBold = true;
break;
case 'I':
this.contents.fontItalic = true;
break;
default:
this.contents.fontItalic = false;
this.contents.fontBold = false;
}
}
obtainEscapeParamString(textState) {
const arr = /^\[.+?]/.exec(textState.text.slice(textState.index));
if (arr) {
textState.index += arr[0].length;
return arr[0].substring(1, arr[0].length - 1);
} else {
return '';
}
}
findStartXForAlign(textState) {
const dx = this.textPictureWidth - textState.widthList.shift();
if (this.textPictureAlign === 'center') {
return Math.floor(dx / 2);
} else if (this.textPictureAlign === 'right') {
return dx;
} else {
return 0;
}
}
}
})();