Difference between revisions of "Button Common Events (YEP)"
Jump to navigation
Jump to search
(Created page with "{{MvPlugin |preview = <youtube>https://www.youtube.com/watch?v=j8CvKiBjgiU</youtube> |link1 = <html><iframe src="https://itch.io/embed/399611" height="167" width="552" framebo...") |
|||
Line 1: | Line 1: | ||
{{MvPlugin | {{MvPlugin | ||
− | |preview = <youtube>https://www.youtube.com/watch?v=j8CvKiBjgiU</youtube> | + | |preview = <youtube>https://www.youtube.com/watch?v=j8CvKiBjgiU</youtube> |
− | |link1 = <html><iframe src="https://itch.io/embed/399611" height="167" width="552" frameborder="0"></iframe></html> | + | |link1 = <html><iframe src="https://itch.io/embed/399611" height="167" width="552" frameborder="0"></iframe></html> |
− | |link2 = [http://yanfly.moe/plugins/en/YEP_ButtonCommonEvents.js Mirror] | + | |link2 = [http://yanfly.moe/plugins/en/YEP_ButtonCommonEvents.js Mirror] |
}} | }} | ||
Line 9: | Line 9: | ||
{{Yanfly Engine Plugins}} | {{Yanfly Engine Plugins}} | ||
− | == | + | == Introduction == |
<nowiki> | <nowiki> | ||
− | |||
− | |||
− | |||
− | |||
This plugin enables you to bind common events to the individual buttons on | 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, | your keyboard. Instead of having the standard Z for OK and X for cancel, | ||
Line 21: | Line 17: | ||
keys that shouldn't be altered, nearly full access is given across the span | keys that shouldn't be altered, nearly full access is given across the span | ||
of the keyboard. | of the keyboard. | ||
+ | </nowiki> | ||
− | == | + | == Instructions == |
− | Instructions | ||
− | |||
+ | <nowiki> | ||
In the plugin's parameters, you will see a list of all the keys that you can | 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 | bind to a common event. If that number is something other than 0, then the | ||
Line 64: | Line 60: | ||
while the player is in the field map. Being inside of a menu or battle | while the player is in the field map. Being inside of a menu or battle | ||
system will restore the previously native functions. | system will restore the previously native functions. | ||
+ | </nowiki> | ||
− | == | + | == Compatibility Issues == |
− | Compatibility Issues | ||
− | |||
+ | <nowiki> | ||
This plugin will most likely have compatibility issues with anything that | This plugin will most likely have compatibility issues with anything that | ||
alters keystrokes or makes use of them through a different manner. | alters keystrokes or makes use of them through a different manner. | ||
Line 78: | Line 74: | ||
with it. This plugin must be placed above YEP_KeyboardConfig.js for the | with it. This plugin must be placed above YEP_KeyboardConfig.js for the | ||
two plugins to work together. | two plugins to work together. | ||
+ | </nowiki> | ||
− | == | + | == Plugin Commands == |
− | Plugin Commands | ||
− | |||
+ | <nowiki> | ||
For those who would like for a way to toggle back and forth between the | 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. | bound common events and the default buttons, use these plugin commands. | ||
Line 130: | Line 126: | ||
one of those original functions even if there is a common event bound to | one of those original functions even if there is a common event bound to | ||
all of the keys of that original function. | all of the keys of that original function. | ||
+ | </nowiki> | ||
− | == | + | == Changelog == |
− | Changelog | ||
− | |||
+ | <nowiki> | ||
Version 1.02: | Version 1.02: | ||
- Updated for RPG Maker MV version 1.5.0. | - Updated for RPG Maker MV version 1.5.0. |
Revision as of 02:06, 22 June 2019
Welcome to the wiki! This is where you can find resources from Yanfly.moe, Ækashics.moe,
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.
Download
System
This is a plugin created for RPG Maker MV.
For help on how to install plugins, click here.
For help on how to update plugins, click here.
Got errors with your RPG Maker MV plugin? Click here.
Yanfly Engine Plugins
This plugin is a part of the Yanfly Engine Plugins library.
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.02: - Updated for RPG Maker MV version 1.5.0. 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!