//=============================================================================
// MapNameExtend.js
// ----------------------------------------------------------------------------
// (C)2017 Triacontane
// This software is released under the MIT License.
// http://opensource.org/licenses/mit-license.php
// ----------------------------------------------------------------------------
// Version
// 1.9.0 2025/01/13 メッセージ表示中もマップ名を表示したままにしておける設定を追加
// 1.8.0 2024/05/26 総フレーム数をInfinityにしているとき、スイッチやイベント実行を条件にマップ名を一時的に非表示にできる機能を追加
// 1.7.0 2023/10/18 マップ名の表示フォーマットを指定できる機能を追加
// 1.6.0 2023/10/16 マップ名の表示をセンタリングする機能を追加
//                  背景画像もウィンドウも指定しない場合は、通常の黒背景でマップ表示できるよう修正
// 1.5.0 2022/11/13 同じマップ名を連続して表示しないようにする設定を追加
// 1.4.1 2022/10/13 総フレーム数をInfinityにしたとき、メッセージ表示と共にマップ名がフェードアウトしてしまう問題を修正
// 1.4.0 2022/07/30 マップ名ウィンドウの高さを指定できる機能を追加
// 1.3.4 2022/01/14 表示遅延を設定しかつ背景画像を指定したとき、背景画像がマップ名表示前に表示されてしまう問題を修正
// 1.3.3 2021/11/05 実名表示が無効な場合でも、表示名が空だと表示されてしまう問題を修正
// 1.3.2 2021/11/04 背景画像を指定したとき、メニューを閉じた時などに背景が一瞬表示される問題を修正
// 1.3.1 2021/06/26 マップ名ウィンドウの横幅設定が機能していなかった問題を修正
// 1.3.0 2021/06/25 MZ向けに再作成
// 1.2.0 2019/11/18 総フレーム数にInfinityを設定した場合の挙動を自然なものに変更
//                  遅延機能をイベントコマンドの「マップ名表示」をONにした場合にも適用されるよう修正
// 1.1.0 2019/11/17 マップ名表示を指定したフレーム数だけ遅延させる機能を追加
// 1.0.1 2017/04/06 イベントテストを実行すると、数秒経過後にエラーが発生する問題の修正
// 1.0.0 2017/03/20 MapNameWindow.jsから流用作成
// ----------------------------------------------------------------------------
// [Blog]   : https://triacontane.blogspot.jp/
// [Twitter]: https://twitter.com/triacontane/
// [GitHub] : https://github.com/triacontane/
//=============================================================================

/*:
@target MZ
@url https://github.com/triacontane/RPGMakerMV/tree/mz_master/MapNameExtend.js
@plugindesc Map name display extension 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-MZ-plugins ).
Original plugin by Triacontane.
Please check the latest official version at:
https://triacontane.blogspot.com
-----

MapNameExtend.js

Extends the map name display function.

Feature List
1. You can make the map background a window or change it to a custom picture.
2. You can specify detailed settings such as display position, movement
method, and fade speed.
3. You can use control characters in map names.
4. You can display two or more map names consecutively.
5. You can display map names as their "real names" in the editor tree view.

To use feature 4, enter the following in the map name memo field:
<MapName2:aaa> # "aaa" will be added after the map name.
<MapName2:aaa> # Same as above.
* If you want to display three or more maps, use "<MNE_MapName3:aaa>".

This plugin requires the base plugin "PluginCommonBase.js."
"PluginCommonBase.js" is located in the following folder
under the RPG Maker MZ installation folder:
dlc/BasicResources/plugins/official

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 positionX
@text X coordinate
@desc Enter the X coordinate if you want to specify it.
@type number
@default 0

@param positionY
@text Y coordinate
@desc Enter the Y coordinate if you want to specify it.
@type number
@default 0

@param centering
@text centering
@desc The map name is displayed in the center of the screen.
@type boolean
@default false

@param moveXInFade
@text Move X during fade
@desc The number of pixels to move in the X direction during the fade in/out.
@type number
@default 0

@param moveYInFace
@text Move Y during fade
@desc The number of pixels to move in the Y direction during the fade in or out.
@type number
@default 0

@param allDuration
@text Total number of frames
@desc The total number of frames until the map name is displayed and disappears. If you want it to be displayed forever, enter "Infinity".
@type number
@default 300
@min 1

@param fadeInSpeed
@text Fade-in Speed
@desc Map name fade-in speed (default 16)
@type number
@default 0

@param viewDelay
@text Display Delay
@desc Delays the display of the map name by the specified number of frames.
@type number
@default 0

@param width
@text Width
@desc Enter the width if you want to specify it.
@type number
@default 0

@param height
@text height
@desc Enter the height if you want to specify it.
@type number
@default 0

@param showWindow
@text Window Display
@desc Window the map name display.
@type boolean
@default false

@param backgroundImage
@text background image
@desc Specify the file name of the dedicated background image (img/pictures). No extension required.
@type file
@require 1
@dir img/pictures/

@param showReal
@text Real name display
@desc If the editor's "Display Name" is not specified, the map name will be displayed as the "Real Name" displayed in the tree.
@type boolean
@default false

@param mapNameFormat
@text Map Name Format
@desc Display format of map name. Various control characters can be used. %1 will be replaced with the map name.
@type string

@param useControlCharacter
@text Use of control characters
@desc Enables the use of control characters in map name display. The function to automatically adjust the map name display width is disabled and the map name is forced to be left-justified.
@type boolean
@default false

@param noSameNameDisplay
@text Do not output the same map name
@desc When moving to a new location, if the map display name is the same as the map before moving, the map name will not be output.
@type boolean
@default false

@param hideSwitch
@text Hidden Switch
@desc If the total number of frames is set to Infinity, the map name will be hidden when the specified switch is ON.
@type switch
@default 0

@param hideInEventRunning
@text Not displayed during event execution
@desc If the total number of frames is set to Infinity, the map name will be hidden while the event is running.
@type boolean
@default false

@param showOnMessage
@text Displayed even when a message is displayed
@desc The map name will be displayed even while the message window is displayed (it will be automatically hidden by default).
@type boolean
@default false
*/

/*:ja
@plugindesc マップ名表示拡張プラグイン
@target MZ
@url https://github.com/triacontane/RPGMakerMV/tree/mz_master/MapNameExtend.js
@base PluginCommonBase
@orderAfter PluginCommonBase
@author トリアコンタン

@param positionX
@text X座標
@desc X座標を指定する場合は入力してください。
@default 0
@type number

@param positionY
@text Y座標
@desc Y座標を指定する場合は入力してください。
@default 0
@type number

@param centering
@text センタリング
@desc マップ名を画面中央に表示します。
@default false
@type boolean

@param moveXInFade
@text フェード中移動X
@desc フェードイン、アウト中に移動するX方向のピクセル数です。
@default 0
@type number

@param moveYInFace
@text フェード中移動Y
@desc フェードイン、アウト中に移動するY方向のピクセル数です。
@default 0
@type number

@param allDuration
@text 総フレーム数
@desc マップ名が表示されて消えるまでの総フレーム数です。ずっと表示させたい場合「Infinity」と入力してください。
@default 300
@type number
@min 1

@param fadeInSpeed
@text フェードイン速度
@desc マップ名のフェードイン速度です。（デフォルト16）
@default 0
@type number

@param viewDelay
@text 表示遅延
@desc マップ名の表示を指定したフレーム数だけ遅らせます。
@default 0
@type number

@param width
@text 横幅
@desc 横幅を指定する場合は入力してください。
@default 0
@type number

@param height
@text 高さ
@desc 高さを指定する場合は入力してください。
@default 0
@type number

@param showWindow
@text ウィンドウ表示
@desc マップ名表示をウィンドウ化します。
@default false
@type boolean

@param backgroundImage
@text 背景画像
@desc 専用の背景画像(img/pictures)のファイル名を指定します。拡張子不要。
@default
@require 1
@dir img/pictures/
@type file

@param showReal
@text 実名表示
@desc エディタの「表示名」が未指定の場合、ツリー表示される「実名」でマップ名を表示します。
@default false
@type boolean

@param mapNameFormat
@text マップ名フォーマット
@desc マップ名の表示フォーマットです。各種制御文字が使えます。%1でマップ名に置き換わります。
@default
@type string

@param useControlCharacter
@text 制御文字使用
@desc マップ名表示に制御文字を使用可能にします。マップ名の表示幅を自動調整する機能は無効になり、強制左揃えになります。
@default false
@type boolean

@param noSameNameDisplay
@text 同じマップ名は出力しない
@desc 場所移動時、マップ表示名が移動前のマップと同じ場合はマップ名を出力しません。
@default false
@type boolean

@param hideSwitch
@text 非表示スイッチ
@desc 総フレーム数をInfinityにしている場合に、指定したスイッチがONのときマップ名を非表示にします。
@default 0
@type switch

@param hideInEventRunning
@text イベント実行中非表示
@desc 総フレーム数をInfinityにしている場合に、イベント実行中はマップ名を非表示にします。
@default false
@type boolean


@param showOnMessage
@text メッセージ表示中も表示
@desc メッセージウィンドウが表示されている間もマップ名を表示します。(デフォルト仕様では自動で非表示になります)
@default false
@type boolean

@help MapNameExtend.js

マップ名表示機能を拡張します。

機能一覧
1. マップ背景をウィンドウ化したり、任意のピクチャに変えたりできます。
2. 表示位置や移動方法、フェード速度などを細かく指定できます。
3. マップ名に制御文字を使えるようになります。
4. 二つの以上のマップ名を連続で表示できます。
5. マップ名をエディタでツリー表示される「実名」で表示できます。

4.の機能を利用する場合、マップ名のメモ欄に以下の通り入力してください。
<MapName2:aaa>  # マップ名の表示後に「aaa」が追加表示されます。
<マップ名2:aaa> # 同上
※ 3つ以上表示させたい場合は「<MNE_MapName3:aaa>」で表示できます。

このプラグインの利用にはベースプラグイン『PluginCommonBase.js』が必要です。
『PluginCommonBase.js』は、RPGツクールMZのインストールフォルダ配下の
以下のフォルダに格納されています。
dlc/BasicResources/plugins/official

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

(()=> {
    'use strict';
    const script = document.currentScript;
    const param = PluginManagerEx.createParameter(script);

    //=============================================================================
    // ローカル変数
    //=============================================================================
    const local          = {};
    local.mapNameIndex = 0;

    //=============================================================================
    // Game_Map
    //  連続マップ表示に対応します。
    //=============================================================================
    const _Game_Map_displayName      = Game_Map.prototype.displayName;
    Game_Map.prototype.displayName = function() {
        const index = local.mapNameIndex + 1;
        if (index > 1 && $dataMap.meta) {
            return PluginManagerEx.findMetaValue($dataMap, ['マップ名' + index, 'MapName' + index]);
        } else {
            return _Game_Map_displayName.apply(this, arguments) || this.getRealMapName();
        }
    };

    Game_Map.prototype.isSameDisplayName = function() {
        const name = this.displayName();
        const result = this._prevDisplayName === name;
        this._prevDisplayName = this.displayName();
        return result;
    };

    Game_Map.prototype.getRealMapName = function() {
        return param.showReal && $dataMapInfos[this._mapId] ? $dataMapInfos[this._mapId].name : '';
    };

    //=============================================================================
    // Window_MapName
    //  表示方法を全体的に拡張します。
    //=============================================================================
    const _Window_MapName_initialize      = Window_MapName.prototype.initialize;
    Window_MapName.prototype.initialize = function(rect) {
        if (param.width) {
            rect.width = param.width;
        }
        if (param.height) {
            rect.height = param.height;
        }
        _Window_MapName_initialize.apply(this, arguments);
        this._originalX    = this.x;
        this._originalY    = this.y;
        local.mapNameIndex = 0;
        this.createBackground();
        this.updatePlacementInit();
    };

    Window_MapName.prototype.createBackground = function() {
        if (!param.backgroundImage) return;
        const sprite = new Sprite();
        sprite.bitmap = ImageManager.loadPicture(param.backgroundImage);
        sprite.bitmap.addLoadListener(()=> {
            sprite.x = this.width / 2 - sprite.width / 2;
            sprite.y = this.height / 2 - sprite.height / 2;
        });
        sprite.visible = false;
        sprite.opacity = 0;
        this._backGroundSprite = sprite;
        this.addChildToBack(this._backGroundSprite);
    };

    const _Window_MapName_updateFadeIn      = Window_MapName.prototype.updateFadeIn;
    Window_MapName.prototype.updateFadeIn = function() {
        if (param.viewDelay > 0 && this.updateDelay()) {
            this._showCount++;
            return;
        }
        const opacity = this.contentsOpacity;
        _Window_MapName_updateFadeIn.apply(this, arguments);
        this.updateOpacity(opacity + param.fadeInSpeed);
        this.updatePlacementInFading(opacity);
    };

    Window_MapName.prototype.flash = function() {
        if (!this.isNeverHide()) {
            return;
        }
        if ($gameMap.isNameDisplayEnabled()) {
            this.open();
            while(this.contentsOpacity < 255) {
                this.updateFadeIn();
            }
        }
        this._showCount = Infinity;
    };

    Window_MapName.prototype.isNeverHide = function() {
        return !isFinite(param.allDuration)
    };

    Window_MapName.prototype.updateDelay = function() {
        this._delayCount = (this._delayCount || 0) + 1;
        return this._delayCount < param.viewDelay;
    };

    const _Window_MapName_update      = Window_MapName.prototype.update;
    Window_MapName.prototype.update = function() {
        _Window_MapName_update.apply(this, arguments);
        if (this.isNeverHide()) {
            this.updateTempHide();
        }
    };

    Window_MapName.prototype.updateTempHide = function() {
        const hide = this.isNeedHide();
        if (hide && this.isOpen()) {
            this.openness = 0;
        } else if (!hide && this.isClosed()) {
            this.openness = 255;
        }
    };

    Window_MapName.prototype.isNeedHide = function() {
        return $gameSwitches.value(param.hideSwitch) ||
            (param.hideInEventRunning && $gameMap.isEventRunning());
    };

    const _Window_MapName_updateFadeOut      = Window_MapName.prototype.updateFadeOut;
    Window_MapName.prototype.updateFadeOut = function() {
        const opacity = this.contentsOpacity;
        this._delayCount = 0;
        _Window_MapName_updateFadeOut.apply(this, arguments);
        this.updateOpacity(opacity - param.fadeInSpeed);
        this.updatePlacementInFading(opacity);
        if (opacity > 0 && this.contentsOpacity === 0) {
            this.reOpen();
        }
    };

    Window_MapName.prototype.updateOpacity = function(opacity) {
        if (param.fadeInSpeed > 0) {
            this.contentsOpacity = opacity;
        }
        if (this.isWindow()) {
            this.opacity = this.contentsOpacity;
        }
        if (this._backGroundSprite) {
            this._backGroundSprite.opacity = this.contentsOpacity;
        }
    };

    Window_MapName.prototype.updatePlacementInit = function() {
        this.x = (param.positionX ? param.positionX : this._originalX);
        this.y = (param.positionY ? param.positionY : this._originalY);
        if (param.centering) {
            this.x = Graphics.width / 2 - this.width / 2;
        }
    };

    Window_MapName.prototype.updatePlacementInFading = function(oldOpacity) {
        if (oldOpacity !== this.contentsOpacity) {
            this.x += param.moveXInFade || 0;
            this.y += param.moveYInFace || 0;
        }
    };

    const _Window_MapName_drawBackground      = Window_MapName.prototype.drawBackground;
    Window_MapName.prototype.drawBackground = function(x, y, width, height) {
        if (this.isWindow() || this._backGroundSprite) {
            return;
        }
        _Window_MapName_drawBackground.apply(this, arguments);
    };

    const _Window_MapName_refresh      = Window_MapName.prototype.refresh;
    Window_MapName.prototype.refresh = function() {
        if (param.mapNameFormat && $gameMap.displayName()) {
            this.contents.clear();
            const width = this.innerWidth;
            this.drawBackground(0, 0, width, this.lineHeight());
            const text = param.mapNameFormat.format($gameMap.displayName());
            const size = this.textSizeEx(text).width;
            this.drawTextEx(text, width / 2 - size / 2, 0, width);
        } else {
            _Window_MapName_refresh.apply(this, arguments);
        }
        this.visible = !!$gameMap.displayName();
    };

    const _Window_MapName_open      = Window_MapName.prototype.open;
    Window_MapName.prototype.open = function() {
        _Window_MapName_open.apply(this, arguments);
        if (param.allDuration > 0) {
            this._showCount = param.allDuration / 2;
        }
        this.updatePlacementInit();
        if (this._backGroundSprite) {
            this._backGroundSprite.visible = true;
        }
    };

    const _Window_MapName_hide = Window_MapName.prototype.hide;
    Window_MapName.prototype.hide = function() {
        if (this.isNeverHide()) {
            return;
        }
        _Window_MapName_hide.apply(this, arguments);
    };

    const _Window_MapName_close = Window_MapName.prototype.close;
    Window_MapName.prototype.close = function() {
        if (this.isNeverHide()) {
            return;
        }
        _Window_MapName_close.apply(this, arguments);
    };

    Window_MapName.prototype.reOpen = function() {
        local.mapNameIndex++;
        if ($gameMap.displayName()) {
            this.open();
        } else {
            local.mapNameIndex = 0;
        }
    };

    Window_MapName.prototype.isWindow = function() {
        return param.showWindow;
    };

    const _Window_MapName_drawText      = Window_MapName.prototype.drawText;
    Window_MapName.prototype.drawText = function(text, x, y, maxWidth, align) {
        if (param.useControlCharacter) {
            this.drawTextEx(text, x, y);
        } else {
            _Window_MapName_drawText.apply(this, arguments);
        }
    };

    const _Scene_Map_start = Scene_Map.prototype.start;
    Scene_Map.prototype.start = function() {
        _Scene_Map_start.apply(this, arguments);
        if (!this._transfer) {
            this._mapNameWindow.flash();
        }
    };

    const _Scene_Map_onTransferEnd = Scene_Map.prototype.onTransferEnd;
    Scene_Map.prototype.onTransferEnd = function() {
        _Scene_Map_onTransferEnd.apply(this, arguments);
        if (param.noSameNameDisplay && $gameMap.isSameDisplayName()) {
            this._mapNameWindow.close();
        }
    };

    const _Scene_Map_updateMapNameWindow = Scene_Map.prototype.updateMapNameWindow;
    Scene_Map.prototype.updateMapNameWindow = function() {
        if (param.showOnMessage) {
            return;
        }
        _Scene_Map_updateMapNameWindow.apply(this, arguments);
    };
})();