616 lines
18 KiB
JavaScript
616 lines
18 KiB
JavaScript
// DarkPlasma_NameWindow 2.0.0
|
||
// Copyright (c) 2019 DarkPlasma
|
||
// This software is released under the MIT license.
|
||
// http://opensource.org/licenses/mit-license.php
|
||
|
||
/**
|
||
* 2021/11/28 2.0.0 rollup構成へ移行
|
||
* 不要な設定を削除
|
||
* MessageSkip.js でスキップする際に名前ウィンドウが残ることがある不具合を修正
|
||
* 2020/09/21 1.3.2 メッセージウィンドウの透明設定を引き継ぐよう修正
|
||
* 2020/05/30 1.3.1 DarkPlasma_TextLog.js と併用した時、名前なしテキストに名前をつけてしまうことがある不具合を修正
|
||
* 2020/05/08 1.3.0 閉じるアニメーションの設定項目を追加
|
||
* 2020/04/20 1.2.1 自動名前ウィンドウ以外でアクター名色付けが機能していない不具合を修正
|
||
* 2020/04/18 1.2.0 MessageWindowHidden.js との競合を修正
|
||
* DarkPlasma_AutoHightlight.js よりも自動名前検出時の色設定を優先するオプションを追加
|
||
* 2020/04/12 1.1.1 convertEscapeCharactersを呼び出すようなプラグインとの競合を修正
|
||
* リファクタ
|
||
* 2020/01/26 1.1.0 パディング幅の設定項目追加
|
||
* 1.0.1 メッセージウィンドウの位置によって名前ウィンドウの位置がズレる不具合を修正
|
||
* 2019/11/01 1.0.0 公開
|
||
*/
|
||
|
||
/*:ja
|
||
* @plugindesc メッセージに名前ウィンドウを表示する
|
||
* @author DarkPlasma
|
||
* @license MIT
|
||
*
|
||
* @target MV
|
||
* @url https://github.com/elleonard/DarkPlasma-MV-Plugins/tree/release
|
||
*
|
||
* @param standardPadding
|
||
* @desc 名前ウィンドウの基本パディング幅を設定します。
|
||
* @text 基本パディング幅
|
||
* @type number
|
||
* @default 18
|
||
*
|
||
* @param horizontalPadding
|
||
* @desc 名前ウィンドウの横パディング幅を設定します。
|
||
* @text 横パディング幅
|
||
* @type number
|
||
* @default 72
|
||
*
|
||
* @param defaultColor
|
||
* @desc 名前ウィンドウのデフォルト文字色を設定します。
|
||
* @text デフォルト色
|
||
* @type number
|
||
* @default 6
|
||
*
|
||
* @param windowOffsetX
|
||
* @desc 名前ウィンドウのX軸上の相対位置を設定します。
|
||
* @text 相対位置X
|
||
* @type number
|
||
* @default -28
|
||
*
|
||
* @param windowOffsetY
|
||
* @desc 名前ウィンドウのY軸上の相対位置を設定します。
|
||
* @text 相対位置Y
|
||
* @type number
|
||
* @default 0
|
||
*
|
||
* @param closeDelayFrame
|
||
* @desc メッセージウィンドウから遅れて閉じるフレーム数を設定します。
|
||
* @text 閉じるウェイト
|
||
* @type number
|
||
* @default 4
|
||
*
|
||
* @param actorColors
|
||
* @desc アクターごとに名前の色を設定します。
|
||
* @text アクター色設定
|
||
* @type struct<ActorColor>[]
|
||
* @default []
|
||
*
|
||
* @param autoDetectName
|
||
* @desc ONの場合、「及び（を検出して自動で名前ウィンドウを表示します。
|
||
* @text 自動名前ウィンドウ
|
||
* @type boolean
|
||
* @default false
|
||
*
|
||
* @help
|
||
* version: 2.0.0
|
||
* メッセージテキストに以下のように記述すると名前ウィンドウを表示します。
|
||
*
|
||
* \n<***> あるいは \n1<***> : 左寄せ
|
||
* \n2<***> : 中央左
|
||
* \nc<***> あるいは \n3<***> : 中央寄せ
|
||
* \n4<***> : 中央右
|
||
* \nr<***> あるいは \n5<***> : 右寄せ
|
||
*
|
||
* また、以下のように入力すると
|
||
* アクター名入りの名前ウィンドウを左寄せで表示します。
|
||
*
|
||
* \ndp<アクターID>
|
||
*
|
||
* 自動名前ウィンドウの設定がONの場合、以下の形式のメッセージを検出して
|
||
* 自動で名前ウィンドウを表示します。
|
||
*
|
||
* 名前「セリフ」
|
||
*
|
||
* 名前（セリフ）
|
||
*/
|
||
/*~struct~ActorColor:
|
||
* @param actor
|
||
* @text アクター
|
||
* @type actor
|
||
*
|
||
* @param color
|
||
* @text 名前の色
|
||
* @type string
|
||
* @default 6
|
||
*/
|
||
(() => {
|
||
'use strict';
|
||
|
||
const pluginName = document.currentScript.src.replace(/^.*\/(.*).js$/, function () {
|
||
return arguments[1];
|
||
});
|
||
|
||
const pluginParameters = PluginManager.parameters(pluginName);
|
||
|
||
const settings = {
|
||
standardPadding: Number(pluginParameters.standardPadding || 18),
|
||
horizontalPadding: Number(pluginParameters.horizontalPadding || 72),
|
||
defaultColor: Number(pluginParameters.defaultColor || 6),
|
||
windowOffsetX: Number(pluginParameters.windowOffsetX || -28),
|
||
windowOffsetY: Number(pluginParameters.windowOffsetY || 0),
|
||
closeDelayFrame: Number(pluginParameters.closeDelayFrame || 4),
|
||
actorColors: JSON.parse(pluginParameters.actorColors || '[]').map((e) => {
|
||
return ((parameter) => {
|
||
const parsed = JSON.parse(parameter);
|
||
return {
|
||
actor: Number(parsed.actor || 0),
|
||
color: String(parsed.color || '6'),
|
||
};
|
||
})(e || '{}');
|
||
}),
|
||
autoDetectName: String(pluginParameters.autoDetectName || false) === 'true',
|
||
};
|
||
|
||
/** 名前ウィンドウの位置 */
|
||
const NAME_WINDOW_POSITION = {
|
||
LEFT_EDGE: 1,
|
||
LEFT: 2,
|
||
CENTER: 3,
|
||
RIGHT: 4,
|
||
RIGHT_EDGE: 5,
|
||
};
|
||
|
||
/**
|
||
* アクターIDからアクター名を取得する
|
||
* 存在しないIDの場合nullを返す
|
||
* @param {number} actorId アクターID
|
||
* @return {string|null}
|
||
*/
|
||
function actorName(actorId) {
|
||
return Window_Base.prototype.actorName(actorId);
|
||
}
|
||
|
||
/**
|
||
* アクターの名前から色を算出する
|
||
* 色設定がない場合はデフォルト色を返す
|
||
* @param {string} name 名前
|
||
* @return {number}
|
||
*/
|
||
function colorByName(name) {
|
||
const actor = $gameActors.byName(name);
|
||
if (actor) {
|
||
const colorSetting = settings.actorColors.find(
|
||
(actorColor) => Number(actorColor.actor) === Number(actor.actorId())
|
||
);
|
||
return colorSetting ? colorSetting.color : settings.defaultColor;
|
||
}
|
||
return settings.defaultColor;
|
||
}
|
||
|
||
class NameWindowTextInfo {
|
||
/**
|
||
* @param {string} name 名前
|
||
* @param {number} position 表示位置
|
||
* @param {RegExp|string} eraseTarget メッセージから取り除く文字列
|
||
*/
|
||
constructor(name, position, eraseTarget) {
|
||
this._name = name;
|
||
this._position = position;
|
||
this._eraseTarget = eraseTarget;
|
||
}
|
||
|
||
/**
|
||
* @param {string} text メッセージ
|
||
* @return {NameWindowTextInfo|null}
|
||
*/
|
||
static fromMessageText(text) {
|
||
const regExpAndPositions = [
|
||
{
|
||
regExp: /\x1bN\<(.*?)\>/gi,
|
||
position: NAME_WINDOW_POSITION.LEFT_EDGE,
|
||
},
|
||
{
|
||
regExp: /\x1bN1\<(.*?)\>/gi,
|
||
position: NAME_WINDOW_POSITION.LEFT_EDGE,
|
||
},
|
||
{
|
||
regExp: /\x1bN2\<(.*?)\>/gi,
|
||
position: NAME_WINDOW_POSITION.LEFT,
|
||
},
|
||
{
|
||
regExp: /\x1bN3\<(.*?)\>/gi,
|
||
position: NAME_WINDOW_POSITION.CENTER,
|
||
},
|
||
{
|
||
regExp: /\x1bNC\<(.*?)\>/gi,
|
||
position: NAME_WINDOW_POSITION.CENTER,
|
||
},
|
||
{
|
||
regExp: /\x1bN4\<(.*?)\>/gi,
|
||
position: NAME_WINDOW_POSITION.RIGHT,
|
||
},
|
||
{
|
||
regExp: /\x1bN5\<(.*?)\>/gi,
|
||
position: NAME_WINDOW_POSITION.RIGHT_EDGE,
|
||
},
|
||
{
|
||
regExp: /\x1bNR\<(.*?)\>/gi,
|
||
position: NAME_WINDOW_POSITION.RIGHT_EDGE,
|
||
},
|
||
{
|
||
regExp: /\x1bNDP\<(.*?)\>/gi,
|
||
position: NAME_WINDOW_POSITION.LEFT_EDGE,
|
||
isActorId: true,
|
||
},
|
||
];
|
||
const hit = regExpAndPositions
|
||
.map((regExpAndPosition) => {
|
||
return {
|
||
regExp: new RegExp(regExpAndPosition.regExp),
|
||
position: regExpAndPosition.position,
|
||
idOrName: regExpAndPosition.regExp.exec(text),
|
||
isActorId: regExpAndPosition.isActorId,
|
||
};
|
||
})
|
||
.find((hit) => hit.idOrName && hit.idOrName[1]);
|
||
if (hit) {
|
||
const name = hit.isActorId ? actorName(hit.idOrName[1]) : hit.idOrName[1];
|
||
return new NameWindowTextInfo(name, hit.position, hit.regExp);
|
||
}
|
||
|
||
if (settings.autoDetectName) {
|
||
// 名前＋開きカッコを見つけ次第、名前ウィンドウを設定する
|
||
const speakerReg = new RegExp('^(.+)(「|（)', 'gi');
|
||
const speaker = speakerReg.exec(text);
|
||
if (speaker !== null) {
|
||
let target = speaker[1].replace('\x1b}', '');
|
||
const eraseTarget = target;
|
||
/**
|
||
* 色は強制的に固定する
|
||
*/
|
||
target = target.replace(/\x1bC\[(#?[0-9]*)\]/gi, '');
|
||
|
||
if (target.length > 0) {
|
||
return new NameWindowTextInfo(target, NAME_WINDOW_POSITION.LEFT_EDGE, eraseTarget);
|
||
}
|
||
}
|
||
}
|
||
return null;
|
||
}
|
||
|
||
get name() {
|
||
return this._name;
|
||
}
|
||
|
||
get position() {
|
||
return this._position;
|
||
}
|
||
|
||
get eraseTarget() {
|
||
return this._eraseTarget;
|
||
}
|
||
|
||
/**
|
||
* 色付きの名前
|
||
* @return {string}
|
||
*/
|
||
coloredName() {
|
||
const speakerNames = this.name.split('＆');
|
||
const speakerNameString = speakerNames
|
||
.map((speakerName) => {
|
||
// 設定値の色があればそれを設定する
|
||
const color = colorByName(speakerName);
|
||
return speakerName.replace(new RegExp(`^${speakerName}$`, 'gi'), `\\C[${color}]${speakerName}`);
|
||
}, this)
|
||
.join('\\C[0]＆');
|
||
return speakerNameString;
|
||
}
|
||
}
|
||
|
||
Game_Message.prototype.nextText = function () {
|
||
return this._texts[0];
|
||
};
|
||
|
||
/**
|
||
* MessageSkip.js 対応
|
||
*/
|
||
if (!Game_Message.prototype.skipFlg) {
|
||
Game_Message.prototype.skipFlg = function () {
|
||
return false;
|
||
};
|
||
}
|
||
|
||
Game_Actors.prototype.byName = function (name) {
|
||
const actor = $dataActors.find((actor) => actor && actor.name === name);
|
||
if (actor) {
|
||
if (!this._data[actor.id]) {
|
||
this._data[actor.id] = new Game_Actor(actor.id);
|
||
}
|
||
return this._data[actor.id];
|
||
}
|
||
return null;
|
||
};
|
||
|
||
/**
|
||
* 名前ウィンドウ表示中に戦闘に入った場合、名前ウィンドウを消す
|
||
*/
|
||
const _SceneMap_snapForBattleBackground = Scene_Map.prototype.snapForBattleBackground;
|
||
Scene_Map.prototype.snapForBattleBackground = function () {
|
||
if (this.isNameWindowVisible()) {
|
||
this._messageWindow.hideNameWindow();
|
||
}
|
||
_SceneMap_snapForBattleBackground.call(this);
|
||
};
|
||
|
||
Scene_Map.prototype.hasNameWindow = function () {
|
||
return this._messageWindow && this._messageWindow.hasNameWindow();
|
||
};
|
||
|
||
Scene_Map.prototype.isNameWindowVisible = function () {
|
||
return this.hasNameWindow() && this._messageWindow.isNameWindowVisible();
|
||
};
|
||
|
||
class Window_SpeakerName extends Window_Base {
|
||
/**
|
||
* @param {Window_Message} parentWindow メッセージウィンドウ
|
||
*/
|
||
constructor(parentWindow) {
|
||
super();
|
||
this.initialize(parentWindow);
|
||
}
|
||
|
||
initialize(parentWindow) {
|
||
this._parentWindow = parentWindow;
|
||
super.initialize(0, 0, 240, this.windowHeight());
|
||
this._text = '';
|
||
this._openness = 0;
|
||
this.stopClose();
|
||
this.deactivate();
|
||
this.hide();
|
||
}
|
||
|
||
/**
|
||
* @return {number}
|
||
*/
|
||
standardPadding() {
|
||
return settings.standardPadding;
|
||
}
|
||
|
||
/**
|
||
* DarkPlasma_WordwrapForJapanese.js への対応
|
||
* @return {boolean}
|
||
*/
|
||
wordWrapEnabled() {
|
||
return false;
|
||
}
|
||
|
||
/**
|
||
* @return {number}
|
||
*/
|
||
windowWidth() {
|
||
this.resetFontSettings();
|
||
const textWidth = this.textWidthEx(this._text);
|
||
const width = textWidth + this.padding * 2 + settings.horizontalPadding;
|
||
return Math.ceil(width);
|
||
}
|
||
|
||
/**
|
||
* @return {number}
|
||
*/
|
||
windowHeight() {
|
||
return this.fittingHeight(1);
|
||
}
|
||
|
||
/**
|
||
* @param {string} text テキスト
|
||
* @return {number}
|
||
*/
|
||
textWidthEx(text) {
|
||
return this.drawTextEx(text, 0, this.contents.height);
|
||
}
|
||
|
||
/**
|
||
* @return {number}
|
||
*/
|
||
contentsHeight() {
|
||
return this.lineHeight();
|
||
}
|
||
|
||
/**
|
||
* 名前ウィンドウを閉じる
|
||
* MessageSkip.js でスキップ中の場合、見栄えを考慮して強制的に閉じることとする
|
||
*/
|
||
startClose() {
|
||
this._startClose = this.isOpen() || $gameMessage.skipFlg();
|
||
}
|
||
|
||
/**
|
||
* 名前ウィンドウクローズ用変数の初期化
|
||
*/
|
||
stopClose() {
|
||
this._startClose = false;
|
||
this._closeDelayCounter = settings.closeDelayFrame;
|
||
}
|
||
|
||
update() {
|
||
super.update();
|
||
if (this.doesContinue()) {
|
||
this.stopClose();
|
||
return;
|
||
}
|
||
if (!this._startClose) return;
|
||
if (this._closeDelayCounter-- > 0) return;
|
||
this.close();
|
||
this._startClose = false;
|
||
this._closeDelayCounter = settings.closeDelayFrame;
|
||
}
|
||
|
||
updateBackground() {
|
||
this._background = $gameMessage.background();
|
||
this.setBackgroundType(this._background);
|
||
}
|
||
|
||
/**
|
||
* @param {string} text 名前
|
||
* @param {number} position 表示場所
|
||
*/
|
||
show(text, position) {
|
||
super.show();
|
||
this.stopClose();
|
||
this._text = text;
|
||
this._position = position;
|
||
this.width = this.windowWidth(true);
|
||
this.createContents();
|
||
this.contents.clear();
|
||
this.resetFontSettings();
|
||
let padding = settings.horizontalPadding / 2;
|
||
this.drawTextEx(this._text, padding, 0);
|
||
this.adjustPositionX();
|
||
this.adjustPositionY();
|
||
this.updateBackground();
|
||
this.open();
|
||
this.activate();
|
||
}
|
||
|
||
adjustPositionX() {
|
||
switch (this._position) {
|
||
case NAME_WINDOW_POSITION.LEFT_EDGE:
|
||
this.x = this._parentWindow.x;
|
||
this.x += settings.windowOffsetX;
|
||
break;
|
||
case NAME_WINDOW_POSITION.LEFT:
|
||
this.x = this._parentWindow.x;
|
||
this.x += (this._parentWindow.width * 3) / 10;
|
||
this.x -= this.width / 2;
|
||
break;
|
||
case NAME_WINDOW_POSITION.CENTER:
|
||
this.x = this._parentWindow.x;
|
||
this.x += this._parentWindow.width / 2;
|
||
this.x -= this.width / 2;
|
||
break;
|
||
case NAME_WINDOW_POSITION.RIGHT:
|
||
this.x = this._parentWindow.x;
|
||
this.x += (this._parentWindow.width * 7) / 10;
|
||
this.x -= this.width / 2;
|
||
break;
|
||
case NAME_WINDOW_POSITION.RIGHT_EDGE:
|
||
this.x = this._parentWindow.x + this._parentWindow.width;
|
||
this.x -= this.width;
|
||
this.x -= settings.windowOffsetX;
|
||
break;
|
||
}
|
||
this.x = this.x.clamp(0, Graphics.boxWidth - this.width);
|
||
}
|
||
|
||
adjustPositionY() {
|
||
const parentWindowY =
|
||
($gameMessage.positionType() * (Graphics.boxHeight - this._parentWindow.windowHeight())) / 2;
|
||
if ($gameMessage.positionType() === 0) {
|
||
this.y = parentWindowY + this._parentWindow.height;
|
||
this.y -= settings.windowOffsetY;
|
||
} else {
|
||
this.y = parentWindowY;
|
||
this.y -= this.height;
|
||
this.y += settings.windowOffsetY;
|
||
}
|
||
if (this.y < 0) {
|
||
this.y = parentWindowY + this._parentWindow.height;
|
||
this.y -= settings.windowOffsetY;
|
||
}
|
||
}
|
||
|
||
/**
|
||
* @return {boolean} 表示し続ける必要があるかどうか
|
||
*/
|
||
doesContinue() {
|
||
return this._parentWindow.doesContinue() && this._parentWindow.findNameWindowTextInfo($gameMessage.nextText());
|
||
}
|
||
|
||
isNameWindow() {
|
||
return true;
|
||
}
|
||
}
|
||
|
||
Window_Base.prototype.isNameWindow = function () {
|
||
return false;
|
||
};
|
||
|
||
/**
|
||
* @param {string} name
|
||
* @param {number} position
|
||
*/
|
||
Window_Message.prototype.showNameWindow = function (name, position) {
|
||
if (!this._isAlreadyShownNameWindow) {
|
||
this._nameWindow.show(name, position);
|
||
this._isAlreadyShownNameWindow = true;
|
||
}
|
||
};
|
||
|
||
const _Window_Message_startMessage = Window_Message.prototype.startMessage;
|
||
Window_Message.prototype.startMessage = function () {
|
||
this._nameWindowTextInfo = null;
|
||
_Window_Message_startMessage.call(this);
|
||
this._isAlreadyShownNameWindow = false;
|
||
if (this._nameWindowTextInfo) {
|
||
this.showNameWindow(this._nameWindowTextInfo.coloredName(), this._nameWindowTextInfo.position);
|
||
}
|
||
};
|
||
|
||
const _WindowMessage_terminateMessage = Window_Message.prototype.terminateMessage;
|
||
Window_Message.prototype.terminateMessage = function () {
|
||
this._nameWindow.startClose();
|
||
_WindowMessage_terminateMessage.call(this);
|
||
};
|
||
|
||
const _WindowMessage_createSubWindows = Window_Message.prototype.createSubWindows;
|
||
Window_Message.prototype.createSubWindows = function () {
|
||
_WindowMessage_createSubWindows.call(this);
|
||
this._nameWindow = new Window_SpeakerName(this);
|
||
};
|
||
|
||
const _Window_Message_subWindows = Window_Message.prototype.subWindows;
|
||
Window_Message.prototype.subWindows = function () {
|
||
return _Window_Message_subWindows.call(this).concat([this._nameWindow]);
|
||
};
|
||
|
||
const _Window_Message_hideSubWindow = Window_Message.prototype.hideSubWindow;
|
||
Window_Message.prototype.hideSubWindow = function (subWindow) {
|
||
if (subWindow.isNameWindow()) {
|
||
this._isAlreadyShownNameWindow = false;
|
||
}
|
||
_Window_Message_hideSubWindow.call(this, subWindow);
|
||
};
|
||
|
||
const _Window_Message_showSubWindow = Window_Message.prototype.showSubWindow;
|
||
Window_Message.prototype.showSubWindow = function (subWindow) {
|
||
if (subWindow.isNameWindow()) {
|
||
if (this._nameWindowTextInfo) {
|
||
this.showNameWindow(this._nameWindowTextInfo.coloredName(), this._nameWindowTextInfo.position);
|
||
}
|
||
} else {
|
||
_Window_Message_showSubWindow.call(this, subWindow);
|
||
}
|
||
};
|
||
|
||
Window_Message.prototype.convertEscapeCharacters = function (text) {
|
||
text = Window_Base.prototype.convertEscapeCharacters.call(this, text);
|
||
return this.convertNameWindow(text);
|
||
};
|
||
|
||
/**
|
||
* 指定したテキストの中から名前ウィンドウにすべき箇所を探す
|
||
*/
|
||
Window_Message.prototype.findNameWindowTextInfo = function (text) {
|
||
return NameWindowTextInfo.fromMessageText(text);
|
||
};
|
||
|
||
Window_Message.prototype.convertNameWindow = function (text) {
|
||
const nameWindowTextInfo = this.findNameWindowTextInfo(text);
|
||
if (nameWindowTextInfo) {
|
||
text = text.replace(nameWindowTextInfo.eraseTarget, '');
|
||
this._nameWindowTextInfo = nameWindowTextInfo;
|
||
}
|
||
return text;
|
||
};
|
||
|
||
Window_Message.prototype.hideNameWindow = function () {
|
||
this._nameWindow.hide();
|
||
};
|
||
|
||
Window_Message.prototype.hasNameWindow = function () {
|
||
return !!this._nameWindow;
|
||
};
|
||
|
||
Window_Message.prototype.isNameWindowVisible = function () {
|
||
return this._nameWindow && this._nameWindow.visible;
|
||
};
|
||
|
||
Window_Message.prototype.colorByName = function (name) {
|
||
return colorByName(name);
|
||
};
|
||
})();
|