//=============================================================================
// MoveSpeedChangeByRegion.js
// ----------------------------------------------------------------------------
// (C)2018 Triacontane
// This software is released under the MIT License.
// http://opensource.org/licenses/mit-license.php
// ----------------------------------------------------------------------------
// Version
// 1.6.1 2023/01/26 1.6.0で追加した無効スイッチが逆になっていた問題を修正
// 1.6.0 2022/12/11 本プラグインの機能をスイッチで一時的に無効にできる機能を追加
// 1.5.0 2022/09/19 控えメンバーの速度変化メモタグを有効化するパラメータを追加
// 1.4.0 2022/02/01 速度変化をイベントに適用するかどうかを設定できるパラメータ、メモ欄を追加
// 1.3.1 2022/01/27 ヘルプの記述を修正
// 1.3.0 2022/01/27 MZで動作するよう修正
// 1.2.0 2021/11/21 1.1.0のメモ欄の指定方法変更
// 1.1.0 2021/11/21 メモタグからも地形、リージョンによる速度変更ができる機能を追加
// 1.0.1 2018/02/15 フォロワーを連れているときにフォロワーの移動速度がおかしくなる問題を修正
// 1.0.0 2018/02/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/MoveSpeedChangeByRegion.js
@plugindesc Terrain speed change 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
-----

MoveSpeedChangeByRegion.js

Automatically increases or decreases a character's movement speed while riding
on a specified terrain or region.
Specify the target terrain and region via the parameters.

Additionally, if any members in the formation have the following notetags (※),
the speed will override the parameters.

・When terrain tag is [1], the speed will be [4].
<Speed Terrain: 1, 4>
※This applies to the memo fields of actors, jobs, weapons, armor, and states.

To specify a speed relative to the current speed, use the [+] or [-] symbols.
・When region is [1], the speed will increase by [2] steps.
<Speed Region: 1, +2>

To individually set the speed correction for an event, specify the following
in the memo field.
The memo field settings take priority over the parameter settings.
<Speed Terrain Disabled>
<NoMoveSpeedRegion>
<Speed Terrain Enabled>
<MoveSpeedRegion>

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+ use, etc.).
This plugin is now yours.

@param slowlyTerrainTags
@text Speed-reducing terrain
@desc This is a terrain tag that slows down the player's speed while moving. Multiple tags can be specified.
@type number[]

@param fasterTerrainTags
@text Speed-boosting terrain
@desc This is a terrain tag that increases speed while moving. Multiple tags can be specified.
@type number[]

@param slowlyRegions
@text Slowdown Regions
@desc Regions where movement will slow down. Multiple regions can be specified.
@type number[]

@param fasterRegions
@text Speed-up region
@desc Regions where speed increases while moving. Multiple regions can be specified.
@type number[]

@param deltaSpeed
@text Speed change amount
@desc The amount of change when the speed increases or decreases.
@type number
@default 1

@param eventNoApply
@text Does not apply to events
@desc When enabled, no speed compensation will be applied to the event.
@type boolean
@default false

@param enableBenchMembersTrait
@text Enable Substitute Tags
@desc Enables sub speed change notetags.
@type boolean
@default false

@param invalidSwitch
@text Disable Switch
@desc When the switch with the specified number is ON, all speed changes due to terrain will be disabled.
@type switch
@default 0
*/

/*:ja
@plugindesc 地形による速度変化プラグイン
@target MZ
@url https://github.com/triacontane/RPGMakerMV/tree/mz_master/MoveSpeedChangeByRegion.js
@base PluginCommonBase
@orderAfter PluginCommonBase
@author トリアコンタン

@param slowlyTerrainTags
@text 速度低下地形
@desc 移動中に速度が低下する地形タグです。複数指定できます。
@default
@type number[]

@param fasterTerrainTags
@text 速度上昇地形
@desc 移動中に速度が上昇する地形タグです。複数指定できます。
@default
@type number[]

@param slowlyRegions
@text 速度低下リージョン
@desc 移動中に速度が低下するリージョンです。複数指定できます。
@default
@type number[]

@param fasterRegions
@text 速度上昇リージョン
@desc 移動中に速度が上昇するリージョンです。複数指定できます。
@default
@type number[]

@param deltaSpeed
@text 速度変化量
@desc 速度が上昇、低下するときの変化量です。
@default 1
@type number

@param eventNoApply
@text イベントには適用しない
@desc 有効にするとイベントには速度補正を適用しなくなります。
@default false
@type boolean

@param enableBenchMembersTrait
@text 控えメンバーのタグ有効化
@desc 控えメンバーの速度変化メモタグを有効にします。
@default false
@type boolean

@param invalidSwitch
@text 無効スイッチ
@desc 指定した番号のスイッチがONのとき地形による速度変化がすべて無効になります。
@default 0
@type switch

@help MoveSpeedChangeByRegion.js

指定した地形もしくはリージョンに乗っている間だけキャラクターの移動速度を
自動的に上昇もしくは低下させます。
パラメータから対象地形とリージョンを指定します。

さらに、隊列にいるいずれかのメンバーが以下のメモタグを付与されている(※)
場合、パラメータより優先して速度が適用されます。
・地形タグ[1]のとき速度が[4]になる
<速度地形指定:1,4>
※アクター、職業、武器、防具、ステートのメモ欄が対象です。

現在の速度から相対的に指定する場合は[+][-]の記号を付けてください。
・リージョン[1]のとき速度が[2]段階あがる
<速度リージョン指定:1,+2>

イベントの速度補正を個別に設定する場合、メモ欄に以下の通り指定してください。
メモ欄の設定はパラメータの設定より優先されます。
<速度地形無効>
<NoMoveSpeedRegion>
<速度地形有効>
<MoveSpeedRegion>

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

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

(()=> {
    'use strict';
    const script = document.currentScript;
    const param = PluginManagerEx.createParameter(script);
    if (!param.slowlyTerrainTags) {
        param.slowlyTerrainTags = [];
    }
    if (!param.fasterTerrainTags) {
        param.fasterTerrainTags = [];
    }
    if (!param.slowlyRegions) {
        param.slowlyRegions = [];
    }
    if (!param.fasterRegions) {
        param.fasterRegions = [];
    }

    //=============================================================================
    // Game_CharacterBase
    //  地形による速度変化を設定
    //=============================================================================
    const _Game_CharacterBase_realMoveSpeed      = Game_CharacterBase.prototype.realMoveSpeed;
    Game_CharacterBase.prototype.realMoveSpeed = function() {
        const originalSpeed = _Game_CharacterBase_realMoveSpeed.apply(this, arguments);
        if (!this.isValidMoveSpeedChange()) {
            return originalSpeed;
        }
        const speed = originalSpeed + this.changeSpeedByTerrainTags() + this.changeSpeedByRegions();
        return this.changeSpeedByNote(speed);
    };

    Game_CharacterBase.prototype.changeSpeedByNote = function(speed) {
        if (!this.isValidMoveSpeedChangeByNote()) {
            return speed;
        }
        const targetMembers = param.enableBenchMembersTrait ? $gameParty.allMembers() : $gameParty.battleMembers();
        targetMembers.forEach(function(member) {
            member.traitObjects().forEach(function(obj) {
                const terrainNote = PluginManagerEx.findMetaValue(obj, ['速度地形指定']);
                if (terrainNote) {
                    speed = this.findSpeedByNote(terrainNote, this.terrainTag(), speed);
                }
                const regionNote = PluginManagerEx.findMetaValue(obj,['速度リージョン指定']);
                if (regionNote) {
                    speed = this.findSpeedByNote(regionNote, this.regionId(), speed);
                }
            }, this);
        }, this);
        return speed;
    };

    Game_CharacterBase.prototype.isValidMoveSpeedChange = function() {
        return !$gameSwitches.value(param.invalidSwitch);
    };

    Game_CharacterBase.prototype.isValidMoveSpeedChangeByNote = function() {
        return false;
    };

    Game_CharacterBase.prototype.findSpeedByNote = function(noteText, id, defaultSpeed) {
        const notes = noteText.split(',');
        if (parseInt(notes[0]) !== id || !notes[1]) {
            return defaultSpeed;
        }
        const sign = notes[1][0];
        if (sign === '-' || sign === '+') {
            return defaultSpeed + parseInt(notes[1]) * this.getDeltaSpeed();
        } else {
            return parseInt(notes[1]) || defaultSpeed;
        }
    };

    Game_CharacterBase.prototype.changeSpeedByTerrainTags = function() {
        const terrainTag = this.terrainTag();
        let speed      = 0;
        if (param.slowlyTerrainTags.contains(terrainTag)) {
            speed -= this.getDeltaSpeed();
        }
        if (param.fasterTerrainTags.contains(terrainTag)) {
            speed += this.getDeltaSpeed();
        }
        return speed;
    };

    Game_CharacterBase.prototype.changeSpeedByRegions = function() {
        const region = this.regionId();
        let speed  = 0;
        if (param.slowlyRegions.contains(region)) {
            speed -= this.getDeltaSpeed();
        }
        if (param.fasterRegions.contains(region)) {
            speed += this.getDeltaSpeed();
        }
        return speed;
    };

    Game_CharacterBase.prototype.getDeltaSpeed = function() {
        return param.deltaSpeed;
    };

    const _Game_Event_initialize = Game_Event.prototype.initialize;
    Game_Event.prototype.initialize = function(mapId, eventId) {
        _Game_Event_initialize.apply(this, arguments);
        if (PluginManagerEx.findMetaValue(this.event(), ['MoveSpeedRegion', '速度地形有効'])) {
            this._moveSpeedByRegion = true;
        } else if (PluginManagerEx.findMetaValue(this.event(), ['NoMoveSpeedRegion', '速度地形無効'])) {
            this._moveSpeedByRegion = false;
        }
    };

    Game_Event.prototype.isValidMoveSpeedChange = function() {
        if (this._moveSpeedByRegion !== undefined) {
            return this._moveSpeedByRegion;
        } else {
            return !param.eventNoApply;
        }
    };

    Game_Player.prototype.isValidMoveSpeedChangeByNote = function() {
        return true;
    };

    //=============================================================================
    // Game_Follower
    //  実移動速度を再定義
    //=============================================================================
    Game_Follower.prototype.realMoveSpeed = function() {
        return _Game_CharacterBase_realMoveSpeed.apply(this, arguments);
    };

    Game_Follower.prototype.isValidMoveSpeedChangeByNote = function() {
        return true;
    };
})();