Welcome to PGMV! My goal is to make it easy for everyone to find and share great plugins for creating amazing games. As a plugin developer myself, I'm excited to grow this community with all of you.
FTKR Menu Event - FTKR_MenuEvent.js
Plugin desc : v1.1.0 Allow common events to be performed on the menu screen
License : MIT License
Author : Futokoro
Desc page : https://github.com/munokura/futokoro-MV-plugins
Download Page : https://raw.githubusercontent.com/munokura/futokoro-MV-plugins/refs/heads/master/FTKR_MenuEvent.js
File name : FTKR_MenuEvent.js
Help of plugin :
@plugindesc v1.1.0 Allow common events to be performed on the menu screen
@author Futokoro
@url https://github.com/munokura/futokoro-MV-plugins
@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/futokoro-MV-plugins ).
Original plugin by Futokoro.
Please check the URL below for the latest version of the plugin.
URL https://github.com/futokoro/RPGMaker
-----
-----------------------------------------------------------------------------
Overview
-----------------------------------------------------------------------------
This plugin allows you to execute common events set by item or skill Traits on the menu screen.
However， not all Event's Contents can be executed.
-----------------------------------------------------------------------------
Setup Method
-----------------------------------------------------------------------------
1. Add this plugin to the "Plugin Manager."
2. When using this plugin in conjunction with FTKR_ItemSubCommand.js， place this plugin at the bottom.
3. When using this plugin in conjunction with a message window-related plugin， disable the plugin parameter "Enabled Message Window Setting."
-----------------------------------------------------------------------------
How to Set Up Common Events
-----------------------------------------------------------------------------
To execute common events on the menu， be sure to add the following plugin command to the end of the common event.
1. For items and skills that require actor selection
ME_ACTIVATE_ACTOR_WINDOW
Note that if the number of items held during a common event reaches zero，
you will automatically return to the item selection screen instead of the actor selection screen.
2. For items and skills that do not require actor selection
ME_ACTIVATE_ITEM_WINDOW
or
ME_ACTIVATE_SKILL_WINDOW
Also， if you increase or decrease the number of items held during a common event，
you must refresh the item window.
If you do not refresh， the number on the screen will not be updated.
You can set automatic refresh settings uniformly using plugin parameters， but you can also refresh using the following plugin commands.
ME_REFRESH_ITEM_WINDOW
-----------------------------------------------------------------------------
When using with the Subcommand Plugin (FTKR_ItemSubCommand.js)
-----------------------------------------------------------------------------
When using with the Subcommand Plugin， common events executed by subcommands can also be executed from the menu screen.
For subcommand events， add the following plugin command to the end of the event.
ME_ACTIVATE_SUB_WINDOW
However， if the number of items held for the selected item reaches 0 during a subcommand event，
you will automatically return to the item selection screen instead of the subcommand selection screen.
You can also use the following plugin command instead of the above.
ME_ACTIVATE_ITEM_WINDOW
In this case， the subcommand will close after the event ends and you will return to the item selection screen.
-----------------------------------------------------------------------------
Reference Information 1: Event's Contents that have been confirmed to work
-----------------------------------------------------------------------------
- Variable manipulation
- Wait
- Message display (text， choice options， numerical input， item selection， scrolling)
- Displaying/hiding pictures
-----------------------------------------------------------------------------
Reference Information 2: Message Window and Picture Display Priority
-----------------------------------------------------------------------------
The display priorities for message windows and pictures that can be displayed using Event's Contents are as follows. (Default settings)
Low priority------------------------------High priority
Menu screen < Message window < Picture
The higher priority window will be displayed in the foreground when overlapping.
You can change the display priority of message windows and pictures using the plugin parameter "Display priority."
----------------------------------------------------------------------------
Reference Information 3: Event's Contents that cannot be executed
-----------------------------------------------------------------------------
- Timer manipulation
- Animation display
- Movement and display operations targeting events and players
-----------------------------------------------------------------------------
!! ! Precautions when displaying message windows in the foreground!!
-----------------------------------------------------------------------------
Depending on the message window's transparency， the menu screen behind it may be visible through it.
(Normally， when windows overlap， the menu screen behind it is hidden.)
To prevent this， hide the menu screen by displaying a picture behind the window.
In this setting， you can change the following window settings using the "Menu Message Window" plugin parameter.
*Individual settings cannot be made for each window.
<Target windows>
Message window
Selection window
Numerical input window
Item selection window
Scroll window (only font size and line height are valid)
If there is a conflict with other message-related plugins， set the "Menu Message Window" parameter to "Text" and leave it blank.
-----------------------------------------------------------------------------
About this plugin's license (License)
-----------------------------------------------------------------------------
This plugin is released under the MIT License.
Copyright (c) 2017，2018 Futokoro
http://opensource.org/licenses/mit-license.php
Plugin Publisher
https://github.com/futokoro/RPGMaker/blob/master/README.md
-----------------------------------------------------------------------------
Change History
-----------------------------------------------------------------------------
v1.1.0 - 2018/10/05: Added Traits
1. Added the ability to disable message window settings.
v1.0.3 - 2018/02/20: Fixed Bugs
1. Fixed an issue where common events for items with a range of "none" would not execute correctly when the message window was displayed.
v1.0.2 - December 2， 2017: Specification changes， Traits additions
1. Fixed a bug that caused the game to return to the item selection screen if the currently selected item count reached zero during a common event.
2. Added a process to update the item list screen when returning to the selection screen.
3. Changed the ability to execute menu events to be set separately for when using an item and when executing a custom subcommand.
4. Added an automatic item window update function and plugin commands.
5. Removed the timer function while the menu is displayed.
v1.0.1 - November 28， 2017: Bug fixes， Traits additions.
1. Fixed a bug in plugin commands.
2. Fixed a bug that caused the Menu Message Window to be disabled when the field is left blank.
v1.0.0 - November 27， 2017: Initial version created
-----------------------------------------------------------------------------
@param Enable Item Event
@desc Sets the behavior of item events when the menu is displayed.
@default false
@type boolean
@on Run from the menu
@off Run in Maps
@param Enable Item SubCom Event
@desc Sets the behavior of common events executed by item subcommands while the menu is displayed.
@default false
@type boolean
@on Run from the menu
@off Run in Maps
@param Enable Skill Event
@desc Sets the behavior when the skill event menu is displayed.
@default false
@type boolean
@on Run from the menu
@off Run in Maps
@param Display Priority
@desc Sets whether the message window or the picture is displayed in front.
@default false
@type boolean
@on Message window
@off Picture
@param Auto Refresh Item Window
@desc Set whether to automatically refresh the item window when a common event is executed.
@default false
@type boolean
@on Automatic update ON
@off Automatic update OFF
@param Enabled Message Window Setting
@desc Enables the setting for the message window to be displayed on the menu screen.
@default false
@type boolean
@on valid
@off invalid
@param Menu Message Window
@desc Set the message window to be displayed on the menu screen. *Only valid when the message window is set to the front
@default {"Window_Skin":"Window"，"Font_Size":"28"，"Window_Padding":"18"，"Window_Line_Height":"36"，"Window_Opacity":"192"，"Hide_Window_Frame":"false"}
@type struct<menu>