/*============================================================================= KeySwitch.js ---------------------------------------------------------------------------- (C)2025 Triacontane This software is released under the MIT License. http://opensource.org/licenses/mit-license.php ---------------------------------------------------------------------------- Version 1.1.0 2025/02/26 トリガーに押し続け以外の選択肢を追加、トグルスイッチ用の設定を追加 1.0.0 2025/02/09 初版 ---------------------------------------------------------------------------- [X] : https://x.com/triacontane/ [GitHub] : https://github.com/triacontane/ =============================================================================*/ /*: @target MZ @url https://github.com/triacontane/RPGMakerMV/tree/mz_master/KeySwitch.js @plugindesc Keyswitch 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 ----- KeySwitch.js Turns on a switch by pressing a key. The switch condition is always met while the key is held down. Please note that this is active regardless of the scene. If you want to use a key other than the existing ones, add it to the key code list. However, depending on the registration content, a keyboard may be required. Please research the key code value for each key yourself. For example, the key code for the A key is 65. 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, R18, etc.). This plugin is now yours. @param keyList @text Key Settings List @desc Key switch settings. Register the key information to control the switch. @type struct[] @default [] @param codeList @text Key Code List @desc A list of key codes to register. Used when registering keys other than existing keys. @type struct

[]
@default []
*/

/*~struct~Key:
@param keyName
@text Key Name
@desc The name of the key that turns the switch on. If you want to use a key other than the existing ones, enter it directly.
@type combo
@option ok
@option cancel
@option shift
@option control
@option tab
@option pageup
@option pagedown
@option escape
@option down
@option left
@option right
@option up

@param switchId
@text Switch ID
@desc The ID of the switch to turn ON.
@type switch
@default 1

@param conditionSwitchId
@text Condition Switch ID
@desc Key input is only valid when this switch is ON. If not specified, it is always valid.
@type switch
@default 0

@param autoOff
@text Auto OFF
@desc If no key is pressed, the switch will return to OFF.
@type boolean
@default false

@param reverse
@text Invert
@desc Flip the switch ON/OFF and turn it OFF with key input.
@type boolean
@default false

@param toggle
@text toggle
@desc The switch will be turned ON/OFF each time a key is pressed. If enabled, the inversion and auto-off settings will be disabled.
@type boolean
@default false

@param trigger
@text trigger
@desc Key input trigger.
@type select
@default isPressed
@option Keep pressing
@value isPressed
@option The moment you press
@value isTriggered
@option Press and hold
@value isLongPressed
@option repeat
@value isRepeated
*/

/*~struct~Code:
@param keyName
@text Key Name
@desc Key name. Please specify any value that does not overlap with existing key names.

@param code
@text Key Code
@desc This is the key code of the key to be registered. The input value is the same as the JavaScript key code, so please check it yourself.
@type number
@default 65
*/

/*:ja
@plugindesc キースイッチプラグイン
@target MZ
@url https://github.com/triacontane/RPGMakerMV/tree/mz_master/KeySwitch.js
@base PluginCommonBase
@orderAfter PluginCommonBase
@author トリアコンタン

@param keyList
@text キー設定リスト
@desc キースイッチの設定です。スイッチ制御するキー情報を登録します。
@default []
@type struct[]

@param codeList
@text キーコードリスト
@desc 登録するキーコードのリストです。既存のキー以外のキーを登録する場合に使用します。
@default []
@type struct[]

@help KeySwitch.js

キー入力によってスイッチをONにできます。
押し続けている間は常にスイッチ条件を満たします。
シーンにかかわらず有効になるので注意してください。

既存のキー以外を使いたい場合はキーコードリストに追加してください。
ただし、登録内容によってはキーボードが必須になる可能性があります。
キーに対応するキーコードの値は各自調査してください。
例えば、Aキーのキーコードは65です。

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

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

/*~struct~Key:ja
@param keyName
@text キー名称
@desc スイッチをONにするキーの名称です。既存のキー以外を使用する場合は直接入力してください。
@default
@type combo
@option ok
@option cancel
@option shift
@option control
@option tab
@option pageup
@option pagedown
@option escape
@option down
@option left
@option right
@option up

@param switchId
@text スイッチID
@desc ONにするスイッチのIDです。
@default 1
@type switch

@param conditionSwitchId
@text 条件スイッチID
@desc このスイッチがONのときのみキー入力が有効になります。指定しない場合、常に有効になります。
@default 0
@type switch

@param autoOff
@text 自動OFF
@desc キー入力されていない状態だとスイッチをOFFに戻します。
@default false
@type boolean

@param reverse
@text 反転
@desc スイッチのON/OFFを反転させ、キー入力でスイッチをOFFにします。
@default false
@type boolean

@param toggle
@text トグル
@desc キー入力が有効になるたびにスイッチのON/OFFを切り替えます。有効にした場合、反転と自動OFFの設定は無効になります。
@default false
@type boolean

@param trigger
@text トリガー
@desc キー入力のトリガーです。
@type select
@option 押し続け
@value isPressed
@option 押した瞬間
@value isTriggered
@option 長押し
@value isLongPressed
@option リピート
@value isRepeated
@default isPressed
*/

/*~struct~Code:ja

@param keyName
@text キー名称
@desc キー名称です。既存のキー名称と重複しない任意の値を指定してください。

@param code
@text キーコード
@desc 登録するキーのキーコードです。入力値はJavaScriptのキーコードと同じなので各自調査してください。
@default 65
@type number
*/

(() => {
    'use strict';
    const script = document.currentScript;
    const param = PluginManagerEx.createParameter(script);
    if (!param.keyList) {
        param.keyList = [];
    }
    if (!param.codeList) {
        param.codeList = [];
    }
    param.codeList.forEach(item => {
        Input.keyMapper[item.code] = item.keyName;
    });
    const keyList = param.keyList.map(item => {
        const data = {};
        const prevData = item._parameter;
        for (const key in prevData) {
            data[key] = prevData[key];
        }
        return data;
    });

    const _SceneManager_updateMain = SceneManager.updateMain;
    SceneManager.updateMain = function() {
        _SceneManager_updateMain.apply(this, arguments);
        if ($gameVariables) {
            this.updateKeySwitch();
        }
    };

    SceneManager.updateKeySwitch = function() {
        keyList.forEach(item => {
            const keyValue = this.findKeySwitchValue(item);
            if (keyValue === undefined) {
                return;
            }
            const prevValue = $gameSwitches.value(item.switchId);
            let newValue = item.reverse ? !keyValue : keyValue;
            if (item.toggle) {
                newValue = !prevValue;
            }
            if (prevValue !== newValue) {
                $gameSwitches.setValue(item.switchId, newValue);
            }
        });
    };

    SceneManager.findKeySwitchValue = function(item) {
        if (item.conditionSwitchId > 0 && !$gameSwitches.value(item.conditionSwitchId)) {
            return false;
        } else if (Input.isKeySwitchTriggered(item)) {
            return true;
        } else if (item.autoOff && !item.toggle) {
            return false;
        } else {
            return undefined;
        }
    };

    Input.isKeySwitchTriggered = function(item) {
        const method = item.trigger;
        return this[method] ? this[method](item.keyName) : this.isPressed(item.keyName);
    };
})();