//=============================================================================
// MessageSpeedCustomize.js
// ----------------------------------------------------------------------------
// (C)2016 Triacontane
// This software is released under the MIT License.
// http://opensource.org/licenses/mit-license.php
// ----------------------------------------------------------------------------
// Version
// 1.6.2 2024/11/08 メッセージ速度が1のとき、決定ボタン押下後は以後のメッセージが瞬間表示になってしまう問題を修正
// 1.5.1 2023/06/16 1.5.0で追加した機能で表示速度変数(高速表示)での表示速度を\msで指定した表示速度より優先するよう仕様変更し、ヘルプに明記
// 1.5.0 2023/06/15 メッセージの高速表示(決定ボタン押し続け)時のメッセージ表示速度を別途指定できる機能を追加
// 1.4.0 2021/10/21 MZで動作するよう修正
// 1.3.0 2019/12/27 瞬間表示の利用可否をゲーム中にスイッチで変更できるようにしました
// 1.2.3 2018/11/28 BugFixWaitOfTextEnd.jsと組み合わせたとき、末尾の動作がおかしくなる問題を修正
// 1.2.2 2018/07/22 瞬間表示機能が有効なとき、\!を使用すると以後のメッセージまで瞬間表示されてしまう問題を修正
// 1.2.1 2017/12/30 パラメータの型指定機能に対応し、ヘルプの記述を修正
// 1.2.0 2016/11/05 ノベルゲーム総合プラグインから、メッセージ表示速度を調整する制御文字を流用
// 1.1.2 2016/07/24 複数行「\>」が指定されている場合もデフォルトと同じ動作をするよう修正
// 1.1.1 2016/07/23 制御文字「\>\<」が指定されている場合、そちらを優先するよう修正
// 1.1.0 2016/07/12 文章の表示中に決定キーもしくは左クリックで文章を瞬間表示する機能を追加
// 1.0.0 2016/04/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/MessageSpeedCustomize.js
@plugindesc Message Rate Throttling 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
-----

MessageSpeedCustomize.js

Adjusts the message display speed.
Assign the following values to the variable number specified in the parameter.
0: Instantaneous display
1: Normal display speed
2 or higher: Displays one character at the specified frame interval.

* The parameter does not specify the display speed itself, but the value of
the variable that obtains the display speed.
The larger the variable value, the slower the display.

Using the control character "\ms[n]" allows you to set the display speed to
any value for that message only.
This is useful for temporarily changing the message display speed.
The speed changed with \ms[n] takes precedence over the display speed
specified in the "Display Speed Variable" parameter.
It does not take precedence over the "Display Speed Variable (Fast Display)"
parameter.

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 SpeedVariable
@text Display Speed Variable
@desc The number of the variable that stores the message display speed. The value stored in this variable will be the message display speed.
@type variable
@default 1

@param SpeedVariableOnFast
@text Display speed variable (fast display)
@desc The number of the variable that stores the message display speed when fast display (holding down the Enter button) is enabled.
@type variable
@default 0

@param FastSwitch
@text momentary display switch
@desc When the switch with the specified number is ON, pressing the OK button or left-clicking while a sentence is displayed will instantly display the sentence.
@type switch
@default 0
*/

/*:ja
@plugindesc メッセージ速度調整プラグイン
@target MZ
@url https://github.com/triacontane/RPGMakerMV/tree/mz_master/MessageSpeedCustomize.js
@base PluginCommonBase
@orderAfter PluginCommonBase
@author トリアコンタン

@param SpeedVariable
@text 表示速度変数
@desc メッセージ表示速度を格納する変数の番号。この変数に格納された値がメッセージ表示速度になります。
@default 1
@type variable

@param SpeedVariableOnFast
@text 表示速度変数(高速表示)
@desc 高速表示(決定ボタン押し続け時)が有効な場合のメッセージ表示速度を格納する変数の番号。
@default 0
@type variable

@param FastSwitch
@text 瞬間表示スイッチ
@desc 指定した番号のスイッチがONになっているとき、文章の表示中に決定ボタンや左クリックで文章を瞬間表示します。
@default 0
@type switch

@help MessageSpeedCustomize.js

メッセージ表示速度を調整します。
パラメータで指定した番号の変数に対して以下の値を代入してください。
0     : 瞬間表示
1     : 通常と同様の表示速度
2以上 : 指定したフレーム間隔で一文字を表示します。

※ パラメータで指定するのは表示速度自体ではなく
表示速度を取得する変数の値です。
変数値が大きければ大きいほどゆっくりと表示されます。

制御文字「\ms[n]」を利用すると、そのメッセージ中のみ表示速度を
任意の値に設定することができます。
一時的にメッセージ表示速度を変更したい場合に有効です。
\ms[n]で変更した速度は、パラメータ「表示速度変数」での表示速度より
優先されます。
パラメータ「表示速度変数(高速表示)」よりは優先されません。

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

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

(()=> {
    'use strict';
    const script = document.currentScript;
    const param = PluginManagerEx.createParameter(script);
    
    //=============================================================================
    // Window_Message
    //  メッセージの表示間隔を調整します。
    //=============================================================================
    const _Window_Message_clearFlags      = Window_Message.prototype.clearFlags;
    Window_Message.prototype.clearFlags = function() {
        _Window_Message_clearFlags.apply(this, arguments);
        this._tempMessageSpeed = null;
        this._showAll = false;
    };

    const _Window_Message_updateWait = Window_Message.prototype.updateWait;
    Window_Message.prototype.updateWait = function() {
        if ($gameSwitches.value(param.FastSwitch) && this._textState &&
            this.isTriggered() && !this.pause) {
            this._showAll = true;
        }
        this._showFast = false;
        this.updateShowFast();
        return _Window_Message_updateWait.apply(this, arguments);
    };

    const _Window_Message_updateMessage = Window_Message.prototype.updateMessage;
    Window_Message.prototype.updateMessage = function() {
        const speed = this.getMessageSpeed();
        if (this._textState && !this._lineShowFast) {
            if (speed <= 0 || this._showAll) {
                this._showFast = true;
            } else if (!this.isEndOfText(this._textState)) {
                this._waitCount = speed - 1;
            }
        }
        return _Window_Message_updateMessage.apply(this, arguments);
    };

    const _Window_Message_startPause = Window_Message.prototype.startPause;
    Window_Message.prototype.startPause = function() {
        _Window_Message_startPause.apply(this, arguments);
        this._showAll = false;
    };

    Window_Message.prototype.getMessageSpeed = function() {
        if (this._showFast && param.SpeedVariableOnFast > 0) {
            return $gameVariables.value(param.SpeedVariableOnFast);
        } else if (this._tempMessageSpeed !== null) {
            return this._tempMessageSpeed;
        } else {
            return $gameVariables.value(param.SpeedVariable);
        }
    };

    Window_Message.prototype.setTempMessageSpeed = function(speed) {
        if (speed >= 0) {
            this._tempMessageSpeed = speed;
            if (speed > 0) this._showFast = false;
        } else {
            this._tempMessageSpeed = null;
        }
    };

    const _Window_Message_processEscapeCharacter = Window_Message.prototype.processEscapeCharacter;
    Window_Message.prototype.processEscapeCharacter = function(code, textState) {
        if (code === '>') this._waitCount = 0;
        switch (code) {
            case 'MS':
                this.setTempMessageSpeed(this.obtainEscapeParam(textState));
                break;
            default:
                _Window_Message_processEscapeCharacter.apply(this, arguments);
        }
    };
})();