//=============================================================================
// PicturePriorityCustomize.js
// ----------------------------------------------------------------------------
// (C) 2017 Triacontane
// This software is released under the MIT License.
// http://opensource.org/licenses/mit-license.php
// ----------------------------------------------------------------------------
// Version
// 1.2.2 2021/08/05 上層ピクチャが画面シェイクに連動しない問題を修正
// 1.2.1 2019/05/08 1.2.0の機能がYEP_BattleEngineCore.jsと併用すると無効になる競合を解消
// 1.2.0 2019/05/02 戦闘画面における下層ピクチャの表示優先度を微調整する機能を追加
// 1.1.3 2019/01/20 MenuCommonEvent.jsとの競合によるエラーを解消
// 1.1.2 2018/06/27 1.1.1の対応により発生したYEP_BattleEngineCore.jsとの競合を解消
// 1.1.1 2017/12/24 GALV_LayerGraphics.jsと併用したときに画像がちらつく競合を解消
// 1.1.0 2017/10/01 パラメータの型指定機能に対応
// 1.0.0 2017/03/20 初版
// ----------------------------------------------------------------------------
// [Blog]   : https://triacontane.blogspot.jp/
// [Twitter]: https://twitter.com/triacontane/
// [GitHub] : https://github.com/triacontane/
//=============================================================================

/*:
@url https://triacontane.blogspot.com/
@plugindesc Picture display priority adjustment plug-in
@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
-----
You can display pictures in top, middle, and bottom layers.
Top: Above the window
Middle: Default priority
Bottom: Below the character

You can fine-tune the display priority of bottom pictures by setting their Z
coordinate.

*Priority values
0: Bottom tile
1: Below the normal character
3: Same as the normal character
4: Top tile
5: Above the normal character
6: Airship shadow
7: Speech bubble
8: Animation
9: Map touch destination (the white glowing thing)

This plugin does not have any plugin commands.

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 上層ピクチャ番号
@text Upper Picture Number
@desc Pictures with a number equal to or greater than the specified number will be displayed above the window.
@type number
@default 101

@param 下層ピクチャ番号
@text Lower Picture Number
@desc Pictures below the specified number will be displayed below the characters and butlers.
@type number
@default 0

@param 下層ピクチャZ座標
@text Lower picture Z coordinate
@desc This is the Z coordinate of the lower layer picture. By changing this, you can make more detailed adjustments to the display priority.
@type select
@default 1
@option Lower tile
@value 0
@option Under normal characters
@value 1
@option Same as normal characters
@value 3
@option Upper tile
@value 4
@option Above normal characters
@value 5
@option Airship Shadow
@value 6
@option speech bubble
@value 7
@option Map Touch Destination
@value 9

@param 戦闘下層ピクチャZ座標
@text Battle lower level picture Z coordinate
@desc This is the Z coordinate of the bottom picture of the battle screen. By changing this, you can adjust the display priority more precisely.
@type select
@default 0
@option Enemy characters
@value 0
@option animation
@value 1
*/

/*:ja
@plugindesc ピクチャの表示優先度調整プラグイン
@author トリアコンタン

@param 上層ピクチャ番号
@desc 指定した番号以上のピクチャはウィンドウより上に表示されるようになります。
@default 101
@type number

@param 下層ピクチャ番号
@desc 指定した番号以下のピクチャはキャラクター、バトラーより下に表示されるようになります。
@default 0
@type number

@param 下層ピクチャZ座標
@desc 下層ピクチャのZ座標です。変更することでより細かい表示優先度の調整ができます。
@default 1
@type select
@option 下層タイル
@value 0
@option 通常キャラの下
@value 1
@option 通常キャラと同じ
@value 3
@option 上層タイル
@value 4
@option 通常キャラの上
@value 5
@option 飛行船の影
@value 6
@option フキダシ
@value 7
@option マップタッチの行き先
@value 9

@param 戦闘下層ピクチャZ座標
@desc 戦闘画面の下層ピクチャのZ座標です。変更することでより細かい表示優先度の調整ができます。
@default 0
@type select
@option 敵キャラ
@value 0
@option アニメーション
@value 1

@help ピクチャを上層、中層、下層に分けて表示できます。
上層：ウィンドウより上
中層：デフォルトの優先度
下層：キャラクターより下

下層ピクチャに対しては、Z座標を設定することで
より細かい表示優先度の調整ができます。

※それぞれのプライオリティの値
0 : 下層タイル
1 : 通常キャラの下
3 : 通常キャラと同じ
4 : 上層タイル
5 : 通常キャラの上
6 : 飛行船の影
7 : フキダシ
8 : アニメーション
9 : マップタッチの行き先（白く光るヤツ）

このプラグインにはプラグインコマンドはありません。

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

(function () {
    'use strict';
    const pluginName = 'PicturePriorityCustomize';

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

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

    //=============================================================================
    // パラメータの取得と整形
    //=============================================================================
    const param = {};
    param.upperPictureId = getParamNumber(['UpperPictureId', '上層ピクチャ番号']);
    param.lowerPictureId = getParamNumber(['LowerPictureId', '下層ピクチャ番号']);
    param.lowerPictureZ = getParamNumber(['LowerPictureZ', '下層ピクチャZ座標']);
    param.lowerPictureBattleZ = getParamNumber(['LowerPictureBattleZ', '戦闘下層ピクチャZ座標'], 0);

    //=============================================================================
    // Scene_Base
    //  ウィンドウの上にピクチャを配置します。
    //=============================================================================
    var _Scene_Base_createWindowLayer = Scene_Base.prototype.createWindowLayer;
    Scene_Base.prototype.createWindowLayer = function () {
        _Scene_Base_createWindowLayer.apply(this, arguments);
        if (this._spriteset) {
            this._spriteset.setUpperPictureContainer(this);
        }
    };

    //=============================================================================
    // Spriteset_Base
    //  ピクチャを三層に分割します。
    //=============================================================================
    var _Spriteset_Base_createPictures = Spriteset_Base.prototype.createPictures;
    Spriteset_Base.prototype.createPictures = function () {
        _Spriteset_Base_createPictures.apply(this, arguments);
        this.removeChild(this._pictureContainer);
        this.createPictureLayer();
    };

    Spriteset_Base.prototype.createPictureLayer = function () {
        var width = Graphics.boxWidth;
        var height = Graphics.boxHeight;
        var x = (Graphics.width - width) / 2;
        var y = (Graphics.height - height) / 2;
        this._pictureContainerLower = new Sprite();
        this._pictureContainerLower.setFrame(x, y, width, height);
        this._pictureContainerMiddle = new Sprite();
        this._pictureContainerMiddle.setFrame(x, y, width, height);
        this._pictureContainerUpper = new Sprite();
        this._pictureContainerUpper.setFrame(x, y, width, height);
        var pictureArray = this._pictureContainer.children.clone();
        pictureArray.forEach(function (picture) {
            var pictureId = picture.getPictureId();
            if (pictureId <= param.lowerPictureId) {
                this._pictureContainerLower.addChild(picture);
            } else if (pictureId >= param.upperPictureId) {
                this._pictureContainerUpper.addChild(picture);
            } else {
                this._pictureContainerMiddle.addChild(picture);
            }
        }, this);
        this._pictureContainer.children = pictureArray;
        this.setLowerPictureContainer();
        this.setMiddlePictureContainer();
    };

    Spriteset_Base.prototype.setUpperPictureContainer = function (parentScene) {
        parentScene.addChild(this._pictureContainerUpper);
    };

    Spriteset_Base.prototype.setMiddlePictureContainer = function () {
        this.addChild(this._pictureContainerMiddle);
    };

    Spriteset_Base.prototype.setLowerPictureContainer = function () {
        this.addChild(this._pictureContainerLower);
    };

    var _Spriteset_Base_updatePosition = Spriteset_Base.prototype.updatePosition;
    Spriteset_Base.prototype.updatePosition = function () {
        _Spriteset_Base_updatePosition.apply(this, arguments);
        this._pictureContainerUpper.x = this.x;
        this._pictureContainerUpper.y = this.y;
    };

    //=============================================================================
    // Spriteset_Map
    //  下層ピクチャの位置を設定します。
    //=============================================================================
    Spriteset_Map.prototype.setLowerPictureContainer = function () {
        this._pictureContainerLower.z = param.lowerPictureZ;
        this._tilemap.addChild(this._pictureContainerLower);
    };

    //=============================================================================
    // Spriteset_Battle
    //  下層ピクチャの位置を設定します。
    //=============================================================================
    Spriteset_Battle.prototype.setLowerPictureContainer = function () {
        this.updateLowerPictureContainerZ();
        // resolve conflict for GALV_LayerGraphics.js
        if (typeof Imported !== 'undefined' && Imported.Galv_LayerGraphics) {
            this._pictureContainerLower.z = 2;
        }
    };

    Spriteset_Battle.prototype.updateLowerPictureContainerZ = function () {
        var compare = param.lowerPictureBattleZ > 0 ? this._enemySprites[this._enemySprites.length - 1] :
            this._back2Sprite;
        var index = this._battleField.getChildIndex(compare);
        this._battleField.addChildAt(this._pictureContainerLower, index + 1);
    };

    if (typeof Yanfly !== 'undefined' && Yanfly.BEC) {
        var _Spriteset_Battle_update = Spriteset_Battle.prototype.update;
        Spriteset_Battle.prototype.update = function () {
            _Spriteset_Battle_update.apply(this, arguments);
            this.updateLowerPictureContainerZ();
        };
    }

    //=============================================================================
    // Sprite_Picture
    //  ピクチャIDを取得可能にします。
    //=============================================================================
    Sprite_Picture.prototype.getPictureId = function () {
        return this._pictureId;
    };
})();