ActorCommandHelp.js

/*=============================================================================
 ActorCommandHelp.js
----------------------------------------------------------------------------
 (C)2022 Triacontane
 This software is released under the MIT License.
 http://opensource.org/licenses/mit-license.php
----------------------------------------------------------------------------
 Version
 1.2.0 2023/10/15 プラグイン等で追加されたパーティコマンド、アクターコマンドのヘルプを表示できる機能を追加
 1.1.0 2022/10/08 共通のコマンドヘルプを指定できる機能を追加
                  ヘルプ中に%1を記述すると選択中のアクター名称に置き換わる機能を追加
 1.0.0 2022/08/28 初版
----------------------------------------------------------------------------
 [Blog]   : https://triacontane.blogspot.jp/
 [Twitter]: https://twitter.com/triacontane/
 [GitHub] : https://github.com/triacontane/
=============================================================================*/

/*:
 * @plugindesc アクターコマンドヘルププラグイン
 * @target MZ
 * @url https://github.com/triacontane/RPGMakerMV/tree/mz_master/ActorCommandHelp.js
 * @base PluginCommonBase
 * @orderAfter PluginCommonBase
 * @author トリアコンタン
 *
 * @param invalidSwitch
 * @text 無効スイッチ
 * @desc 指定したスイッチがONのときヘルプは表示されなくなります。
 * @default 0
 * @type switch
 *
 * @param fightDesc
 * @text 戦うコマンド説明
 * @desc 『戦う』コマンドの説明です。
 * @default
 * @type multiline_string
 *
 * @param escapeDesc
 * @text 逃げるコマンド説明
 * @desc 『逃げる』コマンドの説明です。
 * @default
 * @type multiline_string
 *
 * @param itemDesc
 * @text アイテムコマンド説明
 * @desc 『アイテム』コマンドの説明です。
 * @default
 * @type multiline_string
 *
 * @param skillTypeDescList
 * @text スキルタイプ説明
 * @desc スキルタイプごとの説明です。スキルタイプで定義した順番に配列として定義します。
 * @default []
 * @type multiline_string[]
 *
 * @param actorCommonDesc
 * @text アクター共通説明
 * @desc アクターコマンドで共通使用されるメッセージです。コマンド毎の説明が不要な場合に使います。
 * @default
 * @type multiline_string
 *
 * @param partyCommonDesc
 * @text パーティ共通説明
 * @desc パーティコマンドで共通使用されるメッセージです。コマンド毎の説明が不要な場合に使います。
 * @default
 * @type multiline_string
 *
 * @param customPartyDescList
 * @text カスタムパーティ説明リスト
 * @desc プラグイン等で追加されたカスタムコマンドごとの説明です。シンボルとインデックスで一意に特定します。
 * @default []
 * @type struct<CustomDesc>[]
 *
 * @param customActorDescList
 * @text カスタムアクター説明リスト
 * @desc プラグイン等で追加されたカスタムコマンドごとの説明です。シンボルとインデックスで一意に特定します。
 * @default []
 * @type struct<CustomDesc>[]
 *
 * @help ActorCommandHelp.js
 *
 * アクターコマンドやパーティコマンドにコマンドごとに定義したヘルプを表示します。
 * 攻撃や防御は、それぞれ割り当てられたスキルの説明が表示され
 * それ以外のコマンドはプラグインパラメータから定義します。
 * アクターコマンドのヘルプは%1で選択中のアクター名称に置き換わります。
 *　
 * このプラグインの利用にはベースプラグイン『PluginCommonBase.js』が必要です。
 * 『PluginCommonBase.js』は、RPGツクールMZのインストールフォルダ配下の
 * 以下のフォルダに格納されています。
 * dlc/BasicResources/plugins/official
 *
 * 利用規約：
 *  作者に無断で改変、再配布が可能で、利用形態（商用、18禁利用等）
 *  についても制限はありません。
 *  このプラグインはもうあなたのものです。
 */

/*~struct~CustomDesc:
 *
 * @param symbol
 * @text シンボル
 * @desc コマンドのシンボルです。プラグインのコードを見ないと特定できない場合があります。不明な場合はインデックスのみ指定してください。
 * @default
 *
 * @param index
 * @text インデックス
 * @desc コマンドのインデックスです。シンボルで一意に特定できる場合は指定不要です。
 * @default 0
 * @type number
 *
 * @param desc
 * @text 説明
 * @desc コマンドの説明です。
 * @default
 * @type multiline_string
 *
 */

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

    const _Scene_Battle_createHelpWindow = Scene_Battle.prototype.createHelpWindow;
    Scene_Battle.prototype.createHelpWindow = function() {
        _Scene_Battle_createHelpWindow.apply(this, arguments);
        this._actorCommandWindow.setHelpWindow(this._helpWindow);
        this._partyCommandWindow.setHelpWindow(this._helpWindow);
    };

    const _Window_Selectable_updateHelp = Window_Selectable.prototype.updateHelp;
    Window_Selectable.prototype.updateHelp = function() {
        _Window_Selectable_updateHelp.apply(this, arguments);
        if ((this instanceof Window_ActorCommand) || (this instanceof Window_PartyCommand)) {
            this.updateActorCommandHelp();
        }
    };

    Window_Selectable.prototype.updateActorCommandHelp = function() {
        if ($gameSwitches.value(param.invalidSwitch)) {
            return;
        }
        const text = this.findActorCommandHelpText();
        if (text) {
            this._helpWindow.setText(text);
            this.showHelpWindow();
        }
        this._helpWindow.setText(this._actor ? text.format(this._actor.name()) : text);
        this.showHelpWindow();
    };

    Window_Selectable.prototype.findActorCommandHelpText = function() {}

    Window_Selectable.prototype.findCustomCommandHelpText = function(symbol, list) {
        if (!list) {
            return null;
        }
        const data = list.find(item => {
            if (item.symbol && item.symbol !== symbol) {
                return false;
            }
            return !(item.index && item.index !== this.index());
        });
        return data ? data.desc : null;
    };

    Window_PartyCommand.prototype.findActorCommandHelpText = function() {
        let text;
        const symbol = this.currentSymbol();
        switch (symbol) {
            case 'fight':
                text = param.fightDesc;
                break;
            case 'escape':
                text = param.escapeDesc;
                break;
            default :
                text = this.findCustomCommandHelpText(symbol, param.customPartyDescList);
        }
        return text || param.partyCommonDesc;
    };

    Window_ActorCommand.prototype.findActorCommandHelpText = function() {
        let text;
        const symbol = this.currentSymbol();
        switch (symbol) {
            case 'attack':
                text = $dataSkills[this._actor.attackSkillId()].description;
                break;
            case 'guard':
                text =  $dataSkills[this._actor.guardSkillId()].description;
                break;
            case 'skill':
                text = param.skillTypeDescList[this.currentExt() - 1];
                break;
            case 'item':
                text = param.itemDesc;
                break;
            default :
                text = this.findCustomCommandHelpText(symbol, param.customActorDescList);
        }
        return text || param.actorCommonDesc;
    };
})();