/*=============================================================================
 PictureGrouping.js
----------------------------------------------------------------------------
 (C)2023 Triacontane
 This software is released under the MIT License.
 http://opensource.org/licenses/mit-license.php
----------------------------------------------------------------------------
 Version
 1.1.0 2024/10/30 ピクチャ以外のフォルダから画像を指定する機能と、画像をトリミングして表示する機能を追加
 1.0.4 2024/10/19 グルーピングピクチャを表示しているマップから別のシーンに遷移後、戻ってきたときに画像が一瞬チラつくことがある問題を修正
 1.0.3 2024/03/19 ピクチャのファイル名に制御文字を使用できるよう修正
 1.0.2 2024/01/14 同じピクチャ番号でグループピクチャを再表示したときに一瞬チラつきが発生する現象を修正
 1.0.1 2023/11/12 グループ化していないピクチャを再表示できなくなる問題を修正
 1.0.0 2023/11/12 初版
----------------------------------------------------------------------------
 [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/PictureGrouping.js
@plugindesc Picture Grouping 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
-----

PictureGrouping.js

Display multiple picture files as a single picture.
Manage coordinates, magnification, opacity, and more all at once.
Specify the pictures to group using the plugin command.
Then, when you execute the "Show Pictures" event command, all grouped pictures
will be displayed overlapping the original picture.
You cannot add or remove pictures after display.

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, and there are
no restrictions on its use (commercial, 18+, etc.).
This plugin is now yours.

@command GROUPING_PICTURE
@text Grouping picture specification
@desc Specify the picture file to be grouped. The bottom of the list will be displayed in front.
@arg pictureList
@text Picture List
@desc A list of pictures to group.
@type struct<Picture>[]
@default []
*/

/*~struct~Picture:
@param FileName
@text File name
@desc The picture's filename.
@type file
@dir img/pictures/

@param OtherFileName
@text Other file names
@desc If you want to use an image other than a picture, specify this.
@type file
@dir img

@param Rect
@text Trimming range
@desc Specify this if you want to crop the image and display it.
@type struct<Rect>

@param X
@text X coordinate
@desc The relative X coordinate of the picture.
@type number
@default 0

@param Y
@text Y coordinate
@desc The relative Y coordinate of the picture.
@type number
@default 0
*/

/*~struct~Rect:
@param X
@text X coordinate
@desc The X coordinate of the crop range.
@type number
@default 0

@param Y
@text Y coordinate
@desc The Y coordinate of the crop range.
@type number
@default 0

@param Width
@text width
@desc The width of the cropping range.
@type number
@default 0

@param Height
@text height
@desc The height of the cropping range.
@type number
@default 0
*/

/*:ja
@plugindesc ピクチャのグループ化プラグイン
@target MZ
@url https://github.com/triacontane/RPGMakerMV/tree/mz_master/PictureGrouping.js
@base PluginCommonBase
@orderAfter PluginCommonBase
@author トリアコンタン

@command GROUPING_PICTURE
@text グループ化ピクチャ指定
@desc グループ化するピクチャファイルを指定します。リストの下が手前に表示されます。

@arg pictureList
@text ピクチャリスト
@desc グループ化するピクチャのリストです。
@default []
@type struct<Picture>[]

@help PictureGrouping.js

複数のピクチャファイルをひとつのピクチャとして表示できます。
座標や拡大率、不透明度などを一括管理できます。
プラグインコマンドからグループ化するピクチャを指定してください。
その後、イベントコマンド「ピクチャの表示」を実行すると、元のピクチャのうえに
グループ化で指定したピクチャがすべて重なって表示されます。
表示後にピクチャを追加削除することはできません。

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

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

/*~struct~Picture:ja

@param FileName
@text ファイル名
@desc ピクチャのファイル名です。
@default
@dir img/pictures/
@type file

@param OtherFileName
@text 他のファイル名
@desc ピクチャ以外の画像を使いたいときは、こちらを指定してください。
@default
@dir img
@type file

@param Rect
@text トリミング範囲
@desc 画像を切り出して表示したい場合に指定してください。
@type struct<Rect>

@param X
@text X座標
@desc ピクチャの相対X座標です。
@default 0
@type number

@param Y
@text Y座標
@desc ピクチャの相対Y座標です。
@default 0
@type number
*/

/*~struct~Rect:ja
@param X
@text X座標
@desc 切り出し範囲のX座標です。
@default 0
@type number

@param Y
@text Y座標
@desc 切り出し範囲のY座標です。
@default 0
@type number

@param Width
@text 幅
@desc 切り出し範囲の幅です。
@default 0
@type number

@param Height
@text 高さ
@desc 切り出し範囲の高さです。
@default 0
@type number
*/

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

    PluginManagerEx.registerCommand(script, 'GROUPING_PICTURE', args => {
        args.pictureList.forEach(picture => $gameScreen.addGroupingPicture(picture));
    });

    const _Game_System_onAfterLoad = Game_System.prototype.onAfterLoad;
    Game_System.prototype.onAfterLoad = function() {
        _Game_System_onAfterLoad.apply(this, arguments);
        if (!$gameScreen.groupingPicture()) {
            $gameScreen.clearGroupingPicture();
        }
    }

    const _Game_Screen_clear = Game_Screen.prototype.clear;
    Game_Screen.prototype.clear = function() {
        _Game_Screen_clear.apply(this, arguments);
        this.clearGroupingPicture();
    };

    Game_Screen.prototype.clearGroupingPicture = function() {
        this._groupingPicture = [];
    }

    Game_Screen.prototype.groupingPicture = function() {
        return this._groupingPicture;
    };

    Game_Screen.prototype.addGroupingPicture = function(picture) {
        const name = PluginManagerEx.convertEscapeCharacters(picture.FileName);
        const otherName = PluginManagerEx.convertEscapeCharacters(picture.OtherFileName || '');
        const rect = picture.Rect || {};
        this._groupingPicture.push({
            fileName: name,
            otherName: otherName,
            x: picture.X,
            y: picture.Y,
            rect: {
                x: rect.X || 0,
                y: rect.Y || 0,
                width: rect.Width || 0,
                height: rect.Height || 0
            }
        });
        ImageManager.loadPicture(name);
    };

    const _Game_Screen_erasePicture = Game_Screen.prototype.erasePicture;
    Game_Screen.prototype.erasePicture = function(pictureId) {
        const realPictureId = this.realPictureId(pictureId);
        const picture = this._pictures[realPictureId];
        if (picture && picture.findGrouping()) {

        }
        _Game_Screen_erasePicture.apply(this, arguments);
    };

    const _Game_Picture_show = Game_Picture.prototype.show;
    Game_Picture.prototype.show = function(
        name, origin, x, y, scaleX, scaleY, opacity, blendMode
    ) {
        const grouping = $gameScreen.groupingPicture();
        if (grouping.length > 0) {
            this._grouping = grouping;
            if (name) {
                this._grouping.unshift({fileName: name, x: 0, y: 0});
            }
            arguments[0]   = Date.now().toString();
            $gameScreen.clearGroupingPicture();
        }
        _Game_Picture_show.apply(this, arguments);
    };

    Game_Picture.prototype.findGrouping = function() {
        return this._grouping;
    };

    const _Sprite_Picture_updateBitmap = Sprite_Picture.prototype.updateBitmap;
    Sprite_Picture.prototype.updateBitmap = function() {
        const picture = this.picture();
        if (!picture) {
            this.destroyGrouping();
        }
        _Sprite_Picture_updateBitmap.apply(this, arguments);
    };

    const _Sprite_Picture_loadBitmap      = Sprite_Picture.prototype.loadBitmap;
    Sprite_Picture.prototype.loadBitmap = function() {
        const grouping = this.picture().findGrouping();
        if (grouping) {
            this.makeGroupingBitmap(grouping).then(() => null);
        } else {
            _Sprite_Picture_loadBitmap.apply(this, arguments);
            this.destroyGrouping();
        }
    };

    Sprite_Picture.prototype.makeGroupingBitmap = async function(grouping) {
        const bitmaps = grouping.map(data => this.loadGroupBitmap(data));
        if (bitmaps.some(bitmap => !bitmap.isReady())) {
            await this.waitForGroupingLoad(bitmaps);
        }
        const width = grouping.reduce((prev, data) => {
            const bitmap = this.loadGroupBitmap(data);
            return Math.max(prev, bitmap.width + data.x)
        }, 1);
        const height = grouping.reduce((prev, data) => {
            const bitmap = this.loadGroupBitmap(data);
            return Math.max(prev, bitmap.height + data.y)
        }, 1);
        this.bitmap = new Bitmap(width, height);
        grouping.forEach(data => {
            const bitmap = this.loadGroupBitmap(data);
            const rect = data.rect || {};
            const sx = rect.x || 0;
            const sy = rect.y || 0;
            const sw = rect.width || bitmap.width;
            const sh = rect.height || bitmap.height;
            this.bitmap.blt(bitmap, sx, sy, sw, sh, data.x, data.y);
        });
        this.destroyGrouping();
        this._groupingBitmap = this.bitmap;
    };

    Sprite_Picture.prototype.loadGroupBitmap = function(data) {
        if (data.otherName) {
            const paths = data.otherName.split('/');
            const folder = 　'img/' + paths.shift() + '/';
            const name = paths.join('/');
            return ImageManager.loadBitmap(folder, name);
        } else {
            return ImageManager.loadPicture(data.fileName);
        }
    };

    Sprite_Picture.prototype.waitForGroupingLoad = function(bitmaps) {
        return new Promise(resolve => {
            bitmaps.some(bitmap => {
                bitmap.addLoadListener(() => {
                    if (bitmaps.every(data => data.isReady())) {
                        resolve();
                        return true;
                    } else {
                        return false;
                    }
                });
            });
        });
    };

    Sprite_Picture.prototype.destroyGrouping = function() {
        if (this._groupingBitmap) {
            this._groupingBitmap.destroy();
            this._groupingBitmap = null;
        }
    };
})();