//=============================================================================
// Lunatlazur_MessageAttachmentButton.js
// ----------------------------------------------------------------------------
// Copyright (c) 2018 Taku Aoi
// This plugin is released under the zlib License.
// https://zlib.net/zlib_license.html
// ----------------------------------------------------------------------------
// Version
// 1.0.0 2018-04-01
// ----------------------------------------------------------------------------
// [Web] : https://lunatlazur.com
// [Twitter]: https://twitter.com/aoitaku
// [GitHub] : https://github.com/lunatlazur
//=============================================================================
/*:
* @plugindesc Functional button on message window
* @author Taku Aoi
* @help This plugin adds some functional button to the message window.
*
* Usage
* =====
*
* Command parameters
* ------------------
*
* In case that the command is 'scene':
*
* By passing the "XXX" part of "Scene_XXX" (for example, Save, Load, Menu,
* Title etc) as parameter, you can make transition to the corresponding scene
* when button is pressed.
*
* In case that the command is 'plugin':
*
* By passing the plug-in command name and arguments as parameter, you can
* execute the corresponding plug-in command when the button is pressed.
*
*
* Changelog
* =========
*
* 1.0.0 2018-04-01
* ----------------
* - Published.
*
*
* @param Custom button text font
* @desc Additional button text fonts.
* @type string[]
* @default ["Calibri","Geneva"]
*
* @param Button
* @desc Configure the buttons attached to the message window.
* @type struct[]
* @default ["{\"text\":\"Save\",\"command\":\"scene\",\"parameters\":\"save\"}","{\"text\":\"Load\",\"command\":\"scene\",\"parameters\":\"load\"}"]
*/
/*~struct~button:en
* @param text
* @desc text for button.
*
* @param command
* @desc command to be called when button pressed.
* @type select
*
* @option scene
* @value scene
*
* @option plugin command
* @value plugin
*
* @param parameters
* @desc parameters for command. see help for detail.
*/
/*:ja
* @plugindesc メッセージウィンドウ拡張ボタンプラグイン
* @author あおいたく
* @help このプラグインはメッセージウィンドウに任意の機能を実行するためのボタンを
* 追加します。
*
* 使い方
* ======
*
* コマンドのパラメータについて
* ----------------------------
*
* command が scene のとき…
*
* パラメータにScene_XXX の XXX の部分（Save, Load, Menu, Title など）を
* 指定することで、ボタンを押したときに該当のシーンに遷移させることができます。
*
*
* command が plugin のとき…
*
* パラメータにプラグインコマンド名とパラメータを指定することで、ボタンを
* 押したときに該当のプラグインコマンドを実行することができます。
*
*
* 変更履歴
* ========
*
* 1.0.0 2018-04-01
* ----------------
* - 公開
*
*
* @param フォント
* @desc 追加のフォントを指定できます。先頭にあるものが優先して読み込まれます。
* @type string[]
* @default ["UD デジタル 教科書体 NP-R","Klee"]
*
* @param ボタン
* @desc メッセージウィンドウに表示するボタンを設定します。
* @type struct []
* @default ["{\"text\":\"セーブ\",\"command\":\"scene\",\"parameters\":\"save\"}","{\"text\":\"ロード\",\"command\":\"scene\",\"parameters\":\"load\"}"]
*/
/*~struct~button:ja
* @param text
* @desc ボタンに表示するテキスト。
*
* @param command
* @desc ボタンを押したときに実行するコマンド。
* @type select
*
* @option シーン遷移
* @value scene
*
* @option プラグインコマンド
* @value plugin
*
* @param parameters
* @desc コマンドのパラメータを指定します。
* 詳細はプラグインヘルプを参照してください。
*/
(function () {
'use strict';
const pluginName = 'Lunatlazur_MessageAttachmentButton';
const attachmentButtonSize = 20;
function getValue(params, ...names) {
let found = null;
names.forEach((name) => {
if (!!params[name]) {
found = params[name];
}
});
return found;
}
const asString = getValue;
function parsePluginParameters() {
const parameters = PluginManager.parameters(pluginName);
const buttons = parameters['ボタン'] || parameters.buttons;
if (!buttons) {
return [];
}
const rawItems = JSON.parse(buttons);
return rawItems.map((rawItem) => JSON.parse(rawItem));
}
const buttonSettings = parsePluginParameters().map((button) => {
switch (button.command) {
case 'scene':
const sceneName = button.parameters.charAt(0).toUpperCase() + button.parameters.slice(1).toLowerCase();
const scene = window[`Scene_${sceneName}`];
if (!scene) {
console.error(`Scene_${sceneName} は存在しないシーンです`);
return;
}
return {
text: button.text,
command() {
SceneManager.push(scene);
}
};
case 'plugin':
return {
text: button.text,
command(interpreter) {
const [name, ...args] = button.parameters.split(" ");
interpreter.pluginCommand(name, args);
}
};
}
});
const customButtonTextFont = JSON.parse(asString(PluginManager.parameters(pluginName), 'フォント', 'Custom button text font'));
const _Window_Message_windowHeight = Window_Message.prototype.windowHeight;
Window_Message.prototype.windowHeight = function () {
return _Window_Message_windowHeight.call(this) + attachmentButtonSize - this.standardPadding() / 2;
};
const _Window_Message_initMembers = Window_Message.prototype.initMembers;
Window_Message.prototype.initMembers = function () {
this._attachmentButtonManager = new AttachmentButtonManager;
_Window_Message_initMembers.call(this);
};
const _Window_Message_show = Window_Message.prototype.show;
Window_Message.prototype.show = function () {
_Window_Message_show.call(this);
this._attachmentButtonManager.handleShow();
};
const _Window_Message_hide = Window_Message.prototype.hide;
Window_Message.prototype.hide = function () {
_Window_Message_hide.call(this);
this._attachmentButtonManager.handleHide();
};
const _Window_Message_update = Window_Message.prototype.update;
Window_Message.prototype.update = function () {
if (this._attachmentButtonManager.isButtonAvailable) {
this._attachmentButtonManager.handleOpennessChanged(this.isOpen(), this.x, this.y, this.width, this.height);
}
_Window_Message_update.call(this);
};
TouchInput._onMouseMove = function (event) {
const x = Graphics.pageToCanvasX(event.pageX);
const y = Graphics.pageToCanvasY(event.pageY);
this._onMove(x, y);
};
const _Window_Message_updateInput = Window_Message.prototype.updateInput;
Window_Message.prototype.updateInput = function () {
if (this._attachmentButtonManager.isButtonAvailable && _Window_Message_isButtonTouched.call(this)) {
return true;
}
_Window_Message_updateMouseMove.call(this);
return _Window_Message_updateInput.apply(this, arguments);
};
function _Window_Message_updateMouseMove() {
if (TouchInput.isMoved()) {
this._attachmentButtonManager.handleMouseMove();
}
}
const _Window_Message_updateBackground = Window_Message.prototype.updateBackground;
Window_Message.prototype.updateBackground = function () {
_Window_Message_updateBackground.call(this);
if (this._background === 0) {
this._attachmentButtonManager.enableButton();
}
else {
this._attachmentButtonManager.disableButton();
}
};
function _Window_Message_isButtonTouched() {
if (this.isOpen() && this.active && TouchInput.isTriggered()) {
const button = this._attachmentButtonManager.triggeredButton();
if (button) {
button.exec();
return true;
}
}
return false;
}
const _Window_Message_drawMessageFace = Window_Message.prototype.drawMessageFace;
Window_Message.prototype.drawMessageFace = function () {
if (this._attachmentButtonManager.isButtonAvailable) {
const offsetY = (this.contentsHeight() - Window_Base._faceHeight) / 2;
this.drawFace($gameMessage.faceName(), $gameMessage.faceIndex(), 0, offsetY);
ImageManager.releaseReservation(this._imageReservationId);
}
else {
_Window_Message_drawMessageFace.call(this);
}
};
function find(items, predicate) {
let found;
items.forEach((item) => {
if (predicate(item)) {
found = item;
}
});
return found;
}
class AttachmentButton {
constructor(text, size) {
this._fontSize = size ? size : 28;
this._text = text;
const bitmap = new Bitmap(this._fontSize, this._fontSize);
bitmap.fontFace = [...customButtonTextFont, 'GameFont'].join(',');
bitmap.fontSize = this._fontSize;
bitmap.textColor = '#aaaaaa';
bitmap.resize(bitmap.measureTextWidth(text), bitmap.height);
bitmap.drawText(this._text, 0, 0, bitmap.width, this._fontSize);
this._sprite = new Sprite(bitmap);
this._sprite.x = 0;
this._sprite.y = 0;
this._sprite.visible = false;
SceneManager._scene.addChild(this._sprite);
}
get x() {
return this._sprite.x;
}
set x(x) {
this._sprite.x = x;
}
get y() {
return this._sprite.y;
}
set y(y) {
this._sprite.y = y;
}
get width() {
return this._sprite.width;
}
get height() {
return this._sprite.height;
}
hide() {
this._sprite.visible = false;
}
show() {
this._sprite.visible = true;
}
setPosition(x, y) {
this.x = x;
this.y = y;
}
isPointInside(x, y) {
return !!(x >= this.x && x < this.x + this.width && y >= this.y && y < this.y + this.height);
}
attachFunction(func) {
this._func = func;
}
isVisible() {
return !!this._sprite.visible;
}
isTouchable() {
return !!(this.isVisible() && this.width > 0);
}
exec() {
this._func($gameMap._interpreter);
}
onMouseOver() {
this._sprite.bitmap.clear();
this._sprite.bitmap.textColor = '#ffffff';
this._sprite.bitmap.drawText(this._text, 0, 0, this._sprite.bitmap.width, this._fontSize);
}
onMouseLeave() {
this._sprite.bitmap.clear();
this._sprite.bitmap.textColor = '#aaaaaa';
this._sprite.bitmap.drawText(this._text, 0, 0, this._sprite.bitmap.width, this._fontSize);
}
}
class AttachmentButtonManager {
constructor() {
this._buttons = buttonSettings.map((setting) => {
const button = new AttachmentButton(setting.text, attachmentButtonSize);
button.attachFunction(setting.command);
return button;
});
this._isOpened = false;
this._isButtonAvailable = false;
}
get isOpened() {
return this._isOpened;
}
get isButtonAvailable() {
return this._isButtonAvailable;
}
enableButton() {
this._isButtonAvailable = true;
}
disableButton() {
this._isButtonAvailable = false;
}
handleMouseMove() {
if (this.isButtonAvailable) {
const selectedButton = this.selectedButton();
if (selectedButton) {
if (selectedButton !== this._lastSelectedButton) {
if (this._lastSelectedButton) {
this._lastSelectedButton.onMouseLeave();
}
selectedButton.onMouseOver();
this._lastSelectedButton = selectedButton;
}
}
else {
if (this._lastSelectedButton) {
this._lastSelectedButton.onMouseLeave();
this._lastSelectedButton = null;
}
}
}
}
handleShow() {
if (this.isButtonAvailable) {
this._buttons.forEach((button) => button.show());
}
}
handleHide() {
if (this.isButtonAvailable) {
this._buttons.forEach((button) => button.hide());
}
}
handleOpennessChanged(opened, x, y, width, height) {
if (!this.isButtonAvailable) {
return;
}
if (opened) {
if (!this.isOpened) {
this.handleOpened(x, y, width, height);
}
}
else {
if (this.isOpened) {
this.handleClosing();
}
}
}
handleOpened(x, y, width, height) {
this._isOpened = true;
if (this.isButtonAvailable) {
let right = width;
for (let i = this._buttons.length - 1; i >= 0; i--) {
const button = this._buttons[i];
button.setPosition(right - button.width - 8, y + height - button.height - 8);
if (button.isPointInside(TouchInput.x, TouchInput.y)) {
this._lastSelectedButton = button;
button.onMouseOver();
}
right -= button.width + 16;
button.show();
}
}
}
handleClosing() {
this._isOpened = false;
if (this.isButtonAvailable) {
this._buttons.forEach((button) => button.hide());
}
}
triggeredButton() {
if (this.isButtonAvailable) {
return this.selectedButton();
}
return null;
}
selectedButton() {
return find(this._buttons, (button) => {
return button.isTouchable() && button.isPointInside(TouchInput.x, TouchInput.y);
});
}
}
}());
