フィールドマップで、キーボードの特定のボタンが押されたときに共通のイベントを呼び出するプラグイン – YEP_ButtonCommonEvents.js

タイトル
On the field map, call common events when certainbuttons are pressed on the keyboard.
作者名
様
ヘルプ
============================================================================
Introduction
============================================================================

This plugin enables you to bind common events to the individual buttons on
your keyboard. Instead of having the standard Z for OK and X for cancel,
you can make other keys work differently. With the exception of important
keys that shouldn't be altered, nearly full access is given across the span
of the keyboard.

============================================================================
Instructions
============================================================================

In the plugin's parameters, you will see a list of all the keys that you can
bind to a common event. If that number is something other than 0, then the
number associated with it will be the common event that will run. If you
assign it to a common event ID that does not exist, you will get an error so
please be wary of that.

You may also notice that some of the keys have in parenthesis a word like
(OK) or (Cancel) next to them. What this means is that those keys already
have a function assigned to them by the game. If you assign a common event
to these keys, the native function of the key will be removed in favor of
the common event you've assigned.

Here is a list of the keys that already have a common assigned:

Key - What they're assigned to
- Q - Assigned to PageUp
- W - Assigned to PageDown
- Shift - Assigned to Dash
- Z - Assigned to OK
- X - Assigned to Cancel
- Space - Assigned to OK
- Left - Assigned to moving left
- Up - Assigned to moving up
- Right - Assigned to moving right
- Down - Assigned to moving down
- Insert - Assigned to Cancel
- Page Up - Assigned to PageUp
- Page Down - Assigned to PageDown
- Numpad 0 - Assigned to Cancel
- Numpad 2 - Assigned to moving down
- Numpad 4 - Assigned to moving left
- Numpad 6 - Assigned to moving right
- Numpad 8 - Assigned to moving up

Once again, if you assign common events to these keys, the common event will
removing the binding the key had natively. However, this will only apply
while the player is in the field map. Being inside of a menu or battle
system will restore the previously native functions.

============================================================================
Compatibility Issues
============================================================================

This plugin will most likely have compatibility issues with anything that
alters keystrokes or makes use of them through a different manner.

This will include the KeyboardConfig.js that was provided for the RPG Maker
MV plugin pack made by Yanfly Engine Plugins. A revision of this plugin
KeyboardConfig.js is made on Yanfly.moe for you to pick up! Make sure you
have YEP_KeyboardConfig.js version 1.01 in order for this to be compatible
with it. This plugin must be placed above YEP_KeyboardConfig.js for the
two plugins to work together.

============================================================================
Plugin Commands
============================================================================

For those who would like for a way to toggle back and forth between the
bound common events and the default buttons, use these plugin commands.

Plugin Commands

RevertButton Ok
RevertButton Cancel
RevertButton Dash
RevertButton PageUp
RevertButton PageDown
RevertButton Left
RevertButton Up
RevertButton Right
RevertButton Down
RevertButton All
- Reverts all keys bound to any of the original functions back to their
original buttons and unbinds the common events bound to them. If the "All"
function is reverted, then all affected buttons will revert back to their
original functions.

SwitchButton Ok
SwitchButton Cancel
SwitchButton Dash
SwitchButton PageUp
SwitchButton PageDown
SwitchButton Left
SwitchButton Up
SwitchButton Right
SwitchButton Down
SwitchButton All
- Switches all keys with original functions to use the common event binds
instead of their original versions. If the "All" function is switched,
then all affected buttons will switch to common event bindings if there
are any.

TriggerButton Ok
TriggerButton Cancel
TriggerButton Dash
TriggerButton PageUp
TriggerButton PageDown
TriggerButton Left
TriggerButton Up
TriggerButton Right
TriggerButton Down
- This will cause the game to simulate triggering the button command of
one of those original functions even if there is a common event bound to
all of the keys of that original function.

============================================================================
Changelog
============================================================================

Version 1.01:
- Changed buttons from triggering to repeating so that common events can
continuously run while being held down.

Version 1.00:
- Finished Plugin!
パラメータ
param ---Top Row---
default
param Key ~
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key 1
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key 2
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key 3
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key 4
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key 5
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key 6
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key 7
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key 8
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key 9
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key 0
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key -
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key =
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param ---2nd Row---
default
param Key Q (PageUp)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key W (PageDown)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key E
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key R
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key T
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key Y
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key U
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key I
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key O
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key P
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key [
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key ]
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key \
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param ---3rd Row---
default
param Key A
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key S
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key D
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key F
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key G
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key H
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key J
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key K
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key L
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key ;
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key "
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key Enter (OK)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param ---4th Row---
default
param Key Shift (Dash)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key Z (OK)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key X (Cancel)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key C
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key V
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key B
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key N
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key M
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key ,
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key .
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key /
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param ---Misc---
default
param Key Space (OK)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key Left (Left)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key Up (Up)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key Right (Right)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key Down (Down)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key Insert (Cancel)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key Delete
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key Home
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key End
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key Page Up (PageUp)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key Page Down (PageDown)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param ---NumPad---
default
param Key NumPad 0 (Cancel)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key NumPad 1
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key NumPad 2 (Down)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key NumPad 3
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key NumPad 4 (Left)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key NumPad 5
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key NumPad 6 (Right)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key NumPad 7
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key NumPad 8 (Up)
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key NumPad 9
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key NumPad .
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key NumPad +
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key NumPad -
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key NumPad
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
param Key NumPad /
desc The common event to call when this button is pressed.
Set to 0 if you don't wish for a common event to call.
default 0
ライセンス表記

紹介ページ https://github.com/suppayami/yami-engine-delta/blob/master/demo/js/plugins/YEP_ButtonCommonEvents.js

プラグインカテゴリ
ウィンドウ・メニュー、イベント、マップ、戦闘
プラグインタイプ
ユーザープラグイン
作者
Yanfly Engine Plugins
対応バージョン
MV