//=============================================================================
// DestinationWindow.js
// ----------------------------------------------------------------------------
// (C)2017 Triacontane
// This software is released under the MIT License.
// http://opensource.org/licenses/mit-license.php
// ----------------------------------------------------------------------------
// Version
// 1.7.0 2021/02/11 制御文字\v[n]を使って描画したとき、変数値が変わると再描画されるよう修正
// 1.6.0 2019/06/24 特定マップで非表示にする機能を追加
// 1.5.0 2018/07/20 行動目標ウィンドウの内容を複数行表示できる機能を追加
// 1.4.0 2017/11/15 行動目標ウィンドウの文字列揃えを中央揃え、右揃えにできる機能を追加
// 1.3.0 2017/11/11 マップ画面のウィンドウを一定時間で消去できる機能を追加
// 1.2.1 2017/05/22 専用ウィンドウスキンを指定した状態でセーブ＆ロードした際にテキスト色が黒くなる問題を修正
// 1.2.0 2017/05/03 アイコン表示機能、横幅自動調整機能を追加、別の目標を指定したときに重なって表示される問題を修正
// 1.1.0 2017/05/02 メニュー画面にも表示できる機能を追加
// 1.0.0 2017/05/02 初版
// ----------------------------------------------------------------------------
// [Blog]   : https://triacontane.blogspot.jp/
// [Twitter]: https://twitter.com/triacontane/
// [GitHub] : https://github.com/triacontane/
//=============================================================================

/*:
@url https://triacontane.blogspot.com/
@plugindesc Action Objective Window Plugin
@author Triacontane
@license MIT License

@help
English Help Translator: munokura
This is an unofficial English translation of the plugin help,
created to support global RPG Maker users.
Feedback is welcome to improve translation quality
(see: https://github.com/munokura/triacontane-MV-plugins ).
Original plugin by Triacontane.
Please check the latest official version at:
https://triacontane.blogspot.com
-----

Displays the action goal window on the map.
You can display any text, including control characters, making it useful
for a variety of purposes.
The content displayed is controlled by the plugin command, and its display
is controlled by a switch.

When auto-adjustment is enabled, the text will automatically adjust if it
does not fit in the window.
However, the following control characters will be disabled:
\i[n], \c[n], \{, \}

To display a multi-line goal, insert a line break (\n) within the text.

Plugin Command Details
Execute from the "Plugin Command" event command.
(Parameters are separated by a space.)

DW_SET_DESTINATION aaa # Set the action goal to "aaa."note
DW_SET_DESTINATION_WITH_ICON 1 aaa # Set the action goal with icon [1].

The destination window will be hidden for maps that meet any of the
following conditions:
- The map has an ID specified in the plugin parameter
NoDestinationWindowMapIds
- The map's Note field contains <NoDestinationWindow>

Terms of Use:
You may modify and redistribute this plugin without permission from the
author, and there are no restrictions on its use (commercial, 18+, etc.).
This plugin is now yours.

@param ShowingSwitchId
@desc The switch ID that displays the action goal window.
@type switch
@default 1

@param CloseEventRunning
@desc Close the window while the event is running.
@type boolean
@default true

@param WindowX
@desc The X width of the window.
@type number
@default 24

@param WindowY
@desc The Y width of the window.
@type number
@default 24

@param WindowWidth
@desc The width of the window.
@type number
@default 320

@param WindowOpacity
@desc The window opacity.
@type number
@default 255

@param WindowSkin
@desc The file name of the window skin (img/system). No extension needed.
@type file
@require 1
@dir img/system/

@param FadeFrame
@desc The window fade-in and fade-out time (in frames).
@type number
@default 8

@param FontSize
@desc The window font size.
@type number
@default 22

@param ShowingInMenu
@desc The action goal window will also be displayed on the menu screen, but the coordinates and size will be adjusted automatically.
@type boolean
@default false

@param AutoAdjust
@desc If the specified string does not fit in the window, it will be automatically adjusted. However, some control characters cannot be used.
@type boolean
@default true

@param ShowingFrames
@desc The number of frames the behavior goal window will be displayed in. If you specify 0, it will be displayed at all times.
@type number
@default 0

@param TextAlign
@desc The alignment of the string.
@type select
@default 0
@option Left-justified
@value 0
@option Centered
@value 1
@option Right-justified
@value 2

@param NoDestinationWindowMapIds
@text Hidden Map List
@desc List of map IDs to hide
@type number[]
@default []
*/

/*:ja
@plugindesc 行動目標ウィンドウプラグイン
@author トリアコンタン

@param 表示スイッチID
@desc 行動目標ウィンドウが表示されるスイッチIDです。
@default 1
@type switch

@param イベント中は閉じる
@desc イベントが実行されている間はウィンドウを閉じます。
@default true
@type boolean

@param ウィンドウX座標
@desc ウィンドウのX横幅です。
@default 24
@type number

@param ウィンドウY座標
@desc ウィンドウのY横幅です。
@default 24
@type number

@param ウィンドウ横幅
@desc ウィンドウの横幅です。
@default 320
@type number

@param ウィンドウ不透明度
@desc ウィンドウの不透明度です。
@default 255
@type number

@param ウィンドウスキン名
@desc ウィンドウスキンのファイル名(img/system)です。拡張子不要。
@default
@require 1
@dir img/system/
@type file

@param フェード時間
@desc ウィンドウのフェードイン、フェードアウト時間(フレーム数)です。
@default 8
@type number

@param フォントサイズ
@desc ウィンドウのフォントサイズです。
@default 22
@type number

@param メニュー画面に表示
@desc 行動目標ウィンドウをメニュー画面にも表示します。ただし座標やサイズは自働で整形されます。
@default false
@type boolean

@param 自働調整
@desc 指定した文字列がウィンドウに収まらない場合に自働で調整します。ただし一部の制御文字が使用不可となります。
@default true
@type boolean

@param 表示フレーム数
@desc 行動目標ウィンドウの表示フレーム数です。0を指定すると常時表示されます。
@default 0
@type number

@param 文字列揃え
@desc 文字列の揃えです。
@default 0
@type select
@option 左揃え
@value 0
@option 中央揃え
@value 1
@option 右揃え
@value 2

@param NoDestinationWindowMapIds
@text 非表示マップリスト
@desc 非表示にしたいマップIDリスト
@default []
@type number[]

@help マップ中に行動目標ウィンドウを表示します。
制御文字を含めた好きな文字列を表示できるので様々な用途に使えます。
表示する内容はプラグインコマンドで、表示可否はスイッチで制御します。

自動調整を有効にした場合、文字列がウィンドウに収まらない場合に自働で調整します。
ただし、以下の制御文字が無効になります。
\i[n]、\c[n]、\{、\}

複数行の目標を表示したい場合は、文章中に改行「\n」を挿入してください。

プラグインコマンド詳細
 イベントコマンド「プラグインコマンド」から実行。
 （パラメータの間は半角スペースで区切る）

DW_目標設定 aaa                    # 行動目標を「aaa」に設定します。
DW_SET_DESTINATION aaa             # 同上
DW_アイコン付き目標設定 1 aaa      # アイコン[1]付きで行動目標設定。
DW_SET_DESTINATION_WITH_ICON 1 aaa # 同上

以下のいずれかの条件を満たすマップでは、行動目標ウィンドウは非表示になります。
- プラグインパラメータ NoDestinationWindowMapIds で指定したIDをを持つ
- マップのメモ欄に <NoDestinationWindow> と記述されている

利用規約：
 作者に無断で改変、再配布が可能で、利用形態（商用、18禁利用等）
 についても制限はありません。
 このプラグインはもうあなたのものです。
*/

(function () {
    'use strict';
    var pluginName = 'DestinationWindow';
    var metaTagPrefix = 'DW_';

    //=============================================================================
    // ローカル関数
    //  プラグインパラメータやプラグインコマンドパラメータの整形やチェックをします
    //=============================================================================
    var getParamString = function (paramNames) {
        if (!Array.isArray(paramNames)) paramNames = [paramNames];
        for (var i = 0; i < paramNames.length; i++) {
            var name = PluginManager.parameters(pluginName)[paramNames[i]];
            if (name) return name;
        }
        return '';
    };

    var getParamNumber = function (paramNames, min, max) {
        var value = getParamString(paramNames);
        if (arguments.length < 2) min = -Infinity;
        if (arguments.length < 3) max = Infinity;
        return (parseInt(value) || 0).clamp(min, max);
    };

    var getParamBoolean = function (paramNames) {
        var value = getParamString(paramNames);
        return value.toUpperCase() === 'ON' || value.toUpperCase() === 'TRUE';
    };

    var getParamNumberArray = function (paramNames) {
        var value = PluginManager.parameters(pluginName)[paramNames];
        return JSON.parse(value)
            .map(function (e) { return Number(JSON.parse(e)); }, this);
    };

    var getArgNumber = function (arg, min, max) {
        if (arguments.length < 2) min = -Infinity;
        if (arguments.length < 3) max = Infinity;
        return (parseInt(arg) || 0).clamp(min, max);
    };

    var concatAllArguments = function (args) {
        return args.reduce(function (prevValue, arg) {
            return prevValue + ' ' + arg;
        }, '').replace(/^ /, '');
    };

    var setPluginCommand = function (commandName, methodName) {
        pluginCommandMap.set(metaTagPrefix + commandName, methodName);
    };

    //=============================================================================
    // パラメータの取得と整形
    //=============================================================================
    var param = {};
    param.showingSwitchId = getParamNumber(['ShowingSwitchId', '表示スイッチID'], 0);
    param.windowX = getParamNumber(['WindowX', 'ウィンドウX座標']);
    param.windowY = getParamNumber(['WindowY', 'ウィンドウY座標']);
    param.windowWidth = getParamNumber(['WindowWidth', 'ウィンドウ横幅'], 1);
    param.windowSkin = getParamString(['WindowSkin', 'ウィンドウスキン名']);
    param.windowOpacity = getParamNumber(['WindowOpacity', 'ウィンドウ不透明度']);
    param.fadeFrame = getParamNumber(['FadeFrame', 'フェード時間'], 1);
    param.fontSize = getParamNumber(['FontSize', 'フォントサイズ'], 12);
    param.closeEventRunning = getParamBoolean(['CloseEventRunning', 'イベント中は閉じる']);
    param.showingInMenu = getParamBoolean(['ShowingInMenu', 'メニュー画面に表示']);
    param.autoAdjust = getParamBoolean(['AutoAdjust', '自働調整']);
    param.showingFrames = getParamNumber(['ShowingFrames', '表示フレーム数'], 0);
    param.textAlign = getParamNumber(['TextAlign', '文字列揃え'], 0);
    param.noDestinationWindowMapIds = getParamNumberArray(['NoDestinationWindowMapIds']);

    var pluginCommandMap = new Map();
    setPluginCommand('目標設定', 'execSetDestination');
    setPluginCommand('SET_DESTINATION', 'execSetDestination');
    setPluginCommand('アイコン付き目標設定', 'execSetDestinationWithIcon');
    setPluginCommand('SET_DESTINATION_WITH_ICON', 'execSetDestinationWithIcon');

    var _extractMetadata = DataManager.extractMetadata;
    DataManager.extractMetadata = function (data) {
        _extractMetadata.call(this, data);
        if (data === $dataMap) {
            if (data.meta.noDestinationWindow) {
                data.noDestinationWindow = true;
            } else {
                data.noDestinationWindow = false;
            }
        }
    };

    //=============================================================================
    // Game_Interpreter
    //  プラグインコマンドを追加定義します。
    //=============================================================================
    var _Game_Interpreter_pluginCommand = Game_Interpreter.prototype.pluginCommand;
    Game_Interpreter.prototype.pluginCommand = function (command, args) {
        _Game_Interpreter_pluginCommand.apply(this, arguments);
        var pluginCommandMethod = pluginCommandMap.get(command.toUpperCase());
        if (pluginCommandMethod) {
            this[pluginCommandMethod](args);
        }
    };

    Game_Interpreter.prototype.execSetDestination = function (args) {
        $gameSystem.setDestinationIcon(null);
        $gameSystem.setDestination(concatAllArguments(args));
    };

    Game_Interpreter.prototype.execSetDestinationWithIcon = function (args) {
        var icon = args.shift();
        $gameSystem.setDestinationIcon(icon);
        $gameSystem.setDestination(concatAllArguments(args));
    };

    //=============================================================================
    // Game_System
    //  目標テキストを追加定義します。
    //=============================================================================
    Game_System.prototype.setDestination = function (value) {
        this._destinationTextList = value.split('\\n');
        this.resetDestinationFrame();
    };

    Game_System.prototype.getDestination = function () {
        return this._destinationTextList || [];
    };

    Game_System.prototype.setDestinationIcon = function (value) {
        this._destinationIconIndex = value;
    };

    Game_System.prototype.getDestinationIcon = function () {
        return this._destinationIconIndex || '';
    };

    Game_System.prototype.resetDestinationFrame = function () {
        this._destinationFrame = 0;
    };

    Game_System.prototype.isOverDestinationFrame = function () {
        this._destinationFrame++;
        return param.showingFrames > 0 ? param.showingFrames <= this._destinationFrame : false;
    };

    //=============================================================================
    // Game_Map
    //  行動目標ウィンドウ非表示マップであるかを判定します。
    //=============================================================================
    Game_Map.prototype.isNoDestinationWindowMap = function () {
        return param.noDestinationWindowMapIds.some(function (mapId) {
            return mapId === this.mapId();
        }, this) || $dataMap.noDestinationWindow;
    };

    //=============================================================================
    // Scene_Map
    //  行動目標ウィンドウを生成します。
    //=============================================================================
    var _Scene_Map_createMapNameWindow = Scene_Map.prototype.createMapNameWindow;
    Scene_Map.prototype.createMapNameWindow = function () {
        this.createDestinationWindow();
        _Scene_Map_createMapNameWindow.apply(this, arguments);
    };

    Scene_Map.prototype.createDestinationWindow = function () {
        this._destinationWindow = new Window_Destination(param.windowX, param.windowY, param.windowWidth);
        this.addChild(this._destinationWindow);
    };

    //=============================================================================
    // Scene_Menu
    //  メニュー画面にも表示できるようにします。
    //=============================================================================
    var _Scene_Menu_create = Scene_Menu.prototype.create;
    Scene_Menu.prototype.create = function () {
        _Scene_Menu_create.apply(this, arguments);
        if (param.showingInMenu) {
            this.createDestinationWindow();
        }
    };

    Scene_Menu.prototype.createDestinationWindow = function () {
        var y, width, height;
        if (this._commandWindow.maxCols() === 1) {
            y = this._commandWindow.y + this._commandWindow.height;
            width = this._commandWindow.width;
            height = null;
        } else {
            y = this._goldWindow.y;
            width = param.windowWidth;
            height = this._goldWindow.height;
        }
        this._destinationWindow = new Window_DestinationMenu(0, y, width, height);
        this.addWindow(this._destinationWindow);
    };

    //=============================================================================
    // Window_Destination
    //  行動目標ウィンドウです。
    //=============================================================================
    function Window_Destination() {
        this.initialize.apply(this, arguments);
    }

    Window_Destination.prototype = Object.create(Window_Base.prototype);
    Window_Destination.prototype.constructor = Window_Destination;

    Window_Destination.prototype.initialize = function (x, y, width, height) {
        Window_Base.prototype.initialize.call(this, x, y, width, height || this.fittingHeight(1));
        this._text = '';
        this._textList = [];
        this._iconIndex = 0;
        this.update();
        this.opacity = this.isVisible() ? 255 : 0;
    };

    Window_Destination.prototype.loadWindowskin = function () {
        if (param.windowSkin) {
            this.windowskin = ImageManager.loadSystem(param.windowSkin);
        } else {
            Window_Base.prototype.loadWindowskin.call(this);
        }
    };

    Window_Destination.prototype.lineHeight = function () {
        return Math.max(this.standardFontSize() + 8, Window_Base._iconHeight);
    };

    Window_Destination.prototype.standardFontSize = function () {
        return param.fontSize || Window_Base.prototype.standardFontSize.call(this);
    };

    Window_Destination.prototype.standardBackOpacity = function () {
        return param.windowOpacity || Window_Base.prototype.standardBackOpacity.call(this);
    };

    Window_Destination.prototype.standardPadding = function () {
        return 12;
    };

    Window_Destination.prototype.update = function () {
        Window_Base.prototype.update.call(this);
        if (!this.windowskin.isReady()) return;
        this.updateText();
        this.updateOpacity();
    };

    Window_Destination.prototype.updateOpacity = function () {
        if (this.isVisible()) {
            this.setOpacity(this.opacity + this.getFadeValue());
        } else {
            this.setOpacity(this.opacity - this.getFadeValue());
        }
        this.visible = (this.opacity > 0);
    };

    Window_Destination.prototype.updateText = function () {
        var textList = $gameSystem.getDestination();
        var iconIndex = getArgNumber(this.convertEscapeCharacters($gameSystem.getDestinationIcon()), 0);
        if (textList.length !== this._textList.length) {
            this.height = this.fittingHeight(textList.length);
            this.createContents();
            this._textList = [];
        }
        textList.forEach(function (text, index) {
            text = this.convertEscapeCharacters(text);
            if (this._textList[index] === text && this._iconIndex === iconIndex) {
                return;
            }
            this._textList[index] = text;
            this._text = text;
            this._iconIndex = iconIndex;
            this.drawDestination(index);
        }, this);
    };

    Window_Destination.prototype.drawDestination = function (lineNumber) {
        this.contents.clearRect(0, lineNumber * this.lineHeight(), this.contentsWidth(), this.lineHeight());
        var x = this.getContentsX();
        var y = lineNumber * this.lineHeight() + this.lineHeight() / 2 - this.contents.fontSize / 2 - 4;
        if (this._iconIndex > 0 && lineNumber === 0) {
            this.drawIcon(this._iconIndex, x, y);
            x += Window_Base._iconWidth;
        }
        if (param.autoAdjust) {
            this.resetTextColor();
            this.drawText(this._text, x, y, this.contentsWidth() - x);
        } else {
            this.drawTextEx(this._text, x, y);
        }
    };

    Window_Destination.prototype.getContentsX = function () {
        if (param.textAlign === 0) {
            return 0;
        }
        var width = param.autoAdjust ? this.textWidth(this._text) : this.drawTextEx(this._text, 0, -this.lineHeight());
        if (this._iconIndex > 0) {
            width += Window_Base._iconWidth;
        }
        var division = (param.textAlign === 1 ? 2 : 1);
        return this.contentsWidth() / division - width / division;
    };

    Window_Destination.prototype.setOpacity = function (value) {
        this.opacity = value;
        this.contentsOpacity = value;
    };

    Window_Destination.prototype.getFadeValue = function () {
        return 255 / param.fadeFrame;
    };

    Window_Destination.prototype.isVisible = function () {
        return $gameSwitches.value(param.showingSwitchId) && !this.isEventRunning() &&
            this.isExistText() && !this.isOverFrame() && !this.isNoDestinationWindowMap();
    };

    Window_Destination.prototype.isOverFrame = function () {
        return $gameSystem.isOverDestinationFrame();
    };

    Window_Destination.prototype.isExistText = function () {
        return this._textList.length > 0 || !!this._iconIndex;
    };

    Window_Destination.prototype.isEventRunning = function () {
        return $gameMap.isEventRunning() && param.closeEventRunning;
    };

    Window_Destination.prototype.isNoDestinationWindowMap = function () {
        return $gameMap.isNoDestinationWindowMap();
    };

    //=============================================================================
    // Window_DestinationMenu
    //  メニュー画面の行動目標ウィンドウです。
    //=============================================================================
    function Window_DestinationMenu() {
        this.initialize.apply(this, arguments);
    }

    Window_DestinationMenu.prototype = Object.create(Window_Destination.prototype);
    Window_DestinationMenu.prototype.constructor = Window_DestinationMenu;

    Window_DestinationMenu.prototype.isOverFrame = function () {
        return false;
    };
})();